Package org.nuiton.eugene.models.object

Interface ObjectModelClassifier

All Superinterfaces:

ObjectModelElement, WithTagValuesOrStereotypes

All Known Subinterfaces:

ObjectModelAssociationClass, ObjectModelClass, ObjectModelEnumeration, ObjectModelInterface

All Known Implementing Classes:

ObjectModelAssociationClassImpl, ObjectModelClassifierImpl, ObjectModelClassImpl, ObjectModelEnumerationImpl, ObjectModelInterfaceImpl

public interface ObjectModelClassifier
extends ObjectModelElement

ObjectModelClassifier.

Author:

Cédric Pineau - pineau@codelutin.com

Method Summary

Modifier and Type	Method	Description
Collection<ObjectModelAttribute>	getAllInterfaceAttributes()	Returns all attributes defined on all interfaces implemented by this classifier, directly or indirectly.
Collection<ObjectModelOperation>	getAllInterfaceOperations(boolean distinct)	Returns all operations defined on all interfaces implemented by this classifier, directly or indirectly.
Collection<ObjectModelAttribute>	getAllOtherAttributes()	Returns all attributes defined on all super class extended by this classifier, directly or indirectly.
Collection<ObjectModelOperation>	getAllOtherOperations(boolean distinct)	Returns all operations defined on all implemented by this classifier, directly or indirectly.
ObjectModelAttribute	getAttribute(String attributeName)	Returns the attribute corresponding to the given name, or null if the class contains no attribute for this name.
Collection<ObjectModelAttribute>	getAttributes()	Returns all attributes defined on this class.
Collection<ObjectModelDependency>	getDependencies()	Returns all dependencies of this client classifier
ObjectModelDependency	getDependency(String name)	Return a dependency identifier by her name
Collection<ObjectModelInterface>	getInterfaces()	Returns all parent interfaces for this classifier.
Collection<ObjectModelOperation>	getOperations()	Returns all operations defined on this classifier.
Collection<ObjectModelOperation>	getOperations(String name)	Returns all operations defined on this classifier.
String	getPackageName()	Returns the package name of this classifier.
String	getQualifiedName()	Returns the qualified name of this classifier.
boolean	isClass()	Returns whether this classifier is a class or not
boolean	isEnum()	Returns whether this classifier is an enumeration or not
boolean	isInner()	Returns whether this class is inner an other class or not.
boolean	isInterface()	Returns whether this classifier is an interface or not

Methods inherited from interface org.nuiton.eugene.models.object.ObjectModelElement

getComments, getDeclaringElement, getDescription, getDocumentation, getName, getSourceDocumentation, isStatic

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

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

Method Detail

getPackageName

String getPackageName()

Returns the package name of this classifier.

Returns:

the package name of this classifier.

getQualifiedName

String getQualifiedName()

Returns the qualified name of this classifier. Class qualified name is composed of the package name and the classifier name.

Returns:

the qualified name of this classifier.

getInterfaces

Collection<ObjectModelInterface> getInterfaces()

Returns all parent interfaces for this classifier.

Returns:

a Collection containing all parent ObjectModelInterface for this classifier.

getOperations

Collection<ObjectModelOperation> getOperations(String name)

Returns all operations defined on this classifier.

Parameters:

name - name of operation should be returned

Returns:

a Collection containing all ObjectModelOperation for this classifier.

See Also:

ObjectModelOperation

getOperations

Collection<ObjectModelOperation> getOperations()

Returns all operations defined on this classifier.

Returns:

a Collection containing all ObjectModelOperation for this classifier.

See Also:

ObjectModelOperation

getAllInterfaceOperations

Collection<ObjectModelOperation> getAllInterfaceOperations(boolean distinct)

Returns all operations defined on all interfaces implemented by this classifier, directly or indirectly.

Parameters:

distinct - if this boolean is true only distinct operation are add to list.

Returns:

a Collection of ObjectModelOperation

getAllOtherOperations

Collection<ObjectModelOperation> getAllOtherOperations(boolean distinct)

Returns all operations defined on all implemented by this classifier, directly or indirectly. For interface this methode return the same result as getAllInterfaceOperations, for Class this method add all operation of SuperClass.

Parameters:

distinct - if this boolean is true only distinct operation are add to list.

Returns:

a Collection of ObjectModelOperation

getAttributes

Collection<ObjectModelAttribute> getAttributes()

Returns all attributes defined on this class.

Returns:

a Collection containing all ObjectModelAttribute for this class.

See Also:

ObjectModelAttribute

getAttribute

ObjectModelAttribute getAttribute(String attributeName)

Returns the attribute corresponding to the given name, or null if the class contains no attribute for this name.

Parameters:

attributeName - attribute name

Returns:

the ObjectModelAttribute of the found attribute, or null if the class contains no attribute for this name.

getAllInterfaceAttributes

Collection<ObjectModelAttribute> getAllInterfaceAttributes()

Returns all attributes defined on all interfaces implemented by this classifier, directly or indirectly.

Returns:

a Collection of ObjectModelAttribute

getAllOtherAttributes

Collection<ObjectModelAttribute> getAllOtherAttributes()

Returns all attributes defined on all super class extended by this classifier, directly or indirectly.

Returns:

a Collection of ObjectModelAttribute

getDependencies

Collection<ObjectModelDependency> getDependencies()

Returns all dependencies of this client classifier

Returns:

a Collection of ObjectModelDependency

getDependency

ObjectModelDependency getDependency(String name)

Return a dependency identifier by her name

Parameters:

name - of the dependency

Returns:

the dependency

isClass

boolean isClass()

Returns whether this classifier is a class or not

Returns:

a boolean indicating whether this classifier is a class or not.

See Also:

ObjectModelClass

isInterface

boolean isInterface()

Returns whether this classifier is an interface or not

Returns:

a boolean indicating whether this classifier is an interface or not.

See Also:

ObjectModelInterface

isEnum

boolean isEnum()

Returns whether this classifier is an enumeration or not

Returns:

a boolean indicating whether this classifier is an enumeration or not.

See Also:

ObjectModelEnumeration

isInner

boolean isInner()

Returns whether this class is inner an other class or not.

Returns:

a boolean indicating whether this class is inner an other class or not.