Package org.elasticsearch.common.xcontent

Class LoggingDeprecationHandler

java.lang.Object

org.elasticsearch.common.xcontent.LoggingDeprecationHandler

All Implemented Interfaces:

DeprecationHandler

public class LoggingDeprecationHandler
extends Object
implements DeprecationHandler

Logs deprecations to the DeprecationLogger.

This is core's primary implementation of DeprecationHandler and should absolutely be used everywhere where it parses requests. It is much less appropriate when parsing responses from external sources because it will report deprecated fields back to the user as though the user sent them.

Field Summary

Fields

Modifier and Type	Field	Description
static LoggingDeprecationHandler	INSTANCE

Fields inherited from interface org.elasticsearch.common.xcontent.DeprecationHandler

THROW_UNSUPPORTED_OPERATION

Method Summary

Modifier and Type	Method	Description
void	usedDeprecatedField(String usedName, String replacedWith)	Called when the provided field name matches the current field but the entire field has been marked as deprecated.
void	usedDeprecatedName(String usedName, String modernName)	Called when the provided field name matches a deprecated name for the field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static LoggingDeprecationHandler INSTANCE

Method Detail

usedDeprecatedName

public void usedDeprecatedName(String usedName,
                               String modernName)

Description copied from interface: DeprecationHandler

Called when the provided field name matches a deprecated name for the field.

Specified by:

usedDeprecatedName in interface DeprecationHandler

Parameters:

usedName - the provided field name

modernName - the modern name for the field

usedDeprecatedField

public void usedDeprecatedField(String usedName,
                                String replacedWith)

Description copied from interface: DeprecationHandler

Called when the provided field name matches the current field but the entire field has been marked as deprecated.

Specified by:

usedDeprecatedField in interface DeprecationHandler

Parameters:

usedName - the provided field name

replacedWith - the name of the field that replaced this field