cz.cuni.amis.pogamut.sposh.engine
Enum FireResult.Type

java.lang.Object
  java.lang.Enum<FireResult.Type>
      cz.cuni.amis.pogamut.sposh.engine.FireResult.Type

All Implemented Interfaces:

Serializable, Comparable<FireResult.Type>

Enclosing class:

FireResult

public static enum FireResult.Type
extends Enum<FireResult.Type>

Value returned by the executor of an element on the stack, it determines how should drive stack be modified.

Enum Constant Summary

CONTINUE
Element wasn't yet finished.

FAILED
The element is finished and it failed.

FOLLOW
Some child element is supposed to be evaluated.

FULFILLED
The element is finished and result is success.

SURFACE
Well, not many will use this I suppose, but move up in the stack, something like return from function.

SURFACE_CONTINUE
E.g.

Method Summary

static FireResult.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static FireResult.Type[]	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

FULFILLED

public static final FireResult.Type FULFILLED

The element is finished and result is success.

FAILED

public static final FireResult.Type FAILED

The element is finished and it failed.

CONTINUE

public static final FireResult.Type CONTINUE

Element wasn't yet finished.

FOLLOW

public static final FireResult.Type FOLLOW

Some child element is supposed to be evaluated.

SURFACE

public static final FireResult.Type SURFACE

Well, not many will use this I suppose, but move up in the stack, something like return from function. This is the only type that causes the sposh logic controller to stop iterating. If PoshEngine.evaluatePlan(cz.cuni.amis.pogamut.sposh.executor.IWorkExecutor) returns any other value, the sposh logic controller will call another round of PoshEngine.evaluatePlan(cz.cuni.amis.pogamut.sposh.executor.IWorkExecutor)

SURFACE_CONTINUE

public static final FireResult.Type SURFACE_CONTINUE

E.g. surface (pop element on the stack), but also indicates that execution should continue.

Method Detail

values

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

Returns:

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

valueOf

public static FireResult.Type valueOf(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:

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

NullPointerException - if the argument is null