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

Enum Class LifecycleManagement

java.lang.Object

java.lang.Enum<LifecycleManagement>

org.springframework.boot.docker.compose.lifecycle.LifecycleManagement

All Implemented Interfaces:

Serializable, Comparable<LifecycleManagement>, Constable

public enum LifecycleManagement
extends Enum<LifecycleManagement>

Docker Compose lifecycle management.

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
NONE	Don't start or stop Docker Compose.
START_AND_STOP	Start Docker Compose if it's not running and stop it when the JVM exits.
START_ONLY	Start Docker Compose if it's not running.

Method Summary

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

NONE

public static final LifecycleManagement NONE

Don't start or stop Docker Compose.

START_ONLY

public static final LifecycleManagement START_ONLY

Start Docker Compose if it's not running.

START_AND_STOP

public static final LifecycleManagement START_AND_STOP

Start Docker Compose if it's not running and stop it when the JVM exits.

Method Details

values

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