org.processmining.plugins.declare.visualizing

Enum State

java.lang.Object

java.lang.Enum<State>

org.processmining.plugins.declare.visualizing.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<State>

public enum State
extends java.lang.Enum<State>

This class represents possible states of constraints during execution of instances of constraint models. Constraint state is SATISFIED if the constraint is fulfilled (true). Constraint state is VIOLATED_TEMPORARY if the constraint is currently not fulfilled (false), but it is possible to bring the constraint to state SATISFIED in the future. Constraint state is VIOLATED if the constraint is currently not fulfilled (false) and it is not possible to bring the constraint to state SATISFIED in the future.

Author:

mpesic

Enum Constant Summary

Enum Constants

Enum Constant and Description
SATISFIED
VIOLATED
VIOLATED_TEMPORARY

Method Summary

Modifier and Type	Method and Description
static State	getDefault() Returns the default state, i.e., the state which should be assigned to constraints by default.
java.lang.String	getDescription() Provides the textual description of the state.
static State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static State[]	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

SATISFIED

public static final State SATISFIED

VIOLATED_TEMPORARY

public static final State VIOLATED_TEMPORARY

VIOLATED

public static final State VIOLATED

Method Detail

values

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

Returns:

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

valueOf

public static State 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

getDefault

public static State getDefault()

Returns the default state, i.e., the state which should be assigned to constraints by default. This method is used when the state cannot be determined via available techniques.

Returns:

VIOLATED

getDescription

public java.lang.String getDescription()

Provides the textual description of the state.

Returns:

description