Package org.springframework.modulith.events.support

Enum Class CompletionMode

java.lang.Object

java.lang.Enum<CompletionMode>

org.springframework.modulith.events.support.CompletionMode

All Implemented Interfaces:

Serializable, Comparable<CompletionMode>, Constable

public enum CompletionMode
extends Enum<CompletionMode>

Different modes of event completion.

Since:

1.3

Author:

Oliver Drotbohm

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
ARCHIVE	Completes an EventPublication by moving the database entry to an archive.
DELETE	Completes an EventPublication by removing the database entry.
UPDATE	Completes an EventPublication by setting its completion date and updating the database entry accordingly.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY

Method Summary

Modifier and Type	Method	Description
static CompletionMode	from(Environment environment)	Looks up the CompletionMode from the given environment or uses UPDATE as default.
static CompletionMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompletionMode[]	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

UPDATE

public static final CompletionMode UPDATE

Completes an EventPublication by setting its completion date and updating the database entry accordingly.

DELETE

public static final CompletionMode DELETE

Completes an EventPublication by removing the database entry.

ARCHIVE

public static final CompletionMode ARCHIVE

Completes an EventPublication by moving the database entry to an archive.

Field Details

PROPERTY

public static final String PROPERTY

See Also:

• Constant Field Values

Method Details

values

public static CompletionMode[] 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 CompletionMode 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

from

public static CompletionMode from(Environment environment)

Looks up the CompletionMode from the given environment or uses UPDATE as default.

Parameters:

environment - must not be null.

Returns:

will never be null.