Package org.springframework.boot.web.server

Enum Class Shutdown

java.lang.Object

java.lang.Enum<Shutdown>

org.springframework.boot.web.server.Shutdown

All Implemented Interfaces:

Serializable, Comparable<Shutdown>, Constable

public enum Shutdown
extends Enum<Shutdown>

Configuration for shutting down a WebServer.

Since:

2.3.0

Author:

Andy Wilkinson

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
GRACEFUL	The WebServer should support graceful shutdown, allowing active requests time to complete.
IMMEDIATE	The WebServer should shut down immediately.

Method Summary

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

GRACEFUL

public static final Shutdown GRACEFUL

The WebServer should support graceful shutdown, allowing active requests time to complete.

IMMEDIATE

public static final Shutdown IMMEDIATE

The WebServer should shut down immediately.

Method Details

values

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