com.varra.util

Enum ShutdownMode

java.lang.Object

java.lang.Enum<ShutdownMode>

com.varra.util.ShutdownMode

All Implemented Interfaces:

Serializable, Comparable<ShutdownMode>

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public enum ShutdownMode
extends Enum<ShutdownMode>

/** An Enum that lists shutdown modes. Any Service or Object instance can be shutdown either gracefully or forcibly.

When a Service or Object instance is shutdown gracefully, it can perform some prerequisite operations like notifying another nodes or releasing the connections properly etc...Graceful shutdown may take time.

When a Service or Object instance is shutdown forcibly, it will immediately stop responding to requests and closes all the connections abruptly. This mode is little bit faster.

Version:

3.0

Author:

Rajakrishna V. Reddy

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORCED_SHUTDOWN The Forced_ Shutdown.
GRACEFUL_SHUTDOWN The Graceful_Shutdown.

Method Summary

Modifier and Type	Method and Description
byte	getCode() Gets the code.
String	getDescription() Gets the description.
String	toString()
static ShutdownMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ShutdownMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GRACEFUL_SHUTDOWN

public static final ShutdownMode GRACEFUL_SHUTDOWN

The Graceful_Shutdown.

FORCED_SHUTDOWN

public static final ShutdownMode FORCED_SHUTDOWN

The Forced_ Shutdown.

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public byte getCode()

Gets the code.

Returns:

the code

getDescription

public String getDescription()

Gets the description.

Returns:

the description

toString

public String toString()

Overrides:

toString in class Enum<ShutdownMode>