Package org.apache.druid.query.filter

Enum DruidPredicateMatch

java.lang.Object

java.lang.Enum<DruidPredicateMatch>

org.apache.druid.query.filter.DruidPredicateMatch

All Implemented Interfaces:

Serializable, Comparable<DruidPredicateMatch>

public enum DruidPredicateMatch
extends Enum<DruidPredicateMatch>

Three-value logic result for matching values with predicates produced by DruidPredicateFactory

See Also:

DruidObjectPredicate, DruidLongPredicate, DruidFloatPredicate, DruidDoublePredicate

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	Value does not match
TRUE	Value matches
UNKNOWN	Value is unknown to match, for example from a null input to a predicate which does not match null as true or false

Method Summary

Modifier and Type	Method	Description
boolean	matches(boolean includeUnknown)	Convenience method for ValueMatcher and VectorValueMatcher implementations to pass through the 'includeUnknown' parameter to the predicate match result.
static DruidPredicateMatch	of(boolean val)
static DruidPredicateMatch	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DruidPredicateMatch[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FALSE

public static final DruidPredicateMatch FALSE

Value does not match

TRUE

public static final DruidPredicateMatch TRUE

Value matches

UNKNOWN

public static final DruidPredicateMatch UNKNOWN

Value is unknown to match, for example from a null input to a predicate which does not match null as true or false

Method Detail

values

public static DruidPredicateMatch[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DruidPredicateMatch c : DruidPredicateMatch.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DruidPredicateMatch valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

matches

public boolean matches(boolean includeUnknown)

Convenience method for ValueMatcher and VectorValueMatcher implementations to pass through the 'includeUnknown' parameter to the predicate match result.

of

public static DruidPredicateMatch of(boolean val)