org.elasticsearch.common

Class ParseFieldMatcher

java.lang.Object

org.elasticsearch.common.ParseFieldMatcher

public class ParseFieldMatcher
extends java.lang.Object

Matcher to use in combination with ParseField while parsing requests. Matches a ParseField against a field name and throw deprecation exception depending on the current value of the PARSE_STRICT setting.

Field Summary

Fields

Modifier and Type	Field and Description
static ParseFieldMatcher	EMPTY
static java.lang.String	PARSE_STRICT
static ParseFieldMatcher	STRICT

Constructor Summary

Constructors

Constructor and Description
ParseFieldMatcher(boolean strict)
ParseFieldMatcher(Settings settings)

Method Summary

Modifier and Type	Method and Description
boolean	isStrict() Should deprecated settings be rejected?
boolean	match(java.lang.String fieldName, ParseField parseField) Matches a ParseField against a field name, and throws deprecation exception depending on the current value of the PARSE_STRICT setting.

Methods inherited from class java.lang.Object

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

Field Detail

PARSE_STRICT

public static final java.lang.String PARSE_STRICT

See Also:

Constant Field Values

EMPTY

public static final ParseFieldMatcher EMPTY

STRICT

public static final ParseFieldMatcher STRICT

Constructor Detail

ParseFieldMatcher

public ParseFieldMatcher(Settings settings)

ParseFieldMatcher

public ParseFieldMatcher(boolean strict)

Method Detail

isStrict

public boolean isStrict()

Should deprecated settings be rejected?

match

public boolean match(java.lang.String fieldName,
                     ParseField parseField)

Matches a ParseField against a field name, and throws deprecation exception depending on the current value of the PARSE_STRICT setting.

Parameters:

fieldName - the field name found in the request while parsing

parseField - the parse field that we are looking for

Returns:

true whenever the parse field that we are looking for was found, false otherwise

Throws:

java.lang.IllegalArgumentException - whenever we are in strict mode and the request contained a deprecated field