Package org.elasticsearch.common.logging

Enum Class DeprecationCategory

java.lang.Object

java.lang.Enum<DeprecationCategory>

org.elasticsearch.common.logging.DeprecationCategory

All Implemented Interfaces:

Serializable, Comparable<DeprecationCategory>, Constable

public enum DeprecationCategory
extends Enum<DeprecationCategory>

Deprecation log messages are categorised so that consumers of the logs can easily aggregate them.

When categorising a message, you should consider the impact of the work required to mitigate the deprecation. For example, a settings change would normally be categorised as SETTINGS, but if the setting in question was related to security configuration, it may be more appropriate to categorise the deprecation message as SECURITY.

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
AGGREGATIONS
ANALYSIS
API
INDICES
MAPPINGS
OTHER
PARSING
PLUGINS
QUERIES
SCRIPTING
SECURITY
SETTINGS
TEMPLATES
TYPES

Method Summary

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

AGGREGATIONS

public static final DeprecationCategory AGGREGATIONS

ANALYSIS

public static final DeprecationCategory ANALYSIS

API

public static final DeprecationCategory API

INDICES

public static final DeprecationCategory INDICES

MAPPINGS

public static final DeprecationCategory MAPPINGS

OTHER

public static final DeprecationCategory OTHER

PARSING

public static final DeprecationCategory PARSING

PLUGINS

public static final DeprecationCategory PLUGINS

QUERIES

public static final DeprecationCategory QUERIES

SCRIPTING

public static final DeprecationCategory SCRIPTING

SECURITY

public static final DeprecationCategory SECURITY

SETTINGS

public static final DeprecationCategory SETTINGS

TEMPLATES

public static final DeprecationCategory TEMPLATES

TYPES

public static final DeprecationCategory TYPES

Method Details

values

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