org.springframework.boot.web.server

Enum GracefulShutdownResult

java.lang.Object

java.lang.Enum<GracefulShutdownResult>

org.springframework.boot.web.server.GracefulShutdownResult

All Implemented Interfaces:

Serializable, Comparable<GracefulShutdownResult>

public enum GracefulShutdownResult
extends Enum<GracefulShutdownResult>

The result of a graceful shutdown request.

Since:

2.3.0

Author:

Andy Wilkinson

See Also:

GracefulShutdownCallback, WebServer.shutDownGracefully(GracefulShutdownCallback)

Enum Constant Summary

Enum Constants

Enum Constant and Description
IDLE The server was idle with no active requests at the end of the grace period.
IMMEDIATE The server was shutdown immediately, ignoring any active requests.
REQUESTS_ACTIVE Requests remained active at the end of the grace period.

Method Summary

Modifier and Type	Method and Description
static GracefulShutdownResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static GracefulShutdownResult[]	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

REQUESTS_ACTIVE

public static final GracefulShutdownResult REQUESTS_ACTIVE

Requests remained active at the end of the grace period.

IDLE

public static final GracefulShutdownResult IDLE

The server was idle with no active requests at the end of the grace period.

IMMEDIATE

public static final GracefulShutdownResult IMMEDIATE

The server was shutdown immediately, ignoring any active requests.

Method Detail

values

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

Returns:

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

valueOf

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