Enum Class ShutdownTrigger

java.lang.Object

java.lang.Enum<ShutdownTrigger>

com.soklet.ShutdownTrigger

All Implemented Interfaces:

Serializable, Comparable<ShutdownTrigger>, Constable

public enum ShutdownTrigger
extends Enum<ShutdownTrigger>

Events that might trigger a Soklet instance to shut down.

Author:

Mark Allen

See Also:

• Soklet.awaitShutdown(ShutdownTrigger...)

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ENTER_KEY	When the user presses 'Enter' in the console.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENTER_KEY

public static final ShutdownTrigger ENTER_KEY

When the user presses 'Enter' in the console.

Method Details

values

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