Package org.elasticsearch.common.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 DeprecationHandler THROW_UNSUPPORTED_OPERATION
    Throws an UnsupportedOperationException when parsing hits a deprecated field.

  • Method Summary

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

  • 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.

  • Method Details

    • usedDeprecatedName

      void usedDeprecatedName​(java.lang.String usedName, java.lang.String modernName)
      Called when the provided field name matches a deprecated name for the field.
      Parameters:
      usedName - the provided field name
      modernName - the modern name for the field

    • usedDeprecatedField

      void usedDeprecatedField​(java.lang.String usedName, java.lang.String replacedWith)
      Called when the provided field name matches the current field but the entire field has been marked as deprecated.
      Parameters:
      usedName - the provided field name
      replacedWith - the name of the field that replaced this field