IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.patterns.core
Class PatternInstanceOption

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

public class PatternInstanceOption
extends Object

Represents a typesafe enumeration of constants representing options for creating pattern instances.

Use the getValues method to retrieve the list of constants for the enumerated type. To retrieve the value of a name instance variable, use the getName method.


Field Summary
static PatternInstanceOption ENABLE_TRACE
          A constant for enabling traceability.
static PatternInstanceOption[] EnableTrace
           
static PatternInstanceOption NO_OPTIONS
          A constant for no options.
static PatternInstanceOption[] NoOptions
           
 
Constructor Summary
protected PatternInstanceOption(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_OPTIONS

public static final PatternInstanceOption NO_OPTIONS
A constant for no options.


NoOptions

public static final PatternInstanceOption[] NoOptions

ENABLE_TRACE

public static final PatternInstanceOption ENABLE_TRACE
A constant for enabling traceability.


EnableTrace

public static final PatternInstanceOption[] EnableTrace
Constructor Detail

PatternInstanceOption

protected PatternInstanceOption(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:
Returns 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:
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.