org.andromda.cartridges.meta.metafacades

Class MethodData

java.lang.Object

org.andromda.cartridges.meta.metafacades.MethodData

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

UMLOperationData

public class MethodData
extends Object
implements Comparable

Since:

10.12.2003

Author:

Matthias Bohlen , Chad Brandon, Cyril Combe

Constructor Summary

Constructors

Constructor and Description
MethodData(String metafacadeNameIn, String visibilityIn, boolean isAbstractIn, String returnTypeNameIn, String nameIn, String documentationIn)

Method Summary

Methods

Modifier and Type	Method and Description
void	addArgument(ArgumentData argument)
void	addException(String typeName)
String	buildCharacteristicKey() Builds a signature which can be used as a key into a map.
String	buildMethodCall() Builds a string representing a call to the method.
String	buildMethodDeclaration(boolean suppressAbstractDeclaration) Builds a string representing a declaration for this method.
int	compareTo(Object object)
Collection<ArgumentData>	getArguments()
String	getDocumentation() Gets the documentation for this method.
Collection<String>	getExceptions()
String	getMetafacadeName() Gets the metafacade name.
String	getName() Gets the name of the method.
String	getReturnTypeName() Gets the name of the return type for this method.
String	getTypedArgumentList() Builds a string representing a comma separated parameter type + name list.
String	getTypedArgumentList(String modifier) Builds a string representing a comma separated parameter type + name list.
String	getVisibility() Gets the visibility of this method.
boolean	isAbstract() Indicates whether or not this method is abstract.
boolean	isReturnTypePresent() Tells if this method returns something.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MethodData

public MethodData(String metafacadeNameIn,
          String visibilityIn,
          boolean isAbstractIn,
          String returnTypeNameIn,
          String nameIn,
          String documentationIn)

Parameters:

metafacadeNameIn -

visibilityIn -

isAbstractIn -

returnTypeNameIn -

nameIn -

documentationIn -

Method Detail

addArgument

public void addArgument(ArgumentData argument)

Parameters:

argument -

getArguments

public Collection<ArgumentData> getArguments()

Returns:

arguments

addException

public void addException(String typeName)

Parameters:

typeName -

getExceptions

public Collection<String> getExceptions()

Returns:

exceptions

getMetafacadeName

public String getMetafacadeName()

Gets the metafacade name.

Returns:

the name of the metafacade

getName

public String getName()

Gets the name of the method.

Returns:

the name.

getReturnTypeName

public String getReturnTypeName()

Gets the name of the return type for this method.

Returns:

the return type name.

buildMethodDeclaration

public String buildMethodDeclaration(boolean suppressAbstractDeclaration)

Builds a string representing a declaration for this method.

Parameters:

suppressAbstractDeclaration - optionally suppress the "abstract" modifier

Returns:

String the declaration

getTypedArgumentList

public String getTypedArgumentList()

Builds a string representing a comma separated parameter type + name list.

Returns:

String the declaration

getTypedArgumentList

public String getTypedArgumentList(String modifier)

Builds a string representing a comma separated parameter type + name list.

Parameters:

modifier - Optional modifier before each parameter

Returns:

String the declaration

buildMethodCall

public String buildMethodCall()

Builds a string representing a call to the method.

Returns:

String how a call would look like

buildCharacteristicKey

public String buildCharacteristicKey()

Builds a signature which can be used as a key into a map. Consists of the methodName, number of arguments, return type, the name and the f.q. types of the arguments.

Returns:

String the key that identifies this method

isAbstract

public boolean isAbstract()

Indicates whether or not this method is abstract.

Returns:

true/false

getVisibility

public String getVisibility()

Gets the visibility of this method.

Returns:

the visibility.

getDocumentation

public String getDocumentation()

Gets the documentation for this method.

Returns:

the documentation.

isReturnTypePresent

public boolean isReturnTypePresent()

Tells if this method returns something.

Returns:

boolean

compareTo

public int compareTo(Object object)

Specified by:

compareTo in interface Comparable

See Also:

Comparable.compareTo(Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()