org.nuiton.eugene.models.object
Interface ObjectModelElement

All Known Subinterfaces:

ObjectModelAssociationClass, ObjectModelAttribute, ObjectModelClass, ObjectModelClassifier, ObjectModelEnumeration, ObjectModelInterface, ObjectModelOperation, ObjectModelParameter

All Known Implementing Classes:

ObjectModelAssociationClassImpl, ObjectModelAttributeImpl, ObjectModelClassifierImpl, ObjectModelClassImpl, ObjectModelElementImpl, ObjectModelEnumerationImpl, ObjectModelInterfaceImpl, ObjectModelOperationImpl, ObjectModelParameterImpl

public interface ObjectModelElement

ObjectModelElement.

Version:

$Revision: 1014 $ Last update : $Date: 2010-11-28 21:13:58 +0100 (Sun, 28 Nov 2010) $ by :

Author:

Cédric Pineau Copyright Code Lutin

Method Summary

List<String>	getComments() Returns all comments lied to this particular model element
ObjectModelElement	getDeclaringElement() Returns the element in which this element is defined, or null if there's none.
String	getDescription() The description of this element is the upper part of the element's documentation.
String	getDocumentation() Returns the whole documentation associated with this element (description + source documentation).
String	getName() Returns the name of this element.
String	getSourceDocumentation() Returns the source documentation part associated with this element.
Collection<String>	getStereotypes() Returns the stereotypes names associated with this element.
String	getTagValue(String tagValue) Returns the tagValue corresponding to the given name, or null if the element has no associated tagValue for this name.
Map<String,String>	getTagValues() Returns the tagValues associated with this element.
boolean	hasStereotype(String stereotypeName) Returns whether this element has a stereotype corresponding to the given name, or not.
boolean	hasTagValue(String tagValue) Returns whether this element has a tagValue corresponding to the given name, or not.
boolean	isStatic() Return if this element has static declaration, only valid when getDeclaringElement is classifier.

Method Detail

getName

String getName()

Returns the name of this element.

Returns:

the name of this element.

getDeclaringElement

ObjectModelElement getDeclaringElement()

Returns the element in which this element is defined, or null if there's none.

Returns:

the ObjectModelElement in which this element is defined, or null if there's none.

getDocumentation

String getDocumentation()

Returns the whole documentation associated with this element (description + source documentation).

Returns:

the whole documentation associated with this element.

getDescription

String getDescription()

The description of this element is the upper part of the element's documentation. The other part of the document can be accessed with getSourceDocumentation()

Returns:

the description associated with this element.

getSourceDocumentation

String getSourceDocumentation()

Returns the source documentation part associated with this element. Source documentation is at end of documentation and are separated of over documentation by "--"

Returns:

the source documentation part associated with this element.

getStereotypes

Collection<String> getStereotypes()

Returns the stereotypes names associated with this element.

Returns:

a Collection containing all stereotypes names associated with this element as String.

hasStereotype

boolean hasStereotype(String stereotypeName)

Returns whether this element has a stereotype corresponding to the given name, or not.

Parameters:

stereotypeName - stereotype name

Returns:

a boolean indicating whether this element has a stereotype corresponding to the given name, or not.

getTagValues

Map<String,String> getTagValues()

Returns the tagValues associated with this element. For each entry, the key is the name of the tagValue, the value is the value of the tagValue :-)

Returns:

a Map containing all tagValues associated with this element

getTagValue

String getTagValue(String tagValue)

Returns the tagValue corresponding to the given name, or null if the element has no associated tagValue for this name.

Parameters:

tagValue - tag value name

Returns:

the value of the found tagValue, or null if the element has no associated tagValue for this name.

hasTagValue

boolean hasTagValue(String tagValue)

Returns whether this element has a tagValue corresponding to the given name, or not.

Parameters:

tagValue - tag value name

Returns:

a boolean indicating whether this element has a tagValue corresponding to the given name, or not.

isStatic

boolean isStatic()

Return if this element has static declaration, only valid when getDeclaringElement is classifier. Not possible for the moment to have static innerClass (from XMI 1.2 and 2.1).

Returns:

true if element is static

getComments

List<String> getComments()

Returns all comments lied to this particular model element

Returns:

a List containing all comments for this element as Strings.