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

Enum Class StartupCommand

java.lang.Object

java.lang.Enum<StartupCommand>

org.springframework.boot.docker.compose.lifecycle.StartupCommand

All Implemented Interfaces:

Serializable, Comparable<StartupCommand>, Constable

public enum StartupCommand
extends Enum<StartupCommand>

Command used to startup 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
START	Startup using docker compose start.
UP	Startup using docker compose up.

Method Summary

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

UP

public static final StartupCommand UP

Startup using docker compose up.

START

public static final StartupCommand START

Startup using docker compose start.

Method Details

values

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