Package org.springframework.boot.docker.compose.lifecycle

Enum Class ShutdownCommand

java.lang.Object

java.lang.Enum<ShutdownCommand>

org.springframework.boot.docker.compose.lifecycle.ShutdownCommand

All Implemented Interfaces:

Serializable, Comparable<ShutdownCommand>, Constable

public enum ShutdownCommand
extends Enum<ShutdownCommand>

Command used to shutdown docker compose.

Since:

3.1.0

Author:

Moritz Halbritter, Andy Wilkinson, Phillip Webb

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
DOWN	Shutdown using docker compose down.
STOP	Shutdown using docker compose stop.

Method Summary

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

DOWN

public static final ShutdownCommand DOWN

Shutdown using docker compose down.

STOP

public static final ShutdownCommand STOP

Shutdown using docker compose stop.

Method Details

values

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