Package org.nuiton.eugene.models.object

Interface ObjectModelElement

All Superinterfaces:

WithTagValuesOrStereotypes

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
extends WithTagValuesOrStereotypes

ObjectModelElement.

Author:

Cédric Pineau - pineau@codelutin.com

Method Summary

Modifier and Type	Method	Description
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.
boolean	isStatic()	Return if this element has static declaration, only valid when getDeclaringElement is classifier.

Methods inherited from interface org.nuiton.eugene.models.extension.tagvalue.WithTagValuesOrStereotypes

addStereotype, addTagValue, getStereotypes, getTagValue, getTagValues, hasStereotype, hasTagValue, removeStereotype, removeTagValue

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.

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.