de.uni_paderborn.fujaba.uml
Class UMLMethod

java.lang.Object
  extended byde.uni_paderborn.fujaba.basic.BasicIncrement
      extended byde.uni_paderborn.fujaba.asg.ASGElement
          extended byde.uni_paderborn.fujaba.uml.UMLIncrement
              extended byde.uni_paderborn.fujaba.uml.UMLDiagramItem
                  extended byde.uni_paderborn.fujaba.uml.UMLDeclaration
                      extended byde.uni_paderborn.fujaba.uml.UMLMethod
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, FDeclaration, FDiagramItem, FElement, FIncrement, FMethod, de.uni_kassel.prop.InspectionAware, LogicUnparseInterface, de.tu_bs.coobra.ObjectChangeAware, de.upb.tools.pcs.PropertyChangeClient, de.upb.tools.pcs.PropertyChangeInterface, UniqueIdentifier

public class UMLMethod
extends UMLDeclaration
implements FMethod

Associatons

            1                    1 +---------------------+
 UMLMethod ------------------------+ getFullMethodName() | UMLClass
            methods         parent +---------------------+

          +-----------+ 1                          1
 UMLClass | getName() +------------------------------ UMLMethod
          +-----------+ declares    declaredInMethod

           0..1                           0..*
 UMLAttr -------------------------------------- UMLMethod
          accessedAttribute      accessMethods

            0..1    astRootNode     0..1
 UMLMethod ------------------------------ ASTRootNode
            uMLMethod        aSTRootNode

 

Version:
$Revision: 1.380.2.5 $
Author:
$Author: lowende $

Nested Class Summary
 
Nested classes inherited from class de.uni_paderborn.fujaba.asg.ASGElement
ASGElement.SortByNameComparator
 
Field Summary
 
Fields inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
dontUseAccessMethodsInThisClass
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FMethod
ABSTRACT_PROPERTY, DECLARES_PROPERTY, PARAM_PROPERTY, PARENT_PROPERTY, RESULT_TYPE_PROPERTY, STATIC_PROPERTY, STORY_DIAGRAM_PROPERTY
 
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
 
Constructor Summary
UMLMethod()
          Constructor for class UMLMethod
UMLMethod(boolean coobraPersistent)
          Constructor for class UMLMethod
UMLMethod(java.lang.String name)
          Constructor for class UMLMethod
UMLMethod(java.lang.String name, boolean umlStatic, int visibility, UMLConstraint constraint, UMLType resultType, UMLStartActivity revSpec)
          Constructor for class UMLMethod
UMLMethod(java.lang.String name, boolean umlStatic, int visibility, UMLType resultType)
          Constructor for class UMLMethod
 
Method Summary
 boolean addToDeclares(FClass obj)
          Access method for an one to n association.
protected  void addToDeclares(KeyValuePair pair)
          This method is needed only for loading FTreeMaps, do not use it in other cases.
 void addToParam(FParam newParam)
          Access method for an one to n association.
 void addToParam(int index, FParam newParam)
          Access method for an one to n association.
 boolean addToThrowsTypes(UMLType value)
          Access method for an one to n association.
 int compareTo(java.lang.Object obj)
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String constructFullMethodName(java.lang.String name, java.util.Iterator iteratorOfParam)
          No comment provided by developer, please add a comment to improve documentation.
 UMLActivityDiagram createStoryDiagram()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator entriesOfDeclares()
          No comment provided by developer, please add a comment to improve documentation.
 UMLAttr getAccessedAttribute()
          Get the accessedAttribute attribute of the UMLMethod object
 ASTRootNode getASTRootNode()
          Returns the abstract syntax tree (AST) root node of the method If the method body isn't parsed yet, the method body will be parsed.
 FAttr getFAccessedAttribute()
          Get the fAccessedAttribute attribute of the UMLMethod object
 FClass getFParent()
          Get the fParent attribute of the UMLMethod object
 FType getFResultType()
          Get the fResultType attribute of the UMLMethod object
 FElement getFRevSpec()
          Get the fRevSpec attribute of the UMLMethod object
 UMLClass getFromDeclares(java.lang.String key)
          Get the fromDeclares attribute of the UMLMethod object
 FClass getFromFDeclares(java.lang.String key)
          Get the fromFDeclares attribute of the UMLMethod object
 FDiagram getFStoryDiagram()
          Get the fStoryDiagram attribute of the UMLMethod object
 java.lang.String getFullMethodName()
          This function assembles the full name of the method out of the name and the signature.
 java.lang.String getJava()
          Get the java attribute of the UMLMethod object
 java.lang.String getMethodBody()
          Get the methodBody of the UMLMethod
 java.lang.StringBuffer getMethodBodyText()
          Deprecated. use getMethodBody() instead
 java.lang.String getMethodDecl()
          Get the methodDecl attribute of the UMLMethod object
 java.lang.String getName()
          Get the name attribute of the UMLMethod object
 UMLClass getParent()
          Get the parent attribute of the UMLMethod object
 FElement getParentElement()
          Query the logical parent of this element (e.g. package of a class, diagram of an object).
 java.lang.String getQualifiedMethodDecl()
          Get the qualifiedMethodDecl attribute of the UMLMethod object
 UMLType getResultType()
          Get the resultType attribute of the UMLMethod object
 UMLStartActivity getRevSpec()
          Get the revSpec attribute of the UMLMethod object
 UMLActivityDiagram getStoryDiag()
          Get the storyDiag attribute of the UMLMethod object
 UMLActivityDiagram getStoryDiagram()
          Get the storyDiagram attribute of the UMLMethod object
 java.lang.String getText()
          Get the text attribute of the UMLMethod object
 UMLAction getUMLAction()
          Get the uMLAction attribute of the UMLMethod object
 UMLType getUMLType()
          Get the uMLType attribute of the UMLMethod object
static java.lang.String getVisibilityType(int visibility)
          Get the visibilityType attribute of the UMLMethod class
 boolean hasInDeclares(FClass obj)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInParam(FParam newParam)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasInThrowsTypes(UMLType value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean hasKeyInDeclares(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 boolean isAbstract()
          Get the abstract attribute of the UMLMethod object
 boolean isConstructor()
          Returns true, if the method is a constructor.
 boolean isFinal()
          Get the final attribute of the UMLMethod object
 boolean isJavaConstructor()
          Deprecated. use #isConstructor instead
 boolean isResultTypeIsPointer()
          Get the value of resultTypeIsPointer.
 boolean isSignal()
          Get the signal attribute of the UMLMethod object
 boolean isStatic()
          Get the static attribute of the UMLMethod object
 boolean isSynchronized()
          Get the synchronized attribute of the UMLMethod object
 boolean isUmlAbstract()
          Wrapper to meet the style guides.
 boolean isUmlFinal()
          Wrapper to meet the style guides.
 boolean isUmlNative()
          Get the umlNative attribute of the UMLMethod object
 boolean isUmlSignal()
          Wrapper to meet the style guides.
 boolean isUmlStatic()
          Get the umlStatic attribute of the UMLMethod object
 boolean isUmlSynchronized()
          Get the umlSynchronized attribute of the UMLMethod object
 java.util.Iterator iteratorOfDeclares()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfOverriddenMethods()
          Find all methods in superclasses and -interfaces that have the same signature as this method.
 java.util.Iterator iteratorOfOverridingMethods()
          Find all methods in subclasses and -interfaces that have the same signature as this method.
 java.util.Iterator iteratorOfParam()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfThrowsTypes()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator keysOfDeclares()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromDeclares()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromParam()
          No comment provided by developer, please add a comment to improve documentation.
 void removeAllFromThrowsTypes()
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromDeclares(FClass obj)
          No comment provided by developer, please add a comment to improve documentation.
 void removeFromParam(FParam newParam)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeFromThrowsTypes(UMLType value)
          No comment provided by developer, please add a comment to improve documentation.
 boolean removeKeyFromDeclares(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 void removeStoryDiagram()
          No comment provided by developer, please add a comment to improve documentation.
 void removeYou()
          Isolates the object so the garbage collector can remove it.
 ASGElement searchID(java.lang.String id)
          Searches the ASG tree for a given id
 void setAbstract(boolean umlAbstract)
          Sets the abstract attribute of the UMLMethod object
 boolean setAccessedAttribute(FAttr value)
          Sets the accessedAttribute attribute of the UMLMethod object
 void setASTRootNode(ASTRootNode astRootNode)
          Sets the abstract syntax tree (AST) root node of the method
 void setCutCopyPasteParent(FElement parent)
          Hangs the current ASGElement into the ASG-tree.
 void setFinal(boolean umlFinal)
          Sets the final attribute of the UMLMethod object
 void setMethodBody(java.lang.String methodBody)
          Sets the methodBody of the UMLMethod
 void setMethodBody(java.lang.String methodBody, boolean generated)
          Sets the methodBody of the UMLMethod
 void setMethodBodyText(java.lang.StringBuffer buf)
          Deprecated. use setMethodBody(String methodBody) instead
 void setName(java.lang.String name)
          Sets the name attribute of the UMLMethod object
 void setParent(FClass parent)
          Sets the parent attribute of the UMLMethod object
 void setPatternMethodBody(java.lang.String bodyText, boolean generated)
          Deprecated. use setMethodBody(String methodBody) instead
 void setQualifiedMethodDecl(java.lang.String str)
          Sets the qualifiedMethodDecl attribute of the UMLMethod object
 void setResultType(FType value)
          Sets the resultType attribute of the UMLMethod object
 void setResultTypeIsPointer(boolean resultTypeIsPointer)
          Set the value of resultTypeIsPointer.
 void setRevSpec(FElement revSpec)
          Sets the revSpec attribute of the UMLMethod object
 void setSignal(boolean umlSignal)
          Sets the signal attribute of the UMLMethod object
 void setStatic(boolean umlStatic)
          Sets the static attribute of the UMLMethod object
 void setStoryDiag(UMLActivityDiagram storyDiag)
          Sets the revSpec attribute of the UMLMethod object
 void setSynchronized(boolean umlSynchronized)
          Sets the synchronized attribute of the UMLMethod object
 void setUmlAbstract(boolean umlAbstract)
          Wrapper for to meet the style guides.
 boolean setUMLAction(UMLAction value)
          Sets the uMLAction attribute of the UMLMethod object
 void setUmlFinal(boolean umlFinal)
          Wrapper to meet the style guides.
 void setUmlNative(boolean newUmlNative)
          Sets the umlNative attribute of the UMLMethod object
 void setUmlSignal(boolean umlSignal)
          Wrapper to meet the style guides.
 void setUmlStatic(boolean umlStatic)
          Wrapper to meet the style guides.
 void setUmlSynchronized(boolean newUmlSynchronized)
          Sets the umlSynchronized attribute of the UMLMethod object
 int sizeOfDeclares()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfParam()
          No comment provided by developer, please add a comment to improve documentation.
 int sizeOfThrowsTypes()
          No comment provided by developer, please add a comment to improve documentation.
 java.lang.String toString()
          No comment provided by developer, please add a comment to improve documentation.
 
Methods inherited from class de.uni_paderborn.fujaba.uml.UMLDeclaration
getDisplayLevel, getFType, getVisibility, isParsed, setDisplayLevel, setParsed, setVisibility
 
Methods inherited from class de.uni_paderborn.fujaba.uml.UMLDiagramItem
addToDiagrams, addToRevAdditionalItems, addToRevItems, addToViewDefinitions, createUnparseModuleName, getCurrentActiveDiagram, getFCurrentActiveDiagram, getFFirstFromDiagrams, getFirstFromDiagrams, hasInRevAdditionalItems, hasInRevItems, hasInViewDefinitions, iteratorOfRevAdditionalItems, iteratorOfRevItems, iteratorOfViewDefinitions, removeAllFromRevAdditionalItems, removeAllFromRevItems, removeAllFromViewDefinitions, removeFromRevAdditionalItems, removeFromRevItems, removeFromViewDefinitions, sizeOfRevAdditionalItems, sizeOfRevItems, sizeOfViewDefinitions
 
Methods inherited from class de.uni_paderborn.fujaba.uml.UMLIncrement
addToConstraints, addToStereotypes, addToStereotypes, elementsOfAllChildren, entriesOfStereotypes, getComment, getFComment, getFromFStereotypes, getFromStereotypes, getFromStereotypes, hasInConstraints, hasInStereotypes, hasKeyInStereotypes, isAssertInUnitTest, iteratorOfConstraints, iteratorOfStereotypes, keysOfStereotypes, removeAllFromConstraints, removeAllFromStereotypes, removeFromConstraints, removeFromStereotypes, removeKeyFromStereotypes, setAssertInUnitTest, setComment, setStereotype, sizeOfConstraint, sizeOfStereotypes
 
Methods inherited from class de.uni_paderborn.fujaba.asg.ASGElement
acknowledgeChange, addAdditionalListener, addPointToUnparseInformation, addPropertyChangeListener, addPropertyChangeListener, addToAnnotations, addToElementReferences, addToElementReferences, addToFsaObjects, addToLocations, addToLocations, addToPropertyChangeListeners, addToPropertyChangeListeners, addToUnparseInformations, addToUnparseInformations, addToUserMessages, deleteTokens, elementsOfDiagrams, entriesOfElementReferences, entriesOfFsaObjects, entriesOfUnparseInformations, fireEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCoObRAId, getFirstFromFSAObjects, getFirstOOGenToken, getFromElementReferences, getFromFElementReferences, getFromFsaObjects, getFromUnparseInformations, getFSAInterface, getLastModified, getLastOOGenToken, getPointFromUnparseInformation, getPropertyChangeSupport, getRepository, getTransientElements, getUnparseModuleName, getUnparseModuleNameImpl, hasInAnnotations, hasInDiagrams, hasInElementReferences, hasInElementReferences, hasInFsaObjects, hasKeyInElementReferences, hasKeyInFsaObjects, initElementListener, initPersistency, isCoobraPersistent, isInspectableField, isInTransientMode, isPersistencyChange, isReadOnly, iteratorOfAnnotations, iteratorOfDiagrams, iteratorOfElementReferences, iteratorOfFsaObjects, iteratorOfKeyFromUnparseInformations, iteratorOfUnparseInformations, iteratorOfUserMessages, keysOfElementReferences, keysOfFsaObjects, keysOfUnparseInformations, proposeFieldValues, removeAdditionalListener, removeAllFromAnnotations, removeAllFromDiagrams, removeAllFromElementReferences, removeAllFromFsaObjects, removeAllFromUnparseInformations, removeAllFromUserMessages, removeFromAnnotations, removeFromDiagrams, removeFromElementReferences, removeFromElementReferences, removeFromFsaObjects, removeFromPropertyChangeListeners, removeFromPropertyChangeListeners, removeFromUnparseInformations, removeFromUnparseInformations, removeFromUnparseInformations, removeFromUserMessages, removeKeyFromElementReferences, removeKeyFromFsaObjects, removePropertyChangeListener, removePropertyChangeListener, saveFSAProperties, saveLocations, setCoObRAId, setFirstOOGenToken, setGenerated, setInTransientMode, setLastOOGenToken, setRepository, setUnparseModuleName, sizeOfAnnotations, sizeOfDiagrams, sizeOfElementReferences, sizeOfFsaObjects, sizeOfUserMessages, updateFSACollapsed, updateFSALocation, updateKeyInFsaObjects, writeAttributes
 
Methods inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
getID, getUniqueID, getUniqueID, isGenerated, lessUniqueId, readAttributes, readAttributes, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, resetClassInfos, resetFieldWriteMethods, setAttribValue, setAttribValue, setID, setUniqueId, writeClassToStringBuffer, writeClassToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FMethod
getFType
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FDeclaration
getDisplayLevel, 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, hasInAnnotations, hasInDiagrams, hasInElementReferences, hasInElementReferences, hasKeyInElementReferences, isCoobraPersistent, isGenerated, iteratorOfAnnotations, iteratorOfDiagrams, iteratorOfElementReferences, iteratorOfUserMessages, keysOfElementReferences, removeAllFromAnnotations, removeAllFromDiagrams, removeAllFromElementReferences, removeAllFromUserMessages, removeFromAnnotations, removeFromDiagrams, removeFromElementReferences, removeFromElementReferences, removeFromUserMessages, removeKeyFromElementReferences, setFirstOOGenToken, setGenerated, setLastOOGenToken, sizeOfAnnotations, sizeOfDiagrams, sizeOfElementReferences, sizeOfUserMessages
 
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
 

Constructor Detail

UMLMethod

public UMLMethod()
Constructor for class UMLMethod


UMLMethod

public UMLMethod(boolean coobraPersistent)
Constructor for class UMLMethod

Parameters:
coobraPersistent - No description provided

UMLMethod

public UMLMethod(java.lang.String name)
Constructor for class UMLMethod

Parameters:
name - No description provided

UMLMethod

public UMLMethod(java.lang.String name,
                 boolean umlStatic,
                 int visibility,
                 UMLType resultType)
Constructor for class UMLMethod

Parameters:
name - No description provided
umlStatic - No description provided
visibility - No description provided
resultType - No description provided

UMLMethod

public UMLMethod(java.lang.String name,
                 boolean umlStatic,
                 int visibility,
                 UMLConstraint constraint,
                 UMLType resultType,
                 UMLStartActivity revSpec)
Constructor for class UMLMethod

Parameters:
name - No description provided
umlStatic - No description provided
visibility - No description provided
constraint - No description provided
resultType - No description provided
revSpec - No description provided
Method Detail

toString

public java.lang.String toString()
Description copied from class: UMLDiagramItem
No comment provided by developer, please add a comment to improve documentation.

Overrides:
toString in class UMLDiagramItem
Returns:
short string representation of current object

getName

public java.lang.String getName()
Get the name attribute of the UMLMethod object

Specified by:
getName in interface FElement
Overrides:
getName in class ASGElement
Returns:
The name value

setName

public void setName(java.lang.String name)
Sets the name attribute of the UMLMethod object

Specified by:
setName in interface FElement
Overrides:
setName in class ASGElement
Parameters:
name - The new name value

getFullMethodName

public java.lang.String getFullMethodName()
This function assembles the full name of the method out of the name and the signature. e. g.: getFullMethodName(), setName(String),

Specified by:
getFullMethodName in interface FMethod
Returns:
The fullMethodName value

constructFullMethodName

public static java.lang.String constructFullMethodName(java.lang.String name,
                                                       java.util.Iterator iteratorOfParam)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
name - No description provided
iteratorOfParam - No description provided
Returns:
No description provided

getText

public java.lang.String getText()
Get the text attribute of the UMLMethod object

Specified by:
getText in interface FElement
Overrides:
getText in class ASGElement
Returns:
The text value

getQualifiedMethodDecl

public java.lang.String getQualifiedMethodDecl()
Get the qualifiedMethodDecl attribute of the UMLMethod object

Returns:
The qualifiedMethodDecl value

setQualifiedMethodDecl

public void setQualifiedMethodDecl(java.lang.String str)
Sets the qualifiedMethodDecl attribute of the UMLMethod object

Parameters:
str - The new qualifiedMethodDecl value

getMethodDecl

public java.lang.String getMethodDecl()
Get the methodDecl attribute of the UMLMethod object

Returns:
The methodDecl value

getJava

public java.lang.String getJava()
Get the java attribute of the UMLMethod object

Returns:
The java value

isStatic

public boolean isStatic()
Get the static attribute of the UMLMethod object

Specified by:
isStatic in interface FMethod
Returns:
The static value

isUmlStatic

public boolean isUmlStatic()
Get the umlStatic attribute of the UMLMethod object

Returns:
The umlStatic value

setStatic

public void setStatic(boolean umlStatic)
Sets the static attribute of the UMLMethod object

Specified by:
setStatic in interface FMethod
Parameters:
umlStatic - The new static value

setUmlStatic

public void setUmlStatic(boolean umlStatic)
Wrapper to meet the style guides. Toggles the static flag.

Parameters:
umlStatic - new value
See Also:
setStatic(boolean)

setSignal

public void setSignal(boolean umlSignal)
Sets the signal attribute of the UMLMethod object

Parameters:
umlSignal - The new signal value

setUmlSignal

public void setUmlSignal(boolean umlSignal)
Wrapper to meet the style guides. Toggles the signal flag.

Parameters:
umlSignal - new value
See Also:
setSignal(boolean)

isSignal

public boolean isSignal()
Get the signal attribute of the UMLMethod object

Specified by:
isSignal in interface FMethod
Returns:
The signal value

isUmlSignal

public boolean isUmlSignal()
Wrapper to meet the style guides. Requests the current value of the signal flag.

Returns:
The umlSignal value
See Also:
isSignal()

setFinal

public void setFinal(boolean umlFinal)
Sets the final attribute of the UMLMethod object

Specified by:
setFinal in interface FMethod
Parameters:
umlFinal - The new final value

setUmlFinal

public void setUmlFinal(boolean umlFinal)
Wrapper to meet the style guides. Toggles the final flag.

Parameters:
umlFinal - new value
See Also:
setFinal(boolean)

isFinal

public boolean isFinal()
Get the final attribute of the UMLMethod object

Specified by:
isFinal in interface FMethod
Returns:
The final value

isUmlFinal

public boolean isUmlFinal()
Wrapper to meet the style guides. Requests the current value of the final flag.

Returns:
The umlFinal value
See Also:
isFinal()

setAbstract

public void setAbstract(boolean umlAbstract)
Sets the abstract attribute of the UMLMethod object

Specified by:
setAbstract in interface FMethod
Parameters:
umlAbstract - The new abstract value

setUmlAbstract

public void setUmlAbstract(boolean umlAbstract)
Wrapper for to meet the style guides. Toggles the abstract flag.

Parameters:
umlAbstract - The new umlAbstract value
See Also:
setAbstract(boolean)

isAbstract

public boolean isAbstract()
Get the abstract attribute of the UMLMethod object

Specified by:
isAbstract in interface FMethod
Returns:
The abstract value

isUmlAbstract

public boolean isUmlAbstract()
Wrapper to meet the style guides. Requests the current value of the abstract flag.

Returns:
The umlAbstract value
See Also:
isAbstract()

isUmlNative

public boolean isUmlNative()
Get the umlNative attribute of the UMLMethod object

Specified by:
isUmlNative in interface FMethod
Returns:
The umlNative value

setUmlNative

public void setUmlNative(boolean newUmlNative)
Sets the umlNative attribute of the UMLMethod object

Parameters:
newUmlNative - The new umlNative value

setSynchronized

public void setSynchronized(boolean umlSynchronized)
Sets the synchronized attribute of the UMLMethod object

Parameters:
umlSynchronized - The new synchronized value

isSynchronized

public boolean isSynchronized()
Get the synchronized attribute of the UMLMethod object

Specified by:
isSynchronized in interface FMethod
Returns:
The synchronized value

isUmlSynchronized

public boolean isUmlSynchronized()
Get the umlSynchronized attribute of the UMLMethod object

Returns:
The umlSynchronized value

setUmlSynchronized

public void setUmlSynchronized(boolean newUmlSynchronized)
Sets the umlSynchronized attribute of the UMLMethod object

Specified by:
setUmlSynchronized in interface FMethod
Parameters:
newUmlSynchronized - The new umlSynchronized value

getParent

public UMLClass getParent()
Get the parent attribute of the UMLMethod object

Returns:
The parent value

getFParent

public FClass getFParent()
Get the fParent attribute of the UMLMethod object

Specified by:
getFParent in interface FMethod
Returns:
The fParent value

setParent

public void setParent(FClass parent)
Sets the parent attribute of the UMLMethod object

Specified by:
setParent in interface FMethod
Parameters:
parent - The new parent value

getVisibilityType

public static java.lang.String getVisibilityType(int visibility)
Get the visibilityType attribute of the UMLMethod class

Parameters:
visibility - No description provided
Returns:
The visibilityType value

getResultType

public UMLType getResultType()
Get the resultType attribute of the UMLMethod object

Returns:
The resultType value

getFResultType

public FType getFResultType()
Get the fResultType attribute of the UMLMethod object

Specified by:
getFResultType in interface FMethod
Returns:
The fResultType value

getUMLType

public UMLType getUMLType()
Get the uMLType attribute of the UMLMethod object

Specified by:
getUMLType in class UMLDeclaration
Returns:
The uMLType value

setResultType

public void setResultType(FType value)
Sets the resultType attribute of the UMLMethod object

Specified by:
setResultType in interface FMethod
Parameters:
value - The new resultType value

isResultTypeIsPointer

public boolean isResultTypeIsPointer()
Get the value of resultTypeIsPointer.

Specified by:
isResultTypeIsPointer in interface FMethod
Returns:
Value of resultTypeIsPointer.

setResultTypeIsPointer

public void setResultTypeIsPointer(boolean resultTypeIsPointer)
Set the value of resultTypeIsPointer.

Specified by:
setResultTypeIsPointer in interface FMethod
Parameters:
resultTypeIsPointer - Value to assign to resultTypeIsPointer.

isConstructor

public boolean isConstructor()
Returns true, if the method is a constructor. The result type may be null or UMLBaseTypes.CONSTRUCTOR, which is an UML-Basetype and respresents null. Furthermore the method name is the same as the class name.

Specified by:
isConstructor in interface FMethod
Returns:
True, if the method is a constructor

isJavaConstructor

public boolean isJavaConstructor()
Deprecated. use #isConstructor instead

Returns:
true, if method is a constructor

hasInDeclares

public boolean hasInDeclares(FClass obj)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
hasInDeclares in interface FMethod
Parameters:
obj - No description provided
Returns:
No description provided

hasKeyInDeclares

public boolean hasKeyInDeclares(java.lang.String key)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
hasKeyInDeclares in interface FMethod
Parameters:
key - No description provided
Returns:
No description provided

iteratorOfDeclares

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

Specified by:
iteratorOfDeclares in interface FMethod
Returns:
No description provided

keysOfDeclares

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

Specified by:
keysOfDeclares in interface FMethod
Returns:
No description provided

entriesOfDeclares

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

Specified by:
entriesOfDeclares in interface FMethod
Returns:
No description provided

sizeOfDeclares

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

Specified by:
sizeOfDeclares in interface FMethod
Returns:
No description provided

getFromDeclares

public UMLClass getFromDeclares(java.lang.String key)
Get the fromDeclares attribute of the UMLMethod object

Parameters:
key - No description provided
Returns:
The fromDeclares value

getFromFDeclares

public FClass getFromFDeclares(java.lang.String key)
Get the fromFDeclares attribute of the UMLMethod object

Specified by:
getFromFDeclares in interface FMethod
Parameters:
key - No description provided
Returns:
The fromFDeclares value
See Also:
FMethod.getFromFDeclares(java.lang.String)

addToDeclares

public boolean addToDeclares(FClass obj)
Access method for an one to n association.

Specified by:
addToDeclares in interface FMethod
Parameters:
obj - The object added.
Returns:
No description provided

removeFromDeclares

public boolean removeFromDeclares(FClass obj)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
removeFromDeclares in interface FMethod
Parameters:
obj - No description provided
Returns:
No description provided

removeKeyFromDeclares

public boolean removeKeyFromDeclares(java.lang.String key)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
removeKeyFromDeclares in interface FMethod
Parameters:
key - No description provided
Returns:
No description provided

removeAllFromDeclares

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

Specified by:
removeAllFromDeclares in interface FMethod

addToDeclares

protected void addToDeclares(KeyValuePair pair)
This method is needed only for loading FTreeMaps, do not use it in other cases.

Parameters:
pair - The object added.

hasInParam

public boolean hasInParam(FParam newParam)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
hasInParam in interface FMethod
Parameters:
newParam - No description provided
Returns:
No description provided

sizeOfParam

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

Specified by:
sizeOfParam in interface FMethod
Returns:
No description provided

iteratorOfParam

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

Specified by:
iteratorOfParam in interface FMethod
Returns:
No description provided

addToParam

public void addToParam(FParam newParam)
Access method for an one to n association.

Specified by:
addToParam in interface FMethod
Parameters:
newParam - The object added.

addToParam

public void addToParam(int index,
                       FParam newParam)
Access method for an one to n association.

Specified by:
addToParam in interface FMethod
Parameters:
index - The object added.
newParam - The object added.

removeFromParam

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

Specified by:
removeFromParam in interface FMethod
Parameters:
newParam - No description provided

removeAllFromParam

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

Specified by:
removeAllFromParam in interface FMethod

getRevSpec

public UMLStartActivity getRevSpec()
Get the revSpec attribute of the UMLMethod object

Returns:
The revSpec value

getFRevSpec

public FElement getFRevSpec()
Get the fRevSpec attribute of the UMLMethod object

Specified by:
getFRevSpec in interface FMethod
Returns:
The fRevSpec value
See Also:
FMethod.getFRevSpec()

setRevSpec

public void setRevSpec(FElement revSpec)
Sets the revSpec attribute of the UMLMethod object

Specified by:
setRevSpec in interface FMethod
Parameters:
revSpec - The new revSpec value

getStoryDiag

public UMLActivityDiagram getStoryDiag()
Get the storyDiag attribute of the UMLMethod object

Returns:
The revSpec value

getFStoryDiagram

public FDiagram getFStoryDiagram()
Get the fStoryDiagram attribute of the UMLMethod object

Specified by:
getFStoryDiagram in interface FMethod
Returns:
The fStoryDiagram value
See Also:
FMethod.getFStoryDiagram()

setStoryDiag

public void setStoryDiag(UMLActivityDiagram storyDiag)
Sets the revSpec attribute of the UMLMethod object

Parameters:
storyDiag - The new storyDiag value

setMethodBody

public void setMethodBody(java.lang.String methodBody)
Sets the methodBody of the UMLMethod

Specified by:
setMethodBody in interface FMethod
Parameters:
methodBody - The new methodBody value

setMethodBody

public void setMethodBody(java.lang.String methodBody,
                          boolean generated)
Sets the methodBody of the UMLMethod

Specified by:
setMethodBody in interface FMethod
Parameters:
methodBody - The new methodBody value
generated - The new methodBody value

getMethodBody

public java.lang.String getMethodBody()
Get the methodBody of the UMLMethod

Specified by:
getMethodBody in interface FMethod
Returns:
The methodBody

setPatternMethodBody

public void setPatternMethodBody(java.lang.String bodyText,
                                 boolean generated)
Deprecated. use setMethodBody(String methodBody) instead

Creates a new body of the method with the given text be sure the methods class is set using setParent !

Specified by:
setPatternMethodBody in interface FMethod
Parameters:
bodyText - the body text
generated - true if the body is auto generated (e.g. from the analyzer engines)

setMethodBodyText

public void setMethodBodyText(java.lang.StringBuffer buf)
Deprecated. use setMethodBody(String methodBody) instead

Sets the methodBodyText attribute of the UMLMethod object

Parameters:
buf - The new methodBodyText value

getMethodBodyText

public java.lang.StringBuffer getMethodBodyText()
Deprecated. use getMethodBody() instead

Get the methodBodyText attribute of the UMLMethod object

Returns:
The methodBodyText value

getASTRootNode

public ASTRootNode getASTRootNode()
Returns the abstract syntax tree (AST) root node of the method If the method body isn't parsed yet, the method body will be parsed.

Specified by:
getASTRootNode in interface FMethod
Returns:
The AST root node

setASTRootNode

public void setASTRootNode(ASTRootNode astRootNode)
Sets the abstract syntax tree (AST) root node of the method

Specified by:
setASTRootNode in interface FMethod
Parameters:
astRootNode - The new AST root node

removeStoryDiagram

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


getStoryDiagram

public UMLActivityDiagram getStoryDiagram()
Get the storyDiagram attribute of the UMLMethod object

Returns:
The storyDiagram value

hasInThrowsTypes

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

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

iteratorOfThrowsTypes

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

Specified by:
iteratorOfThrowsTypes in interface FMethod
Returns:
No description provided

sizeOfThrowsTypes

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

Specified by:
sizeOfThrowsTypes in interface FMethod
Returns:
No description provided

addToThrowsTypes

public boolean addToThrowsTypes(UMLType value)
Access method for an one to n association.

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

removeFromThrowsTypes

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

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

removeAllFromThrowsTypes

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


setCutCopyPasteParent

public void setCutCopyPasteParent(FElement parent)
Hangs the current ASGElement into the ASG-tree. Needed for cut'n'paste.

Specified by:
setCutCopyPasteParent in interface FElement
Overrides:
setCutCopyPasteParent in class ASGElement
Parameters:
parent -

setAccessedAttribute

public boolean setAccessedAttribute(FAttr value)
Sets the accessedAttribute attribute of the UMLMethod object

Specified by:
setAccessedAttribute in interface FMethod
Parameters:
value - The new accessedAttribute value
Returns:
No description provided

getAccessedAttribute

public UMLAttr getAccessedAttribute()
Get the accessedAttribute attribute of the UMLMethod object

Returns:
The accessedAttribute value

getFAccessedAttribute

public FAttr getFAccessedAttribute()
Get the fAccessedAttribute attribute of the UMLMethod object

Specified by:
getFAccessedAttribute in interface FMethod
Returns:
The fAccessedAttribute value

setUMLAction

public boolean setUMLAction(UMLAction value)
Sets the uMLAction attribute of the UMLMethod object

Parameters:
value - The new uMLAction value
Returns:
No description provided

getUMLAction

public UMLAction getUMLAction()
Get the uMLAction attribute of the UMLMethod object

Returns:
The uMLAction value

removeYou

public void removeYou()
Isolates the object so the garbage collector can remove it.

Specified by:
removeYou in interface FElement
Overrides:
removeYou in class UMLDeclaration

getParentElement

public FElement getParentElement()
Query the logical parent of this element (e.g. package of a class, diagram of an object).

Specified by:
getParentElement in interface FElement
Overrides:
getParentElement in class UMLDiagramItem
Returns:
the logical parent of this element;

searchID

public ASGElement searchID(java.lang.String id)
Searches the ASG tree for a given id

Overrides:
searchID in class ASGElement
Parameters:
id - The id to search for.
Returns:
The Element with the given id, null if not found.

createStoryDiagram

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

Returns:
No description provided

iteratorOfOverriddenMethods

public java.util.Iterator iteratorOfOverriddenMethods()
Find all methods in superclasses and -interfaces that have the same signature as this method.

Returns:
iterator through overwritten/implemented methods

iteratorOfOverridingMethods

public java.util.Iterator iteratorOfOverridingMethods()
Find all methods in subclasses and -interfaces that have the same signature as this method.

Returns:
iterator through overwriting/implementing methods

compareTo

public int compareTo(java.lang.Object obj)
No comment provided by developer, please add a comment to improve documentation.

Specified by:
compareTo in interface java.lang.Comparable
Overrides:
compareTo in class BasicIncrement
Parameters:
obj - No description provided
Returns:
No description provided