|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Entity
Represents the entities of the Design.
Nested Class Summary | |
---|---|
static class |
Entity.TypesOfEntities
This enum represents the entities of the design. |
Method Summary | |
---|---|
void |
addModifier(Modifier modifier)
This method is used to add a Modifier on this Entity . |
void |
addModifiers(java.util.Collection<Modifier> modifiers)
This method is used to add a Collection of Modifier on this Entity . |
void |
addRelation(Relation relation)
Adds a relation for this entity. |
boolean |
containsModifiers(Modifier... modifiers)
Verifies whether this Entity has the specified modifiers. |
boolean |
containsRelation(Relation relation)
Method that verifies if the Entity has the specified relation. |
java.util.Set<ClassNode> |
getCalleeClasses()
Returns the classes that are referenced by this Entity. |
java.util.Set<MethodNode> |
getCalleeMethods()
Returns a Set of MethodNode containing the methods that
are called by this Entity . |
java.util.Set<PackageNode> |
getCalleePackages()
Returns a Set of PackageNode containing the packages that are referenced
by this Entity . |
java.util.Set<ClassNode> |
getCallerClasses()
Returns the classes that reference this Entity. |
java.util.Set<MethodNode> |
getCallerMethods()
Returns a Set of MethodNode containing the methods that call this Entity . |
java.util.Set<PackageNode> |
getCallerPackages()
Returns a Set of PackageNode containing the packages that reference this Entity . |
java.lang.String |
getClassName()
Returns the name of the class that represents this Entity object. |
ClassNode |
getClassNode()
Returns the ClassNode that represents this Entity object. |
java.util.List<java.lang.String[]> |
getImpactOfAChange()
Returns a List of String arrays that represents the trace of calls. |
java.util.Collection<Modifier> |
getModifiers()
Returns a Collection of Modifier s representing the modifiers of
this Entity . |
java.lang.String |
getName()
Method that returns the description of this design element. |
PackageNode |
getPackage()
Returns the package which this Entity belongs to. |
java.util.Collection<Relation> |
getRelations(Relation.TypesOfRelation type)
Method that returns all the relations with the specified type. |
java.lang.String |
getShortName()
Returns the short name of this Entity . |
Entity.TypesOfEntities |
getTypeOfEntity()
Method that returns the type of this element of design. |
Modifier |
getVisibility()
Returns the visibility of this Entity . |
boolean |
isAbstract()
Verifies if this Entity is abstract. |
boolean |
removeRelation(Relation relation)
Method that removes a Relation from this Entity . |
Method Detail |
---|
java.lang.String getName()
ClassNode getClassNode()
ClassNode
that represents this Entity
object.
For instance, if this Entity
object is a FieldNode
, this method will return the
ClassNode
that contains the field. The same is applied to MethodNode
s objects.
ClassNode
object that represents this Entity
object.java.lang.String getShortName()
Entity
.
The short name of an attribute is just its name.
For example, if the short name of attribute out from class System
is out but not java.lang.System.out.
The short name of a method is just its name and signature.
For example, the short name of clone method from Object class is clone() but not java.lang.Object.clone().
The short name of a class is just its name. Not the fully qualified name.
For example, the short name of Object class is Object but not java.lang.Object.
Entity
.PackageNode getPackage()
Entity
belongs to. If this Entity
belongs to
the default package, a package with the name "default" is returned.
Entity
belongs to.void addRelation(Relation relation)
relation
- the relation to be added.boolean containsRelation(Relation relation)
relation
- the relation to be verified.
java.util.Collection<Relation> getRelations(Relation.TypesOfRelation type)
type
- the type of the relation.
Relation
of
the specified type, an empty Setboolean removeRelation(Relation relation)
Relation
from this Entity
.
relation
- the relation to be removed from this Entity
.Entity.TypesOfEntities getTypeOfEntity()
java.util.Set<MethodNode> getCallerMethods()
Set
of MethodNode
containing the methods that call this Entity
.
Set
containing the methods that calls this Entity
.java.util.Set<MethodNode> getCalleeMethods()
Set
of MethodNode
containing the methods that
are called by this Entity
.
Set
containing the methods that are called by this Entity
.java.util.Set<ClassNode> getCallerClasses()
java.util.Set<ClassNode> getCalleeClasses()
java.util.Set<PackageNode> getCallerPackages()
Set
of PackageNode
containing the packages that reference this Entity
.
Set
containing the packages that reference this Entity
.java.util.Set<PackageNode> getCalleePackages()
Set
of PackageNode
containing the packages that are referenced
by this Entity
.
Set
containing the packages that are referenced
by this Entity
.java.util.Collection<Modifier> getModifiers()
Collection
of Modifier
s representing the modifiers of
this Entity
.
Collection
of Modifier
s representing the modifiers of
this Entity
.Modifier getVisibility()
Entity
.
void addModifier(Modifier modifier)
Modifier
on this Entity
.
modifier
- void addModifiers(java.util.Collection<Modifier> modifiers)
Collection
of Modifier
on this Entity
.
modifier
- boolean containsModifiers(Modifier... modifiers)
Entity
has the specified modifiers.
modifiers
-
Entity
has the specified modifiers or false otherwise.java.util.List<java.lang.String[]> getImpactOfAChange()
List
of String
arrays that represents the trace of calls.
The deep of the search is configured on designwizard.properties
boolean isAbstract()
Entity
is abstract.
Entity
is abstract; false otherwise.java.lang.String getClassName()
Entity
object.
For instance, if this Entity
object is a FieldNode
, this method will return the
name of the class that contains the field. The same is applied to MethodNode
s objects. In the case of
ClassNode
objects, calling this method has the same effect as the designwizard.design.ClassNode.getName()
method.
Entity
object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |