org.springframework.boot.actuate.endpoint

Enum EndpointExposure

java.lang.Object

java.lang.Enum<EndpointExposure>

org.springframework.boot.actuate.endpoint.EndpointExposure

All Implemented Interfaces:

Serializable, Comparable<EndpointExposure>

public enum EndpointExposure
extends Enum<EndpointExposure>

An enumeration of the available exposure technologies for an endpoint.

Since:

2.0.0

Author:

Stephane Nicoll

Enum Constant Summary

Enum Constants

Enum Constant and Description
JMX Expose the endpoint as a JMX MBean.
WEB Expose the endpoint as a Web endpoint.

Method Summary

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

JMX

public static final EndpointExposure JMX

Expose the endpoint as a JMX MBean.

WEB

public static final EndpointExposure WEB

Expose the endpoint as a Web endpoint.

Method Detail

values

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

Returns:

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

valueOf

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

isEnabledByDefault

public boolean isEnabledByDefault()