Package org.elasticsearch.xcontent

Interface DeprecationHandler

public interface DeprecationHandler

Callback for notifying the creator of the XContentParser that parsing hit a deprecated field.

Field Summary

Fields

Modifier and Type	Field	Description
static final DeprecationHandler	IGNORE_DEPRECATIONS	Ignores all deprecations
static final DeprecationHandler	THROW_UNSUPPORTED_OPERATION	Throws an UnsupportedOperationException when parsing hits a deprecated field.

Method Summary

Modifier and Type	Method	Description
void	logRemovedField(String parserName, Supplier<XContentLocation> location, String removedName)	Called when the provided field name matches the current field but the entire field has been marked as deprecated with no replacement Emits a compatible api warning instead of deprecation warning when isCompatibleDeprecation is true
default void	logRemovedField(String parserName, Supplier<XContentLocation> location, String removedName, boolean isCompatibleDeprecation)
void	logRenamedField(String parserName, Supplier<XContentLocation> location, String oldName, String currentName)	Called when the provided field name matches a deprecated name for the field.
default void	logRenamedField(String parserName, Supplier<XContentLocation> location, String oldName, String currentName, boolean isCompatibleDeprecation)
void	logReplacedField(String parserName, Supplier<XContentLocation> location, String oldName, String replacedName)	Called when the provided field name matches the current field but the entire field has been marked as deprecated and another field should be used
default void	logReplacedField(String parserName, Supplier<XContentLocation> location, String oldName, String replacedName, boolean isCompatibleDeprecation)

Field Details

THROW_UNSUPPORTED_OPERATION

static final DeprecationHandler THROW_UNSUPPORTED_OPERATION

Throws an UnsupportedOperationException when parsing hits a deprecated field. Use this when creating an XContentParser that won't interact with deprecation logic at all or when you want to fail fast when parsing deprecated fields.

IGNORE_DEPRECATIONS

static final DeprecationHandler IGNORE_DEPRECATIONS

Ignores all deprecations

Method Details

logRenamedField

void logRenamedField(String parserName,
 Supplier<XContentLocation> location,
 String oldName,
 String currentName)

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

Parameters:

oldName - the provided field name

currentName - the modern name for the field

logReplacedField

void logReplacedField(String parserName,
 Supplier<XContentLocation> location,
 String oldName,
 String replacedName)

Called when the provided field name matches the current field but the entire field has been marked as deprecated and another field should be used

Parameters:

oldName - the provided field name

replacedName - the name of the field that replaced this field

logRemovedField

void logRemovedField(String parserName,
 Supplier<XContentLocation> location,
 String removedName)

Called when the provided field name matches the current field but the entire field has been marked as deprecated with no replacement Emits a compatible api warning instead of deprecation warning when isCompatibleDeprecation is true

Parameters:

removedName - the provided field name

logRenamedField

default void logRenamedField(String parserName,
 Supplier<XContentLocation> location,
 String oldName,
 String currentName,
 boolean isCompatibleDeprecation)

See Also:

• Emits a compatible api warning instead of deprecation warning when isCompatibleDeprecation is true

logReplacedField

default void logReplacedField(String parserName,
 Supplier<XContentLocation> location,
 String oldName,
 String replacedName,
 boolean isCompatibleDeprecation)

See Also:

• Emits a compatible api warning instead of deprecation warning when isCompatibleDeprecation is true

logRemovedField

default void logRemovedField(String parserName,
 Supplier<XContentLocation> location,
 String removedName,
 boolean isCompatibleDeprecation)

See Also:

• Emits a compatible api warning instead of deprecation warning when isCompatibleDeprecation is true