de.uni_paderborn.fujaba.metamodel
Interface FMethod

All Superinterfaces:
java.lang.Cloneable, java.lang.Comparable, FDeclaration, FDiagramItem, FElement, FIncrement, 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:
UMLMethod

public interface FMethod
extends FDeclaration

No comment provided by developer, please add a comment to improve documentation.

Version:
$Revision: 1.5 $ $Date: 2005/03/04 16:05:30 $
Author:
$Author: lowende $

Field Summary
static java.lang.String ABSTRACT_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String DECLARES_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String PARAM_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String PARENT_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String RESULT_TYPE_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String STATIC_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
static java.lang.String STORY_DIAGRAM_PROPERTY
          No comment provided by developer, please add a comment to improve documentation.
 
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
 
Method Summary
 boolean addToDeclares(FClass obj)
          Access method for an one to n association.
 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.
 java.util.Iterator entriesOfDeclares()
          No comment provided by developer, please add a comment to improve documentation.
 ASTRootNode getASTRootNode()
          Returns the abstract syntax tree (AST) root node of the method
 FAttr getFAccessedAttribute()
          Deprecated.  
 FClass getFParent()
          Get the parent attribute of the FMethod object
 FType getFResultType()
          Get the resultType attribute of the FMethod object
 FElement getFRevSpec()
          Deprecated.  
 FClass getFromFDeclares(java.lang.String key)
          Get the fromDeclares attribute of the FMethod object
 FDiagram getFStoryDiagram()
          Get the storyDiagram attribute of the FMethod object
 FType getFType()
          Deprecated.  
 java.lang.String getFullMethodName()
          This function assembles the full name of the method out of the name and the signatur.
 java.lang.String getMethodBody()
          Get the methodBody of the UMLMethod
 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 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 FMethod object
 boolean isConstructor()
          Is the method a constructor
 boolean isFinal()
          Deprecated. Use stereotype <>
 boolean isResultTypeIsPointer()
          Deprecated. Use stereotype < >
 boolean isSignal()
          Deprecated. Use stereotype <>
 boolean isStatic()
          Get the static attribute of the FMethod object
 boolean isSynchronized()
          Deprecated. Use stereotype <>
 boolean isUmlNative()
          Deprecated. Use stereotype <>
 java.util.Iterator iteratorOfDeclares()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfParam()
          No comment provided by developer, please add a comment to improve documentation.
 java.util.Iterator iteratorOfThrowsTypes()
          Deprecated.  
 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.
 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 removeKeyFromDeclares(java.lang.String key)
          No comment provided by developer, please add a comment to improve documentation.
 void setAbstract(boolean fAbstract)
          Sets the abstract attribute of the FMethod object
 boolean setAccessedAttribute(FAttr attr)
          Deprecated.  
 void setASTRootNode(ASTRootNode astRootNode)
          Sets the abstract syntax tree (AST) root node of the method
 void setFinal(boolean value)
          Deprecated. Use stereotype <>
 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 setParent(FClass parent)
          Sets the parent attribute of the FMethod object
 void setPatternMethodBody(java.lang.String bodyText, boolean generated)
          Deprecated. use setMethodBody (String methodBody) instead
 void setResultType(FType value)
          Sets the resultType attribute of the FMethod object
 void setResultTypeIsPointer(boolean resultTypeIsPointer)
          Deprecated. Use stereotype < >
 void setRevSpec(FElement startActivity)
          Deprecated.  
 void setStatic(boolean fStatic)
          Sets the static attribute of the FMethod object
 void setUmlSynchronized(boolean newFSynchronized)
          Deprecated. Use stereotype <>
 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()
          Deprecated.  
 
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, 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
 

Field Detail

STATIC_PROPERTY

public static final java.lang.String STATIC_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

ABSTRACT_PROPERTY

public static final java.lang.String ABSTRACT_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

PARENT_PROPERTY

public static final java.lang.String PARENT_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

RESULT_TYPE_PROPERTY

public static final java.lang.String RESULT_TYPE_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

DECLARES_PROPERTY

public static final java.lang.String DECLARES_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

PARAM_PROPERTY

public static final java.lang.String PARAM_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

STORY_DIAGRAM_PROPERTY

public static final java.lang.String STORY_DIAGRAM_PROPERTY
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values
Method Detail

isStatic

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

Returns:
The static value

setStatic

public void setStatic(boolean fStatic)
Sets the static attribute of the FMethod object

Parameters:
fStatic - The new static value

setAbstract

public void setAbstract(boolean fAbstract)
Sets the abstract attribute of the FMethod object

Parameters:
fAbstract - The new abstract value

isAbstract

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

Returns:
The abstract value

getFParent

public FClass getFParent()
Get the parent attribute of the FMethod object

Returns:
The parent value

setParent

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

Parameters:
parent - The new parent value

setResultType

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

Parameters:
value - The new resultType value

getFResultType

public FType getFResultType()
Get the resultType attribute of the FMethod object

Returns:
The resultType value

hasInDeclares

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

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.

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.

Returns:
No description provided

keysOfDeclares

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

Returns:
No description provided

entriesOfDeclares

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

Returns:
No description provided

sizeOfDeclares

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

Returns:
No description provided

getFromFDeclares

public FClass getFromFDeclares(java.lang.String key)
Get the fromDeclares attribute of the FMethod object

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

addToDeclares

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

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.

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.

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.


hasInParam

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

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.

Returns:
No description provided

iteratorOfParam

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

Returns:
No description provided

addToParam

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

Parameters:
newParam - The object added.

addToParam

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

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.

Parameters:
newParam - No description provided

removeAllFromParam

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


getFStoryDiagram

public FDiagram getFStoryDiagram()
Get the storyDiagram attribute of the FMethod object

Returns:
The storyDiagram value

getFullMethodName

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

Returns:
The fullMethodName value

isConstructor

public boolean isConstructor()
Is the method a constructor

Returns:
True, if the method is a constructor

isSignal

public boolean isSignal()
Deprecated. Use stereotype <>

Get the signal attribute of the FMethod object

Returns:
The signal value

isFinal

public boolean isFinal()
Deprecated. Use stereotype <>

Returns:
The final value

setFinal

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

Parameters:
value - The new final value

isUmlNative

public boolean isUmlNative()
Deprecated. Use stereotype <>

Get the umlNative attribute of the FMethod object

Returns:
The umlNative value

isSynchronized

public boolean isSynchronized()
Deprecated. Use stereotype <>

Get the synchronized attribute of the FMethod object

Returns:
The synchronized value

setUmlSynchronized

public void setUmlSynchronized(boolean newFSynchronized)
Deprecated. Use stereotype <>

Sets the umlSynchronized attribute of the FMethod object

Parameters:
newFSynchronized - The new umlSynchronized value

getFType

public FType getFType()
Deprecated.  

Get the uMLType attribute of the FMethod object

Specified by:
getFType in interface FDeclaration
Returns:
The uMLType value

isResultTypeIsPointer

public boolean isResultTypeIsPointer()
Deprecated. Use stereotype < >

Get the value of resultTypeIsPointer.

Returns:
Value of resultTypeIsPointer.

setResultTypeIsPointer

public void setResultTypeIsPointer(boolean resultTypeIsPointer)
Deprecated. Use stereotype < >

Set the value of resultTypeIsPointer.

Parameters:
resultTypeIsPointer - Value to assign to resultTypeIsPointer.

getFRevSpec

public FElement getFRevSpec()
Deprecated.  

Get the revSpec attribute of the FMethod object TODO: Make return type a start activity

Returns:
The revSpec value

setRevSpec

public void setRevSpec(FElement startActivity)
Deprecated.  

Parameters:
startActivity - The new revSpec value

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 !

Parameters:
bodyText - the body text
generated - true if the body is auto generated (e.g. from the analyzer engines)

setMethodBody

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

Parameters:
methodBody - The new methodBody value
generated - The new methodBody value

setMethodBody

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

Parameters:
methodBody - The new methodBody value

getMethodBody

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

Returns:
The methodBody

iteratorOfThrowsTypes

public java.util.Iterator iteratorOfThrowsTypes()
Deprecated.  

No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

sizeOfThrowsTypes

public int sizeOfThrowsTypes()
Deprecated.  

No comment provided by developer, please add a comment to improve documentation.

Returns:
No description provided

getFAccessedAttribute

public FAttr getFAccessedAttribute()
Deprecated.  

Get the accessedAttribute attribute of the FMethod object

Returns:
The accessedAttribute value

setAccessedAttribute

public boolean setAccessedAttribute(FAttr attr)
Deprecated.  

Set the accessedAttribute attribute of the FMethod object

Parameters:
attr - The new accessedAttribute value
Returns:
No description provided

getASTRootNode

public ASTRootNode getASTRootNode()
Returns the abstract syntax tree (AST) root node of the method

Returns:
The AST root node

setASTRootNode

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

Parameters:
astRootNode - The new AST root node