IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.core
Class AbstractParameterArgument

java.lang.Object
  extended bycom.ibm.xtools.patterns.core.AbstractParameterArgument
Direct Known Subclasses:
ParameterArgument, PatternParameterValue

public abstract class AbstractParameterArgument
extends Object

Represents an argument value supplied for a parameter (IParameterDescriptor) of a particular pattern.

Use the Pair method to retrieve the argument pairs used when constructing relationships and other composite objects as parameter arguments. Use the getMetaType method to retrieve the metatype of the object supplied as the argument for the parameter.

Concrete classes that extend the AbstractParameterArgument class must implement equals and hashCode to ensure correct semantics for equality of parameter arguments.


Nested Class Summary
 class AbstractParameterArgument.Pair
          Retrieves a pairing of parameter arguments.
 
Constructor Summary
AbstractParameterArgument()
           
 
Method Summary
abstract  String getImage()
          Retrieves a readable image of the object supplied as the argument for the parameter.
abstract  IPatternMetatype getMetatype()
          Retrieves the metatype of the object supplied as the argument for the parameter.
abstract  Object getValue()
          Retrieves the object supplied as the argument for the parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractParameterArgument

public AbstractParameterArgument()
Method Detail

getValue

public abstract Object getValue()

Retrieves the object supplied as the argument for the parameter.

Use the getMetaType method to retrieve the metatype of the object.

Returns:
Returns the object supplied as the argument for the parameter.

getMetatype

public abstract IPatternMetatype getMetatype()

Retrieves the metatype of the object supplied as the argument for the parameter.

Use the isValidArgumentType method to retrieve whether the object of a specific metatype is accepted as an argument of the parameter.

Returns:
Returns the metatype of the object supplied as the argument for the parameter.

getImage

public abstract String getImage()

Retrieves a readable image of the object supplied as the argument for the parameter.

Returns:
Returns the image of the object supplied as the argument for the parameter.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.