org.elasticsearch.common

Class ParseField

java.lang.Object

org.elasticsearch.common.ParseField

public class ParseField
extends java.lang.Object

Holds a field that can be found in a request while parsing and its different variants, which may be deprecated.

Constructor Summary

Constructors

Constructor and Description
ParseField(java.lang.String name, java.lang.String... deprecatedNames)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAllNamesIncludedDeprecated()
java.lang.String	getAllReplacedWith()
java.lang.String[]	getDeprecatedNames()
java.lang.String	getPreferredName()
java.lang.String	toString()
ParseField	withAllDeprecated(java.lang.String allReplacedWith) Return a new ParseField where all field names are deprecated and replaced with allReplacedWith.
ParseField	withDeprecation(java.lang.String... deprecatedNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParseField

public ParseField(java.lang.String name,
                  java.lang.String... deprecatedNames)

Method Detail

getPreferredName

public java.lang.String getPreferredName()

getAllNamesIncludedDeprecated

public java.lang.String[] getAllNamesIncludedDeprecated()

withDeprecation

public ParseField withDeprecation(java.lang.String... deprecatedNames)

withAllDeprecated

public ParseField withAllDeprecated(java.lang.String allReplacedWith)

Return a new ParseField where all field names are deprecated and replaced with allReplacedWith.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAllReplacedWith

public java.lang.String getAllReplacedWith()

getDeprecatedNames

public java.lang.String[] getDeprecatedNames()