Validator (bullet-core 1.2.3 API)

java.lang.Object
- com.yahoo.bullet.common.Validator

```
public class Validator
extends Object
```
This class validates instances of BulletConfig. Use Validator.Entry to define fields and Validator.Relationship to define relationships between them. It also provides a bunch of useful Predicate and BiPredicate for use in the checks for the entries and relationships and type converting Function for converting types of entries.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Validator.Entry` This represents a field in the Validator.
`static class`	`Validator.Relationship` This represents a binary relationship between two fields in a `BulletConfig`.
`static class`	`Validator.State` This represents a n-ary validation for the config.

Constructor Summary

Constructors
Constructor and Description

Validator()
Default constructor.

Constructors
Constructor and Description
`Validator()` Default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Predicate<Object>`	`and(Predicate<Object>... predicates)` Creates a `Predicate` that is true if and only if all the provided predicates are true and false otherwise.
`static Object`	`asDouble(Object value)` This casts a `Number` Object to an `Double`.
`static Object`	`asFloat(Object value)` This casts a `Number` Object to an `Float`.
`static Object`	`asInt(Object value)` This casts a `Number` Object to an `Integer`.
`static Object`	`asLong(Object value)` This casts a `Number` Object to an `Long`.
`static Object`	`asString(Object value)` This casts an Object to an `String`.
`Validator`	`copy()` Returns a copy of this validator.
`Validator.Entry`	`define(String key)` Creates an instance of the Entry using the name of the field.
`Validator.State`	`evaluate(String description, String... keys)` Create a state with a description for the given fields.
`static Predicate<Object>`	`hasMaximumListSize(int n)` Creates a `Predicate` that checks to see if the given object is a `List` and has at most n items in it.
`static Predicate<Object>`	`hasMinimumListSize(int n)` Creates a `Predicate` that checks to see if the given object is a `List` and has at least n items in it.
`static BiPredicate<Object,Object>`	`ifTrueThenCheck(Predicate<Object> predicate)` Returns a `BiPredicate` that checks to see if the first boolean argument implies the second `Predicate`.
`static BiPredicate<Object,Object>`	`isAtleastNTimes(double n)` Returns a `BiPredicate` that checks to see if the first argument is at least the given times more than the second.
`static boolean`	`isBoolean(Object value)` Checks to see if the value is a `Boolean`.
`static boolean`	`isClassName(Object value)` Checks to see if the given object refers to a class name that can be loaded.
`static boolean`	`isFalse(Object value)` Checks to see if the value is false or not.
`static boolean`	`isFloat(Object value)` Checks to see if the value is an floating-point.
`static boolean`	`isGreaterOrEqual(Object first, Object second)` Checks to see if the first numeric object is greater than or equal to the second numeric object.
`static boolean`	`isImplied(Object first, Object second)` Checks to see if the first boolean object implies the second boolean object.
`static BiPredicate<Object,Object>`	`isImpliedBy(Predicate<Object> firstTest, Predicate<Object> secondTest)` Returns a `BiPredicate` that checks to see if the first `Predicate` implies the second.
`static <T> Predicate<Object>`	`isIn(T... values)` Creates a `Predicate` that checks to see if the given object is in the list of values.
`static <T extends Number> Predicate<Object>`	`isInRange(T min, T max)` Creates a `Predicate` that checks to see if the given object is a `Number` in the proper range.
`static boolean`	`isInt(Object value)` Checks to see if the value is an integer type.
`static boolean`	`isList(Object value)` Checks to see if the value is a `List`.
`static <T> Predicate<Object>`	`isListOfType(Class<T> type)` Creates a `Predicate` that checks to see if the given object is a non-empty `List` of the given type.
`static boolean`	`isMap(Object value)` Checks to see if the value is a `Map`.
`static <K,V> Predicate<Object>`	`isMapOfType(Class<K> keyType, Class<V> valueType)` Checks to see if the value is a `Map` of the given key and value type.
`static boolean`	`isNonEmptyList(Object value)` Checks to see if the value is a non-empty `List`.
`static boolean`	`isNonEmptyMap(Object value)` Checks to see if the value is a non-empty `Map`.
`static boolean`	`isNotNull(Object value)` Checks to see if the value is null or not.
`static boolean`	`isNull(Object value)` Checks to see if the value is null or not.
`static boolean`	`isNumber(Object value)` Checks to see if the value is a `Number`.
`static boolean`	`isPositive(Object value)` Checks to see if the value was positive.
`static boolean`	`isPositiveInt(Object value)` Checks to see if the value was a positive integer (`Integer` or `Long`).
`static boolean`	`isPowerOfTwo(Object value)` Checks to see if the value was a positive integer (`Integer` or `Long`) and a power of 2.
`static boolean`	`isString(Object value)` Checks to see if the value is a `String`.
`static boolean`	`isTrue(Object value)` Checks to see if the value is true or not.
`static boolean`	`isType(Object value, Class clazz)` Checks to see if the value is of the provided type or not.
`static Predicate<Object>`	`not(Predicate<Object> predicate)` Creates a `Predicate` that is true if the given predicate is false and false if the given predicate is true.
`static Predicate<Object>`	`or(Predicate<Object>... predicates)` Creates a `Predicate` that is true if any of the provided predicates are true and false otherwise.
`Validator.Relationship`	`relate(String description, String keyA, String keyB)` Create a relationship with a description for it for the given fields.
`void`	`validate(BulletConfig config)` Validate and normalize the provided `BulletConfig` for the defined entries and relationships.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Validator
```
public Validator()
```
    Default constructor.
- Method Detail
  - define
```
public Validator.Entry define(String key)
```
    Creates an instance of the Entry using the name of the field. This field by default will pass the Predicate unless you add a check using Validator.Entry.checkIf(Predicate).
    
    Parameters:
    
    key - The name of the field.
    
    Returns:
    
    The created Validator.Entry.
  - relate
```
public Validator.Relationship relate(String description,
                                     String keyA,
                                     String keyB)
```
    Create a relationship with a description for it for the given fields. By default, the relationship will hold true unless you provide a custom check using Validator.Relationship.checkIf(BiPredicate). By default, if the relationship fails to hold, the defaults defined by the Entries for these fields will be used unless you provide new ones using Validator.Relationship.orElseUse(Object, Object).
    
    Parameters:
    
    description - A string description of this relationship.
    
    keyA - The first field in the relationship.
    
    keyB - The second field in the relationship.
    
    Returns:
    
    The created Validator.Relationship.
  - evaluate
```
public Validator.State evaluate(String description,
                                String... keys)
```
    Create a state with a description for the given fields. This lets you validate values for as many fields as you want. By default, the state check will hold true unless you provide one with Validator.State.checkIf(Predicate), which provides you the values for the fields you are defining this for. Unless you ask the the check to fail with Validator.State.orFail(), it will use the defaults for each of the entries.
    
    Parameters:
    
    description - A string description for this state validation.
    
    keys - The non-null fields for this state validation. They must already be defined as entries.
    
    Returns:
    
    The create Validator.State.
  - validate
```
public void validate(BulletConfig config)
```
    Validate and normalize the provided BulletConfig for the defined entries and relationships. Then entries are used to validate the config first.
    
    Parameters:
    
    config - The config containing fields to validate.
  - copy
```
public Validator copy()
```
    Returns a copy of this validator. Note that your various functions that you provided to the your entries and relationships in the validator are not deep copied.
    
    Returns:
    
    A copy of this validator with all its defined Validator.Entry and Validator.Relationship.
  - asInt
```
public static Object asInt(Object value)
```
    This casts a Number Object to an Integer.
    
    Parameters:
    
    value - The value to cast.
    
    Returns:
    
    The converted Integer object.
  - asLong
```
public static Object asLong(Object value)
```
    This casts a Number Object to an Long.
    
    Parameters:
    
    value - The value to cast.
    
    Returns:
    
    The converted Long object.
  - asFloat
```
public static Object asFloat(Object value)
```
    This casts a Number Object to an Float.
    
    Parameters:
    
    value - The value to cast.
    
    Returns:
    
    The converted Float object.
  - asDouble
```
public static Object asDouble(Object value)
```
    This casts a Number Object to an Double.
    
    Parameters:
    
    value - The value to cast.
    
    Returns:
    
    The converted Double object.
  - asString
```
public static Object asString(Object value)
```
    This casts an Object to an String.
    
    Parameters:
    
    value - The value to cast.
    
    Returns:
    
    The converted String object.
  - isNotNull
```
public static boolean isNotNull(Object value)
```
    Checks to see if the value is null or not.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was null.
  - isNull
```
public static boolean isNull(Object value)
```
    Checks to see if the value is null or not.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was null.
  - isTrue
```
public static boolean isTrue(Object value)
```
    Checks to see if the value is true or not.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was true.
  - isFalse
```
public static boolean isFalse(Object value)
```
    Checks to see if the value is false or not.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was false.
  - isType
```
public static boolean isType(Object value,
                             Class clazz)
```
    Checks to see if the value is of the provided type or not.
    
    Parameters:
    
    value - The object to check type for.
    
    clazz - The supposed class of the value.
    
    Returns:
    
    A boolean denoting if the value was of the provided class.
  - isBoolean
```
public static boolean isBoolean(Object value)
```
    Checks to see if the value is a Boolean.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was a boolean.
  - isString
```
public static boolean isString(Object value)
```
    Checks to see if the value is a String.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was a String.
  - isList
```
public static boolean isList(Object value)
```
    Checks to see if the value is a List.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was a List.
  - isMap
```
public static boolean isMap(Object value)
```
    Checks to see if the value is a Map.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was a Map.
  - isNumber
```
public static boolean isNumber(Object value)
```
    Checks to see if the value is a Number.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was a Number.
  - isInt
```
public static boolean isInt(Object value)
```
    Checks to see if the value is an integer type. Both Integer and Long qualify.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was an integer.
  - isFloat
```
public static boolean isFloat(Object value)
```
    Checks to see if the value is an floating-point. Both Float and Double qualify.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was a floating-point.
  - isPositive
```
public static boolean isPositive(Object value)
```
    Checks to see if the value was positive.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting whether the given number value was positive.
  - isPositiveInt
```
public static boolean isPositiveInt(Object value)
```
    Checks to see if the value was a positive integer (Integer or Long).
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting whether the given number value was a positive integer type.
  - isPowerOfTwo
```
public static boolean isPowerOfTwo(Object value)
```
    Checks to see if the value was a positive integer (Integer or Long) and a power of 2.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting whether the given number value was a positive, power of 2 integer type.
  - isNonEmptyList
```
public static boolean isNonEmptyList(Object value)
```
    Checks to see if the value is a non-empty List.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was a non-empty list.
  - isNonEmptyMap
```
public static boolean isNonEmptyMap(Object value)
```
    Checks to see if the value is a non-empty Map.
    
    Parameters:
    
    value - The object to check.
    
    Returns:
    
    A boolean denoting if the value was a non-empty map.
  - isClassName
```
public static boolean isClassName(Object value)
```
    Checks to see if the given object refers to a class name that can be loaded.
    
    Parameters:
    
    value - The object to check if it is a class name.
    
    Returns:
    
    A boolean denoting whether the given value was the name of a class.
  - isIn
```
public static <T> Predicate<Object> isIn(T... values)
```
    Creates a Predicate that checks to see if the given object is in the list of values.
    
    Type Parameters:
    
    T - The type of the values and the object.
    
    Parameters:
    
    values - The values that the object could be equal to that is being tested.
    
    Returns:
    
    A predicate that checks to see if the object provided to it is in the given values.
  - hasMinimumListSize
```
public static Predicate<Object> hasMinimumListSize(int n)
```
    Creates a Predicate that checks to see if the given object is a List and has at least n items in it. Note that the object must be a List even if n is 0.
    
    Parameters:
    
    n - The minimum number of items that can be in the List.
    
    Returns:
    
    A boolean denoting if the List has a size of at least the given parameter.
  - hasMaximumListSize
```
public static Predicate<Object> hasMaximumListSize(int n)
```
    Creates a Predicate that checks to see if the given object is a List and has at most n items in it. Note that the object must be a List even if n is 0.
    
    Parameters:
    
    n - The maximum number of items that can be in the List.
    
    Returns:
    
    A boolean denoting if the List has a size of at most the given parameter.
  - isInRange
```
public static <T extends Number> Predicate<Object> isInRange(T min,
                                                             T max)
```
    Creates a Predicate that checks to see if the given object is a Number in the proper range.
    
    Type Parameters:
    
    T - The type of the value, min, and max.
    
    Parameters:
    
    min - The smallest this number value could be.
    
    max - The largest this number value could be.
    
    Returns:
    
    A predicate that checks to see if the provided object is a Number and is in the proper range.
  - isListOfType
```
public static <T> Predicate<Object> isListOfType(Class<T> type)
```
    Creates a Predicate that checks to see if the given object is a non-empty List of the given type.
    
    Type Parameters:
    
    T - The type of the content in the list.
    
    Parameters:
    
    type - The class of the contents of the list to check for.
    
    Returns:
    
    A Predicate that checks tor see if the value was a non-empty list of the given type.
  - isMapOfType
```
public static <K,V> Predicate<Object> isMapOfType(Class<K> keyType,
                                                  Class<V> valueType)
```
    Checks to see if the value is a Map of the given key and value type.
    
    Type Parameters:
    
    K - The type of the key in the map.
    
    V - The type of the value in the map.
    
    Parameters:
    
    keyType - The class of the key of the map to check for.
    
    valueType - The class of the value of the map to check for.
    
    Returns:
    
    A Predicate that checks tor see if the value was a non-empty map of the given types.
  - and
```
@SafeVarargs
public static Predicate<Object> and(Predicate<Object>... predicates)
```
    Creates a Predicate that is true if and only if all the provided predicates are true and false otherwise.
    
    Parameters:
    
    predicates - The predicates to be ANDed.
    
    Returns:
    
    A predicate that is the AND of all the given predicates.
  - or
```
@SafeVarargs
public static Predicate<Object> or(Predicate<Object>... predicates)
```
    Creates a Predicate that is true if any of the provided predicates are true and false otherwise.
    
    Parameters:
    
    predicates - The predicates to be ORed.
    
    Returns:
    
    A predicate that is the OR of all the given predicates.
  - not
```
public static Predicate<Object> not(Predicate<Object> predicate)
```
    Creates a Predicate that is true if the given predicate is false and false if the given predicate is true.
    
    Parameters:
    
    predicate - The predicates to be negated.
    
    Returns:
    
    A predicate that is the NOT of the given predicate.
  - isGreaterOrEqual
```
public static boolean isGreaterOrEqual(Object first,
                                       Object second)
```
    Checks to see if the first numeric object is greater than or equal to the second numeric object.
    
    Parameters:
    
    first - The first numeric object.
    
    second - The second numeric object.
    
    Returns:
    
    A boolean denoting whether the first object is greater or equal to the second.
  - isImplied
```
public static boolean isImplied(Object first,
                                Object second)
```
    Checks to see if the first boolean object implies the second boolean object. In other words, does the first imply the second. If first is true and second is false, this check is false. Otherwise, it is true.
    
    Parameters:
    
    first - The first boolean object.
    
    second - The second boolean object.
    
    Returns:
    
    A boolean denoting whether the second is implied by the first.
  - isAtleastNTimes
```
public static BiPredicate<Object,Object> isAtleastNTimes(double n)
```
    Returns a BiPredicate that checks to see if the first argument is at least the given times more than the second.
    
    Parameters:
    
    n - The number of times the second argument must be smaller than the first.
    
    Returns:
    
    The created BiPredicate.
  - ifTrueThenCheck
```
public static BiPredicate<Object,Object> ifTrueThenCheck(Predicate<Object> predicate)
```
    Returns a BiPredicate that checks to see if the first boolean argument implies the second Predicate. In other words, if the first argument is true and the second argument evaluates to false on the given Predicate, this check is false. Else, it is true.
    
    Parameters:
    
    predicate - The Predicate to test the second argument to the returned BiPredicate with.
    
    Returns:
    
    The created BiPredicate.
  - isImpliedBy
```
public static BiPredicate<Object,Object> isImpliedBy(Predicate<Object> firstTest,
                                                     Predicate<Object> secondTest)
```
    Returns a BiPredicate that checks to see if the first Predicate implies the second. In other words, if the first one evaluates to true on the first object in the BiPredicate and the second evaluates to false on the second object, this check is false. Else, it is true. Analogous to isImplied(Object, Object).
    
    Parameters:
    
    firstTest - The first Predicate.
    
    secondTest - The second Predicate.
    
    Returns:
    
    The created BiPredicate.

Class Validator

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Validator

Method Detail

define

relate

evaluate

validate

copy

asInt

asLong

asFloat

asDouble

asString

isNotNull

isNull

isTrue

isFalse

isType

isBoolean

isString

isList

isMap

isNumber

isInt

isFloat

isPositive

isPositiveInt

isPowerOfTwo

isNonEmptyList

isNonEmptyMap

isClassName

isIn

hasMinimumListSize

hasMaximumListSize

isInRange

isListOfType

isMapOfType

and

or

not

isGreaterOrEqual

isImplied

isAtleastNTimes

ifTrueThenCheck

isImpliedBy