IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.core
Class PatternApplicationRole

java.lang.Object
  extended bycom.ibm.xtools.patterns.core.PatternApplicationRole

public class PatternApplicationRole
extends Object

Represents a typesafe enumeration of constants representing the roles played by objects participating in pattern applications.

Use the getName method to retrieve the list of constants for an enumerated type.


Field Summary
static PatternApplicationRole BOUND_ELEMENT_ROLE
          A constant for the bound element role.
static PatternApplicationRole MODIFIED_ELEMENT_ROLE
          A constant for the modified element role.
static PatternApplicationRole NO_ROLE
          A constant for no role.
static PatternApplicationRole PARAMETER_ARGUMENT_ROLE
          A constant for the parameter argument role.
 
Constructor Summary
protected PatternApplicationRole(String name)
          Constructs a new pattern instance option with the specified name and ordinal.
 
Method Summary
 String getName()
          Retrieves the value of the name instance variable.
 int getOrdinal()
          Retrieves the value of the ordinal instance variable.
static List getValues()
          Retrieves the list of constants for this enumerated type.
 String toString()
          Retrieves a textual representation of this pattern instance option.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NO_ROLE

public static final PatternApplicationRole NO_ROLE
A constant for no role.


BOUND_ELEMENT_ROLE

public static final PatternApplicationRole BOUND_ELEMENT_ROLE
A constant for the bound element role.


PARAMETER_ARGUMENT_ROLE

public static final PatternApplicationRole PARAMETER_ARGUMENT_ROLE
A constant for the parameter argument role.


MODIFIED_ELEMENT_ROLE

public static final PatternApplicationRole MODIFIED_ELEMENT_ROLE
A constant for the modified element role.

Constructor Detail

PatternApplicationRole

protected PatternApplicationRole(String name)
Constructs a new pattern instance option with the specified name and ordinal.

Parameters:
name - The name of the new pattern instance option.
Method Detail

getName

public String getName()
Retrieves the value of the name instance variable.

Returns:
Returns the value of the name instance variable.

getOrdinal

public final int getOrdinal()
Retrieves the value of the ordinal instance variable.

Returns:
Returns the value of the ordinal instance variable.

toString

public String toString()
Retrieves a textual representation of this pattern instance option.

Returns:
Retutns a textual representation of this pattern instance option.
See Also:
Object.toString()

getValues

public static List getValues()
Retrieves the list of constants for this enumerated type.

Returns:
Returns the list of constants for this enumerated type.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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