jadex.bdiv3.model

Enum MProcessableElement.ExcludeMode

java.lang.Object

java.lang.Enum<MProcessableElement.ExcludeMode>

jadex.bdiv3.model.MProcessableElement.ExcludeMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MProcessableElement.ExcludeMode>

Enclosing class:

MProcessableElement

public static enum MProcessableElement.ExcludeMode
extends java.lang.Enum<MProcessableElement.ExcludeMode>

The exclude mode determines when and if a plan is removed from the applicable plans list (APL).

Enum Constant Summary

Enum Constants

Enum Constant and Description
Never The plan is never removed.
WhenFailed The plan is removed after it has been executed once, but only when it exited with an exception.
WhenSucceeded The plan is removed after it has been executed once, but only when it exited without an exception.
WhenTried The plan is removed after it has been executed once, regardless of success or failure or abortion.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	str

Method Summary

Modifier and Type	Method and Description
static MProcessableElement.ExcludeMode	getExcludeMode(java.lang.String name) Convert from string to enum.
java.lang.String	getString() Get the string representation.
static MProcessableElement.ExcludeMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MProcessableElement.ExcludeMode[]	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

Never

public static final MProcessableElement.ExcludeMode Never

The plan is never removed.

WhenTried

public static final MProcessableElement.ExcludeMode WhenTried

The plan is removed after it has been executed once, regardless of success or failure or abortion.

WhenFailed

public static final MProcessableElement.ExcludeMode WhenFailed

The plan is removed after it has been executed once, but only when it exited with an exception.

WhenSucceeded

public static final MProcessableElement.ExcludeMode WhenSucceeded

The plan is removed after it has been executed once, but only when it exited without an exception.

Field Detail

str

protected java.lang.String str

Method Detail

values

public static MProcessableElement.ExcludeMode[] 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 (MProcessableElement.ExcludeMode c : MProcessableElement.ExcludeMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static MProcessableElement.ExcludeMode 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

getString

public java.lang.String getString()

Get the string representation.

Returns:

The string representation.

getExcludeMode

public static MProcessableElement.ExcludeMode getExcludeMode(java.lang.String name)

Convert from string to enum.