org.activiti5.engine.impl.history

Enum HistoryLevel

java.lang.Object

java.lang.Enum<HistoryLevel>

org.activiti5.engine.impl.history.HistoryLevel

All Implemented Interfaces:

Serializable, Comparable<HistoryLevel>

public enum HistoryLevel
extends Enum<HistoryLevel>

Enum that contains all possible history-levels.

Author:

Frederik Heremans

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVITY
AUDIT
FULL
NONE

Method Summary

Modifier and Type	Method and Description
static HistoryLevel	getHistoryLevelForKey(String key)
String	getKey() String representation of this history-level.
boolean	isAtLeast(HistoryLevel level) Checks if the given level is the same as, or higher in order than the level this method is executed on.
static HistoryLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static HistoryLevel[]	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

NONE

public static final HistoryLevel NONE

ACTIVITY

public static final HistoryLevel ACTIVITY

AUDIT

public static final HistoryLevel AUDIT

FULL

public static final HistoryLevel FULL

Method Detail

values

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

Returns:

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

valueOf

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

getHistoryLevelForKey

public static HistoryLevel getHistoryLevelForKey(String key)

Parameters:

key - string representation of level

Returns:

HistoryLevel for the given key

Throws:

ActivitiException - when passed in key doesn't correspond to existing level

getKey

public String getKey()

String representation of this history-level.

isAtLeast

public boolean isAtLeast(HistoryLevel level)

Checks if the given level is the same as, or higher in order than the level this method is executed on.