|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IStereotype
Top-level interface for user-defined stereotypes. Users can define stereotypes within a Workbench Profile (@see org.eclipse.tigerstripe.api.profile.IWorkbenchProfile) that will be offered for selection when modeling a service contract. Each Stereotype has the following properties
Method Summary | |
---|---|
void |
addAttribute(IStereotypeAttribute attribute)
|
void |
addToExcludesList(java.lang.String excludesStereotypeName)
|
void |
addToRequiresList(java.lang.String requiredStereotypeName)
|
org.dom4j.Element |
asElement()
Returns an XML representation of this stereotype |
IStereotypeAttribute |
getAttributeByName(java.lang.String nameToGet)
|
IStereotypeAttribute[] |
getAttributes()
|
java.lang.String |
getDescription()
Returns a short description of the meaning of the stereotype. |
java.lang.String[] |
getExcludesList()
Get a array of the names of stereotypes that make up the excluded list. |
IStereotypeAttribute |
getIAttributeByName(java.lang.String nameToGet)
Returns a specific attribute identified by the name that is passed. |
IStereotypeAttribute[] |
getIAttributes()
Return an array of the defined attributes for this stereotype. |
java.lang.String |
getName()
Returns the name (as seen by the end-user) of the stereotype. |
java.lang.String |
getParentStereotype()
Returns the name of the parent of this stereotype (if any). |
IWorkbenchProfile |
getProfile()
Returns the profile this stereotype belongs to. |
java.lang.String[] |
getRequiresList()
Get a array of the names of stereotypes that make up the required list. |
IStereotypeScopeDetails |
getStereotypeScopeDetails()
Get the applicability scopes for this stereotype. |
java.lang.String |
getVersion()
Returns the version of the stereotype, for maintenance purposes. |
boolean |
isValidAttribute(IStereotypeAttribute attribute)
Returns true if the given attribute is a defined attribute for this stereotype |
boolean |
isVisible()
Returns the visibility of this stereotype. |
IStereotypeInstance |
makeInstance()
Makes an instance of this stereotype and initializes all the attributes to their default values. |
void |
parse(org.dom4j.Element element)
Parses the details of this from the given XML element |
void |
removeAttribute(IStereotypeAttribute attribute)
|
void |
removeAttributes(IStereotypeAttribute[] attribute)
|
void |
removeFromExcludesList(java.lang.String excludesStereotypeName)
|
void |
removeFromExcludesList(java.lang.String[] excludesStereotypeName)
|
void |
removeFromRequiresList(java.lang.String requiredStereotypeName)
|
void |
removeFromRequiresList(java.lang.String[] requiredStereotypeName)
|
void |
setAttributes(IStereotypeAttribute[] attributes)
|
void |
setDescription(java.lang.String description)
|
void |
setExcludesList(java.lang.String[] excludesStereotypeNames)
|
void |
setName(java.lang.String name)
|
void |
setParentStereotype(java.lang.String parentStereotype)
|
void |
setRequiresList(java.lang.String[] requiredStereotypeNames)
|
void |
setVersion(java.lang.String version)
|
void |
setVisible(boolean isVisible)
Sets the visibility of this stereotype |
Method Detail |
---|
void setName(java.lang.String name)
void setVersion(java.lang.String version)
void setDescription(java.lang.String description)
void setVisible(boolean isVisible)
isVisible
- void setAttributes(IStereotypeAttribute[] attributes) throws TigerstripeException
TigerstripeException
void addAttribute(IStereotypeAttribute attribute) throws TigerstripeException
attribute
-
TigerstripeException
- if an attribute with the same name already exists.void removeAttribute(IStereotypeAttribute attribute) throws TigerstripeException
attribute
-
TigerstripeException
- if no attribute with that name exists.void removeAttributes(IStereotypeAttribute[] attribute) throws TigerstripeException
TigerstripeException
void setRequiresList(java.lang.String[] requiredStereotypeNames) throws TigerstripeException
TigerstripeException
void addToRequiresList(java.lang.String requiredStereotypeName) throws TigerstripeException
TigerstripeException
void removeFromRequiresList(java.lang.String requiredStereotypeName) throws TigerstripeException
TigerstripeException
void removeFromRequiresList(java.lang.String[] requiredStereotypeName) throws TigerstripeException
TigerstripeException
void setExcludesList(java.lang.String[] excludesStereotypeNames) throws TigerstripeException
TigerstripeException
void addToExcludesList(java.lang.String excludesStereotypeName) throws TigerstripeException
TigerstripeException
void removeFromExcludesList(java.lang.String excludesStereotypeName) throws TigerstripeException
TigerstripeException
void removeFromExcludesList(java.lang.String[] excludesStereotypeName) throws TigerstripeException
TigerstripeException
org.dom4j.Element asElement()
void parse(org.dom4j.Element element) throws TigerstripeException
element
-
TigerstripeException
void setParentStereotype(java.lang.String parentStereotype)
IStereotypeInstance makeInstance()
IStereotypeAttribute[] getAttributes()
IStereotypeAttribute getAttributeByName(java.lang.String nameToGet)
IWorkbenchProfile getProfile()
java.lang.String getDescription()
java.lang.String[] getExcludesList()
IStereotypeAttribute getIAttributeByName(java.lang.String nameToGet)
nameToGet
-
IStereotypeAttribute[] getIAttributes()
java.lang.String getName()
java.lang.String getParentStereotype()
java.lang.String[] getRequiresList()
IStereotypeScopeDetails getStereotypeScopeDetails()
java.lang.String getVersion()
boolean isValidAttribute(IStereotypeAttribute attribute)
attribute
-
boolean isVisible()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |