Package org.keycloak.expiration.jpa

Enum Class Outcome

java.lang.Object

java.lang.Enum<Outcome>

org.keycloak.expiration.jpa.Outcome

All Implemented Interfaces:

Serializable, Comparable<Outcome>, Constable

public enum Outcome
extends Enum<Outcome>

The outcome of an expiration task execution.

Used by ExpirationListener to report the result of a cleanup run to listeners and metrics.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	The first batch failed.
OK	All batches completed successfully.
PARTIAL	At least one batch completed successfully before a failure occurred.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OK

public static final Outcome OK

All batches completed successfully.

PARTIAL

public static final Outcome PARTIAL

At least one batch completed successfully before a failure occurred. Some expired entries were removed, but the cleanup did not finish.

FAILED

public static final Outcome FAILED

The first batch failed. No expired entries were removed.

Method Details

values

public static Outcome[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Outcome valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null