de.uni_paderborn.fujaba.metamodel
Interface FClass

All Superinterfaces:
java.lang.Cloneable, java.lang.Comparable, FDeclaration, FDiagramItem, FElement, FIncrement, FType, de.uni_kassel.prop.InspectionAware, LogicUnparseInterface, de.tu_bs.coobra.ObjectChangeAware, de.upb.tools.pcs.PropertyChangeClient, de.upb.tools.pcs.PropertyChangeInterface, UniqueIdentifier
All Known Implementing Classes:
UMLClass

public interface FClass
extends FDeclaration, FType

Represents a class (e.g. UML class).

Version:
$Revision: 1.4.2.1 $ $Date: 2006/01/23 15:56:42 $
Author:
$Author: cschneid $

Field Summary
static java.lang.String ABSTRACT_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String ATTRS_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String DECLARED_IN_CLASS_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String DECLARED_IN_METHOD_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String DECLARED_IN_PACKAGE_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String DECLARES_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String FILE_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String FULL_CLASS_NAME_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String METHODS_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String REV_IMPORTED_CLASSES_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String REV_ROLES_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String REV_SUBCLASS_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String REV_SUPERCLASS_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
static java.lang.String ROLES_PROPERTY
          Property name used for change events, unparsing and persistency - do not change.
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FDeclaration
CODE_DISPLAY_LEVEL, DESIGN_DISPLAY_LEVEL, PACKAGE, PRIVATE, PROTECTED, PUBLIC, USERDEFINED, VISIBILITY_CHAR, VISIBILITY_PROPERTY, VISIBILITY_STRING
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FDiagramItem
REV_ADDITIONAL_ITEMS_PROPERTY, REV_ITEMS_PROPERTY, VIEW_DEFINITIONS_PROPERTY
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FIncrement
ASSERT_IN_UNIT_TEST_PROPERTY, COMMENT_PROPERTY, CONSTRAINTS_PROPERTY, STEREOTYPES_PROPERTY
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FElement
ANNOTATIONS_PROPERTY, DIAGRAMS_PROPERTY, ELEMENT_REFERENCES_PROPERTY, GENERATED_PROPERTY, NAME_PROPERTY, TEXT_PROPERTY
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FType
NAME_PROPERTY
 
Method Summary
 boolean addToAttrs(FAttr attr)
           
 boolean addToDeclares(FClass cls)
           
 boolean addToMethods(FMethod method)
           
 boolean addToParsedMembers(FDeclaration value)
          Access method for a To N-association.
 void addToRevImportedClasses(FFile file)
           
 void addToRevSubclass(FGeneralization elem)
           
 void addToRevSuperclass(FGeneralization elem)
           
 void addToRoles(FRole role)
           
 java.util.Enumeration elementsOfRevImportedClasses()
           
 java.util.Enumeration elementsOfRevSubclass()
           
 java.util.Enumeration elementsOfRevSuperclass()
           
 java.util.Enumeration elementsOfRoles()
           
 de.upb.tools.sdm.Path elementsOfSuperClasses()
          Deprecated. please use iteratorOfSuperClasses()
 java.util.Iterator entriesOfAttrs()
           
 java.util.Iterator entriesOfDeclares()
           
 FPackage findFPackage()
          Deprecated. will be renamed when using JDK 1.5 (without F)
 FClass getFDeclaredInClass()
          The declaredInClass property denotes the class this inner class is declared in, null if this is a top level or anonymous class.
 FMethod getFDeclaredInMethod()
          The declaredInMethod property denotes the method this class is declared in if it is an anonymous class, null if this is a top level or inner class.
 FPackage getFDeclaredInPackage()
          The declaredInPackage property denotes the package this class is declared in, null if this is an inner or anonymous class.
 FFile getFFile()
          Get the file this class is defined in.
 FDiagram getFReactiveDiagram()
          Deprecated. will be renamed when using JDK 1.5 (without F) or removed?
 FAttr getFromAllFAttrs(java.lang.String attributeName)
          Deprecated. will be renamed when using JDK 1.5 (without F)
 FMethod getFromAllFMethods(java.lang.String methodSignature)
          Deprecated. will be renamed when using JDK 1.5 (without F)
 FAttr getFromFAttrs(java.lang.String attrName)
           
 FClass getFromFDeclares(java.lang.String classname)
           
 FMethod getFromFMethods(java.lang.String signature)
           
 FMethod getFromFMethodsByShortName(java.lang.String methodname)
          Deprecated. will be renamed when using JDK 1.5 (without F)
 FMethod getFromFMethodsByShortNameIncludingInherited(java.lang.String methodname)
          Deprecated. will be renamed when using JDK 1.5 (without F)
 FRole getFromFRevRoles(java.lang.String roleName)
          Find a partner role of any role this class has: E.g.
 FRole getFromFRoles(java.lang.String roleName)
           
 FDiagram getFStatechart()
          Deprecated. will be renamed when using JDK 1.5 (without F)
 FClass getFSuperClass()
          Deprecated. will be renamed when using JDK 1.5 (without F)
 java.lang.String getFullClassName()
          This function computes the full qualified classname of this class e. g. if the class FooBar is defined in the package upb and upb is in de then this function will return "de.upb.FooBar".
 boolean hasInAttrs(FAttr attr)
           
 boolean hasInDeclares(FClass cls)
           
 boolean hasInMethods(FMethod method)
           
 boolean hasInParsedMembers(FDeclaration value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInRevImportedClasses(FFile file)
           
 boolean hasInRevSubclass(FGeneralization generalization)
           
 boolean hasInRevSuperclass(FGeneralization elem)
           
 boolean hasInRoles(FRole role)
           
 boolean hasKeyInAttrs(java.lang.String key)
           
 boolean hasKeyInDeclares(java.lang.String classname)
           
 boolean hasKeyInMethods(java.lang.String signature)
           
 boolean isAbstract()
          Read the 'abstract' flag of the class.
 boolean isFinal()
          Deprecated. Use <> stereotype instead
 boolean isReference()
          Deprecated. Use <> stereotype instead
 boolean isStatic()
          Deprecated. Use <> stereotype instead
 java.util.Iterator iteratorOfAttrs()
          The attrs property of FClass contains all attributes (FAttrs) that are declared in this class.
 java.util.Iterator iteratorOfDeclares()
          The declares property holds all inner classes of this class.
 java.util.Iterator iteratorOfMethods()
          The methods property contains all methods this class declares.
 java.util.Iterator iteratorOfParsedMembers()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfRevImportedClasses()
          The revImportedClasses property is the conterpart of FFile.importedClasses.
 java.util.Iterator iteratorOfRevSubclass()
          The revSubclass property contains alls generalizations where this class is the subclass.
 java.util.Iterator iteratorOfRevSuperclass()
          The revSuperclass property contains all generalization where this class is the superclass.
 java.util.Iterator iteratorOfRoles()
          The roles property lists all roles this class has in associations.
 de.upb.tools.sdm.Path iteratorOfSuperClasses()
           
 java.util.Iterator keysOfAttrs()
           
 java.util.Iterator keysOfDeclares()
           
 void removeAllFromAttrs()
          Remove all declared attributes from this class.
 void removeAllFromDeclares()
          Remove all inner classes (delete link, classes remain intact).
 void removeAllFromMethods()
          Remove all methods declared in this class.
 void removeAllFromParsedMembers()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromRevSubclass()
          Remove all generalizations where this class is the subclass.
 void removeAllFromRevSuperclass()
          Remove all generalizations where this class is the superclass.
 boolean removeFromAttrs(FAttr attr)
           
 boolean removeFromDeclares(FClass cls)
           
 boolean removeFromMethods(FMethod method)
           
 boolean removeFromParsedMembers(FDeclaration value)
          No comment provided by developer, please add a comment to improve documentation.
 void removeFromRevImportedClasses(FFile file)
           
 void removeFromRevSubclass(FGeneralization elem)
           
 void removeFromRevSuperclass(FGeneralization elem)
           
 void removeFromRoles(FRole elem)
           
 boolean removeKeyFromAttrs(java.lang.String attrName)
           
 boolean removeKeyFromDeclares(java.lang.String classname)
           
 boolean removeKeyFromMethods(java.lang.String signature)
           
 boolean setAbstract(boolean value)
          Change the 'abstract' flag of a class.
 boolean setDeclaredInClass(FClass cls)
           
 boolean setDeclaredInMethod(FMethod method)
           
 boolean setDeclaredInPackage(FPackage pkg)
           
 boolean setFile(FFile file)
          Sets the file this class is defined in.
 void setStatic(boolean value)
          Deprecated. Use <> stereotype instead
 int sizeOfAttrs()
           
 int sizeOfDeclares()
           
 int sizeOfMethods()
           
 int sizeOfParsedMembers()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfRevSubclass()
           
 int sizeOfRoles()
           
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FDeclaration
getDisplayLevel, getFType, getVisibility, isParsed, setDisplayLevel, setVisibility
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FDiagramItem
addToRevAdditionalItems, addToRevItems, addToViewDefinitions, getFCurrentActiveDiagram, getFFirstFromDiagrams, hasInRevAdditionalItems, hasInRevItems, hasInViewDefinitions, iteratorOfRevAdditionalItems, iteratorOfRevItems, iteratorOfViewDefinitions, removeAllFromRevAdditionalItems, removeAllFromRevItems, removeAllFromViewDefinitions, removeFromRevAdditionalItems, removeFromRevItems, removeFromViewDefinitions, sizeOfRevAdditionalItems, sizeOfRevItems, sizeOfViewDefinitions
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FIncrement
addToConstraints, addToStereotypes, entriesOfStereotypes, getFComment, getFromFStereotypes, hasInConstraints, hasInStereotypes, hasKeyInStereotypes, isAssertInUnitTest, iteratorOfConstraints, iteratorOfStereotypes, keysOfStereotypes, removeAllFromConstraints, removeAllFromStereotypes, removeFromConstraints, removeFromStereotypes, removeKeyFromStereotypes, setAssertInUnitTest, setComment, sizeOfStereotypes
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FElement
addToAnnotations, addToDiagrams, addToElementReferences, addToElementReferences, addToUserMessages, deleteTokens, entriesOfElementReferences, getFirstOOGenToken, getFromFElementReferences, getLastOOGenToken, getName, getParentElement, getText, hasInAnnotations, hasInDiagrams, hasInElementReferences, hasInElementReferences, hasKeyInElementReferences, isCoobraPersistent, isGenerated, iteratorOfAnnotations, iteratorOfDiagrams, iteratorOfElementReferences, iteratorOfUserMessages, keysOfElementReferences, removeAllFromAnnotations, removeAllFromDiagrams, removeAllFromElementReferences, removeAllFromUserMessages, removeFromAnnotations, removeFromDiagrams, removeFromElementReferences, removeFromElementReferences, removeFromUserMessages, removeKeyFromElementReferences, removeYou, setCutCopyPasteParent, setFirstOOGenToken, setGenerated, setLastOOGenToken, setName, sizeOfAnnotations, sizeOfDiagrams, sizeOfElementReferences, sizeOfUserMessages
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface de.uni_paderborn.fujaba.basic.UniqueIdentifier
getID
 
Methods inherited from interface de.uni_paderborn.fujaba.fsa.unparse.LogicUnparseInterface
getFSAInterface, getUnparseModuleName
 
Methods inherited from interface de.upb.tools.pcs.PropertyChangeInterface
getPropertyChangeSupport
 
Methods inherited from interface de.upb.tools.pcs.PropertyChangeClient
addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener
 
Methods inherited from interface de.tu_bs.coobra.ObjectChangeAware
acknowledgeChange, getCoObRAId, getRepository, setCoObRAId, setRepository
 
Methods inherited from interface de.uni_kassel.prop.InspectionAware
isInspectableField, proposeFieldValues
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FType
getFRealType, getFRevArrayType, getName, getProgLangType, setName
 

Field Detail

FULL_CLASS_NAME_PROPERTY

public static final java.lang.String FULL_CLASS_NAME_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

ABSTRACT_PROPERTY

public static final java.lang.String ABSTRACT_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

FILE_PROPERTY

public static final java.lang.String FILE_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

REV_IMPORTED_CLASSES_PROPERTY

public static final java.lang.String REV_IMPORTED_CLASSES_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

ATTRS_PROPERTY

public static final java.lang.String ATTRS_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

ROLES_PROPERTY

public static final java.lang.String ROLES_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

REV_ROLES_PROPERTY

public static final java.lang.String REV_ROLES_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

METHODS_PROPERTY

public static final java.lang.String METHODS_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

DECLARED_IN_PACKAGE_PROPERTY

public static final java.lang.String DECLARED_IN_PACKAGE_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

DECLARED_IN_METHOD_PROPERTY

public static final java.lang.String DECLARED_IN_METHOD_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

DECLARED_IN_CLASS_PROPERTY

public static final java.lang.String DECLARED_IN_CLASS_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

DECLARES_PROPERTY

public static final java.lang.String DECLARES_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

REV_SUBCLASS_PROPERTY

public static final java.lang.String REV_SUBCLASS_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values

REV_SUPERCLASS_PROPERTY

public static final java.lang.String REV_SUPERCLASS_PROPERTY
Property name used for change events, unparsing and persistency - do not change.

See Also:
Constant Field Values
Method Detail

getFullClassName

public java.lang.String getFullClassName()
This function computes the full qualified classname of this class e. g. if the class FooBar is defined in the package upb and upb is in de then this function will return "de.upb.FooBar".

Returns:
the full qualified class name

setAbstract

public boolean setAbstract(boolean value)
Change the 'abstract' flag of a class.

Parameters:
value - true to make a class abstract
Returns:
true if value was changed, false if it already had the specified value

isAbstract

public boolean isAbstract()
Read the 'abstract' flag of the class.

Returns:
true if this is an abstract class

setFile

public boolean setFile(FFile file)
Sets the file this class is defined in.

Parameters:
file - file this class is defined in
Returns:
true if value was changed, false if it already had the specified value

getFFile

public FFile getFFile()
Get the file this class is defined in.

Returns:
the file

hasInRevImportedClasses

public boolean hasInRevImportedClasses(FFile file)
Parameters:
file - file that possibly includes this class
Returns:
true if this class is imported in the specified file
See Also:
iteratorOfRevImportedClasses()

elementsOfRevImportedClasses

public java.util.Enumeration elementsOfRevImportedClasses()
Returns:
enumeration of files that import this class
See Also:
iteratorOfRevImportedClasses()

iteratorOfRevImportedClasses

public java.util.Iterator iteratorOfRevImportedClasses()
The revImportedClasses property is the conterpart of FFile.importedClasses. It lists all files that import this class (e.g. in their Java codes import clause).

Returns:
iterator through files that import this class
See Also:
FFile.iteratorOfImportedClasses()

addToRevImportedClasses

public void addToRevImportedClasses(FFile file)
Parameters:
file - file that imports this class now
See Also:
iteratorOfRevImportedClasses()

removeFromRevImportedClasses

public void removeFromRevImportedClasses(FFile file)
Parameters:
file - that does no longer import this class
See Also:
iteratorOfRevImportedClasses()

addToParsedMembers

public boolean addToParsedMembers(FDeclaration value)
Access method for a To N-association.

Parameters:
value - The object added.
Returns:
No description provided

hasInParsedMembers

public boolean hasInParsedMembers(FDeclaration value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

iteratorOfParsedMembers

public java.util.Iterator iteratorOfParsedMembers()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

removeAllFromParsedMembers

public void removeAllFromParsedMembers()
No comment provided by developer, please add a comment to improve documentation.


removeFromParsedMembers

public boolean removeFromParsedMembers(FDeclaration value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided
Returns:
No description provided

sizeOfParsedMembers

public int sizeOfParsedMembers()
No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

hasInAttrs

public boolean hasInAttrs(FAttr attr)
Parameters:
attr - attribute that is member of this class now (is declared by this class)
Returns:
true if value was added, false is already linked
See Also:
iteratorOfAttrs()

hasKeyInAttrs

public boolean hasKeyInAttrs(java.lang.String key)
Parameters:
key - name of an attribute
Returns:
true if this class declares an attribute with the specified name
See Also:
iteratorOfAttrs()

iteratorOfAttrs

public java.util.Iterator iteratorOfAttrs()
The attrs property of FClass contains all attributes (FAttrs) that are declared in this class. The reverse property is FAttr.parent.

Returns:
iterator through declared FAttrs
See Also:
FAttr.getFParent()

keysOfAttrs

public java.util.Iterator keysOfAttrs()
Returns:
iterator through attribute names (Strings)
See Also:
iteratorOfAttrs()

entriesOfAttrs

public java.util.Iterator entriesOfAttrs()
Returns:
iterator through attribute entries (String name, FAttr attribute)
See Also:
iteratorOfAttrs()

sizeOfAttrs

public int sizeOfAttrs()
Returns:
number of attributes this class declares
See Also:
iteratorOfAttrs()

getFromFAttrs

public FAttr getFromFAttrs(java.lang.String attrName)
Parameters:
attrName - name of the attribute to return
Returns:
the attribute with the specified name, declared in this class, null if no attribute of this name is declared by this class
See Also:
iteratorOfAttrs()

addToAttrs

public boolean addToAttrs(FAttr attr)
Parameters:
attr - attribute that is declared by this class now
Returns:
true if added, false if was already added
See Also:
iteratorOfAttrs()

removeFromAttrs

public boolean removeFromAttrs(FAttr attr)
Parameters:
attr - attribute that is no longer declared by this class
Returns:
true if removed, false if was already removed (not contained)
See Also:
iteratorOfAttrs()

removeKeyFromAttrs

public boolean removeKeyFromAttrs(java.lang.String attrName)
Parameters:
attrName - name of the attribute to be removed
Returns:
true if removed, false if was already removed (not contained)
See Also:
iteratorOfAttrs()

removeAllFromAttrs

public void removeAllFromAttrs()
Remove all declared attributes from this class.

See Also:
iteratorOfAttrs()

sizeOfRoles

public int sizeOfRoles()
Returns:
number of roles this class has
See Also:
iteratorOfRoles()

hasInRoles

public boolean hasInRoles(FRole role)
Parameters:
role - potential role this class has
Returns:
true if class has the specified role
See Also:
iteratorOfRoles()

elementsOfRoles

public java.util.Enumeration elementsOfRoles()
Returns:
enumeration of all roles this class has in associations
See Also:
iteratorOfRoles()

iteratorOfRoles

public java.util.Iterator iteratorOfRoles()
The roles property lists all roles this class has in associations. A role is part of an association.

Returns:
iterator through all roles this class has in associations
See Also:
FRole, FRole.getFRevRoles()

getFromFRoles

public FRole getFromFRoles(java.lang.String roleName)
Parameters:
roleName - name of a role
Returns:
the role of this class with the specified name, null if no role with this name
See Also:
iteratorOfRoles()

addToRoles

public void addToRoles(FRole role)
Parameters:
role - new role this class has now
See Also:
iteratorOfRoles()

removeFromRoles

public void removeFromRoles(FRole elem)
Parameters:
elem - role this class this class has no more
See Also:
iteratorOfRoles()

getFromFRevRoles

public FRole getFromFRevRoles(java.lang.String roleName)
Find a partner role of any role this class has: E.g. Class 'Man' associates class 'Boy' where Man has the role "parent" and Boy has the role "child". You can now ask Man for getFromRevRoles("child") to find the described role at Boy. todo: The behaviour of this method is not soundly defined if mutiple partner roles exist with the specified name

Parameters:
roleName - name of a partner role
Returns:
a partner role

hasInMethods

public boolean hasInMethods(FMethod method)
Parameters:
method - potential method in this class
Returns:
true if method is declared in this class
See Also:
iteratorOfMethods()

hasKeyInMethods

public boolean hasKeyInMethods(java.lang.String signature)
Parameters:
signature - signature of a method
Returns:
true if this class declares a method with this signature
See Also:
iteratorOfMethods()

iteratorOfMethods

public java.util.Iterator iteratorOfMethods()
The methods property contains all methods this class declares.

Returns:
iterator through declared methods
See Also:
FMethod.getFParent()

sizeOfMethods

public int sizeOfMethods()
Returns:
number of mthods in this class
See Also:
iteratorOfMethods()

getFromFMethods

public FMethod getFromFMethods(java.lang.String signature)
Parameters:
signature - possible signature
Returns:
the method declared in this class with the specified signature, null if no such method
See Also:
iteratorOfMethods()

addToMethods

public boolean addToMethods(FMethod method)
Parameters:
method - method that is declared in this class now
Returns:
true if added, false if was already added
See Also:
iteratorOfMethods()

removeFromMethods

public boolean removeFromMethods(FMethod method)
Parameters:
method - method that is no longer declared in this class
Returns:
true if removed, false if was already removed (not contained)
See Also:
iteratorOfMethods()

removeKeyFromMethods

public boolean removeKeyFromMethods(java.lang.String signature)
Parameters:
signature - signature of the method to be removed from declared methods
Returns:
true if removed, false if was already removed (not contained)
See Also:
iteratorOfMethods()

removeAllFromMethods

public void removeAllFromMethods()
Remove all methods declared in this class.

See Also:
iteratorOfMethods()

setDeclaredInPackage

public boolean setDeclaredInPackage(FPackage pkg)
Parameters:
pkg - the package this class is declared in now
Returns:
true if the class was declared in another package before
See Also:
getFDeclaredInPackage()

getFDeclaredInPackage

public FPackage getFDeclaredInPackage()
The declaredInPackage property denotes the package this class is declared in, null if this is an inner or anonymous class.

Returns:
the package this class is declared in, null if not applicable
See Also:
FPackage.iteratorOfDeclares(), getFDeclaredInClass(), getFDeclaredInMethod()

setDeclaredInMethod

public boolean setDeclaredInMethod(FMethod method)
Parameters:
method - method where this class is declared in now
Returns:
true if value was changed
See Also:
getFDeclaredInMethod()

getFDeclaredInMethod

public FMethod getFDeclaredInMethod()
The declaredInMethod property denotes the method this class is declared in if it is an anonymous class, null if this is a top level or inner class.

Returns:
the method this anonymous class is declared in, null if not applicable
See Also:
FMethod.iteratorOfDeclares(), getFDeclaredInClass(), getFDeclaredInMethod()

setDeclaredInClass

public boolean setDeclaredInClass(FClass cls)
Parameters:
cls - class where this class is declared in now
Returns:
true if value was changed
See Also:
getFDeclaredInClass()

getFDeclaredInClass

public FClass getFDeclaredInClass()
The declaredInClass property denotes the class this inner class is declared in, null if this is a top level or anonymous class.

Returns:
the class this inner class is declared in, null if not applicable
See Also:
iteratorOfDeclares(), getFDeclaredInPackage(), getFDeclaredInMethod()

hasInDeclares

public boolean hasInDeclares(FClass cls)
Parameters:
cls - possible inner class
Returns:
true if cls is an inner class of this class
See Also:
iteratorOfDeclares()

hasKeyInDeclares

public boolean hasKeyInDeclares(java.lang.String classname)
Parameters:
classname - unqualified classname
Returns:
true if this class has an inner class with specified name
See Also:
iteratorOfDeclares()

iteratorOfDeclares

public java.util.Iterator iteratorOfDeclares()
The declares property holds all inner classes of this class.

Returns:
an iterator through inner classes

keysOfDeclares

public java.util.Iterator keysOfDeclares()
Returns:
iterator through the unqualified names of inner classes (Strings)
See Also:
iteratorOfDeclares()

entriesOfDeclares

public java.util.Iterator entriesOfDeclares()
Returns:
iterator through inner class entries (String name, FClass class)
See Also:
iteratorOfDeclares()

sizeOfDeclares

public int sizeOfDeclares()
Returns:
number of inner classes
See Also:
iteratorOfDeclares()

getFromFDeclares

public FClass getFromFDeclares(java.lang.String classname)
Parameters:
classname - unqualified classname
Returns:
the inner class declared in this class with the specified name, null if no inner class of that name
See Also:
iteratorOfDeclares()

addToDeclares

public boolean addToDeclares(FClass cls)
Parameters:
cls - the class that is inner class of this class now
Returns:
true if the value was added, false if it was already an inner class of this class
See Also:
iteratorOfDeclares()

removeFromDeclares

public boolean removeFromDeclares(FClass cls)
Parameters:
cls - class that is no longer an inner class of this class
Returns:
true if class was removed, false if it was no inner class of this class
See Also:
iteratorOfDeclares()

removeKeyFromDeclares

public boolean removeKeyFromDeclares(java.lang.String classname)
Parameters:
classname - unqualified classname of an inner class
Returns:
true if the class with specified name was removed, false if no inner class with this name
See Also:
iteratorOfDeclares()

removeAllFromDeclares

public void removeAllFromDeclares()
Remove all inner classes (delete link, classes remain intact).

See Also:
iteratorOfDeclares()

hasInRevSubclass

public boolean hasInRevSubclass(FGeneralization generalization)
Parameters:
generalization - possible generalization that has this class as subclass
Returns:
true if this is the subclass in the generalization
See Also:
iteratorOfRevSubclass()

sizeOfRevSubclass

public int sizeOfRevSubclass()
Returns:
number of superclasses/interfaces
See Also:
iteratorOfRevSubclass()

iteratorOfRevSubclass

public java.util.Iterator iteratorOfRevSubclass()
The revSubclass property contains alls generalizations where this class is the subclass. This means all superclasses can be found this way.

Returns:
iterator through generalizations

addToRevSubclass

public void addToRevSubclass(FGeneralization elem)
Parameters:
elem - generalization where this class is the subclass now
See Also:
iteratorOfRevSubclass()

removeFromRevSubclass

public void removeFromRevSubclass(FGeneralization elem)
Parameters:
elem - generalization where this class is no longer the subclass
See Also:
iteratorOfRevSubclass()

removeAllFromRevSubclass

public void removeAllFromRevSubclass()
Remove all generalizations where this class is the subclass.

See Also:
iteratorOfRevSubclass()

elementsOfRevSubclass

public java.util.Enumeration elementsOfRevSubclass()
Returns:
enumeration of generalizations
See Also:
iteratorOfRevSubclass()

elementsOfSuperClasses

public de.upb.tools.sdm.Path elementsOfSuperClasses()
Deprecated. please use iteratorOfSuperClasses()

Returns:
No description provided

iteratorOfSuperClasses

public de.upb.tools.sdm.Path iteratorOfSuperClasses()
Returns:
iterator through all superclasses and interfaces

hasInRevSuperclass

public boolean hasInRevSuperclass(FGeneralization elem)
Parameters:
elem - generalization
Returns:
true if this class is the superclass in the generalization
See Also:
iteratorOfRevSuperclass()

elementsOfRevSuperclass

public java.util.Enumeration elementsOfRevSuperclass()
Returns:
enumeration of generalizations where this class is the superclass
See Also:
iteratorOfRevSuperclass()

iteratorOfRevSuperclass

public java.util.Iterator iteratorOfRevSuperclass()
The revSuperclass property contains all generalization where this class is the superclass. You can find subclasses on this way.

Returns:
iterator through generalizations where this class is the superclass

addToRevSuperclass

public void addToRevSuperclass(FGeneralization elem)
Parameters:
elem - generalization where this class is the superclass now
See Also:
iteratorOfRevSuperclass()

removeFromRevSuperclass

public void removeFromRevSuperclass(FGeneralization elem)
Parameters:
elem - generalization where this class is no longer the superclass
See Also:
iteratorOfRevSuperclass()

removeAllFromRevSuperclass

public void removeAllFromRevSuperclass()
Remove all generalizations where this class is the superclass.

See Also:
iteratorOfRevSuperclass()

isStatic

public boolean isStatic()
Deprecated. Use <> stereotype instead

Returns:
The static value

setStatic

public void setStatic(boolean value)
Deprecated. Use <> stereotype instead

Parameters:
value - The new static value

isFinal

public boolean isFinal()
Deprecated. Use <> stereotype instead

Returns:
The final value

isReference

public boolean isReference()
Deprecated. Use <> stereotype instead

Returns:
The reference value

getFSuperClass

public FClass getFSuperClass()
Deprecated. will be renamed when using JDK 1.5 (without F)

Returns:
The fSuperClass value

getFromAllFAttrs

public FAttr getFromAllFAttrs(java.lang.String attributeName)
Deprecated. will be renamed when using JDK 1.5 (without F)

Search for an attribute in the class hierarchy. An attribute with the specified name is searched in this class first and then in all superclasses, recursively.

Parameters:
attributeName - name of an attribute to be found
Returns:
the first matching attribute

getFromAllFMethods

public FMethod getFromAllFMethods(java.lang.String methodSignature)
Deprecated. will be renamed when using JDK 1.5 (without F)

Search for a method in the class hierarchy. A method with the specified signature is searched in this class first and then in all superclasses, recursively.

Parameters:
methodSignature - name of an attribute to be found
Returns:
the first matching method

getFromFMethodsByShortName

public FMethod getFromFMethodsByShortName(java.lang.String methodname)
Deprecated. will be renamed when using JDK 1.5 (without F)

Find a method with specified name. todo: The behaviour of this method is not soundly defined if more than one method with the given name exists

Parameters:
methodname - name (not signature) of a method
Returns:
a method, declared in this class, with specified name

getFromFMethodsByShortNameIncludingInherited

public FMethod getFromFMethodsByShortNameIncludingInherited(java.lang.String methodname)
Deprecated. will be renamed when using JDK 1.5 (without F)

Find a method with specified name in this class or superclasses. The first method that is found searching from this class to the superclasses is returned. todo: The behaviour of this method is not soundly defined if more than one method with the given name exists in a single class or in different superclasses.

Parameters:
methodname - name (not signature) of a method
Returns:
a method, declared in this class or inherited from another class, with specified name

getFStatechart

public FDiagram getFStatechart()
Deprecated. will be renamed when using JDK 1.5 (without F)

Returns:
the statechart for this class, null if not applicable

getFReactiveDiagram

public FDiagram getFReactiveDiagram()
Deprecated. will be renamed when using JDK 1.5 (without F) or removed?

todo: is this used by anyone?!

Returns:
the reactive diagram associated with this class

findFPackage

public FPackage findFPackage()
Deprecated. will be renamed when using JDK 1.5 (without F)

Returns:
package this class is enclosed in - even for inner and anonymous classes