ptolemy.actor.gt

Enum IterativeParameter.Mode

java.lang.Object

java.lang.Enum<IterativeParameter.Mode>

ptolemy.actor.gt.IterativeParameter.Mode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IterativeParameter.Mode>

Enclosing class:

IterativeParameter

public static enum IterativeParameter.Mode
extends java.lang.Enum<IterativeParameter.Mode>

The modes of this parameter.

Since:

Ptolemy II 8.0

Version:

$Id$

Author:

Thomas Huining Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Yellow (tfeng)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_VALUES Try all values (until constraint is violated).
STOP_WHEN_MATCH Once a match is found, stop returning more values.
STOP_WHEN_NOT_MATCH Once a match is not found, stop returning more values.

Method Summary

Modifier and Type	Method and Description
static IterativeParameter.Mode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IterativeParameter.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALL_VALUES

public static final IterativeParameter.Mode ALL_VALUES

Try all values (until constraint is violated).

STOP_WHEN_MATCH

public static final IterativeParameter.Mode STOP_WHEN_MATCH

Once a match is found, stop returning more values.

STOP_WHEN_NOT_MATCH

public static final IterativeParameter.Mode STOP_WHEN_NOT_MATCH

Once a match is not found, stop returning more values.

Method Detail

values

public static IterativeParameter.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IterativeParameter.Mode c : IterativeParameter.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IterativeParameter.Mode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null