org.springframework.boot.actuate.endpoint

Enum DefaultEnablement

java.lang.Object

java.lang.Enum<DefaultEnablement>

org.springframework.boot.actuate.endpoint.DefaultEnablement

All Implemented Interfaces:

Serializable, Comparable<DefaultEnablement>

public enum DefaultEnablement
extends Enum<DefaultEnablement>

Enumerate the enablement options for an endpoint.

Since:

2.0.0

Author:

Stephane Nicoll

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED The endpoint is disabled unless explicitly enabled.
ENABLED The endpoint is enabled unless explicitly disabled.
NEUTRAL The endpoint's enablement defaults to the "default" settings.

Method Summary

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

ENABLED

public static final DefaultEnablement ENABLED

The endpoint is enabled unless explicitly disabled.

DISABLED

public static final DefaultEnablement DISABLED

The endpoint is disabled unless explicitly enabled.

NEUTRAL

public static final DefaultEnablement NEUTRAL

The endpoint's enablement defaults to the "default" settings.

Method Detail

values

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

Returns:

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

valueOf

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