com.yahoo.bullet.common

Class Validator.Entry

java.lang.Object

com.yahoo.bullet.common.Validator.Entry

Enclosing class:

Validator

public static class Validator.Entry
extends Object

This represents a field in the Validator. It applies a Predicate to the value of the field and uses a default value (see defaultTo(Object) if the predicate fails. It can also apply an arbitrary conversion using castTo(Function). These are all applied when you call normalize(BulletConfig) with a BulletConfig containing a field that matches the Entry. You can also ask that the check cause a failure using orFail().

Method Summary

Modifier and Type	Method and Description
Validator.Entry	castTo(Function<Object,Object> adapter) Apply a cast to the value in the BulletConfig after validation and defaults are applied.
Validator.Entry	checkIf(Predicate<Object> validator) Add a Predicate to check for the field represented by the entry.
Validator.Entry	defaultTo(Object defaultValue) Use a default value for the field represented by this Entry.
Object	getDefaultValue() Get the defaultValue in the Entry after applying the cast, if present.
Validator.Entry	orFail() Fail if this entry fails to hold.
Validator.Entry	unless(Predicate<Object> guard) Add a Predicate to guard the checks in this entry.

Methods inherited from class java.lang.Object

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

Method Detail

unless

public Validator.Entry unless(Predicate<Object> guard)

Add a Predicate to guard the checks in this entry. This predicate should take the value of the field and return true if you do not want to run the checks added to the entry. This will also not default to the provided defaults.

Parameters:

guard - The non-null guard to use for this Entry.

Returns:

This Entry for chaining.

checkIf

public Validator.Entry checkIf(Predicate<Object> validator)

Add a Predicate to check for the field represented by the entry. This predicate should take the value of the field and return true to represent a successful validation and false otherwise. You can add more checks by repeatedly calling this method. All your predicates added so far will be ANDed to the latest check.

Parameters:

validator - The non-null validator to use for this Entry.

Returns:

This Entry for chaining.

orFail

public Validator.Entry orFail()

Fail if this entry fails to hold.

Returns:

This Entry for chaining.

defaultTo

public Validator.Entry defaultTo(Object defaultValue)

Use a default value for the field represented by this Entry. This is used if the validation fails. Note that the castTo(Function) will be applied to this if present.

Parameters:

defaultValue - The value to use for the field in the BulletConfig if validation fails.

Returns:

This Entry for chaining.

castTo

public Validator.Entry castTo(Function<Object,Object> adapter)

Apply a cast to the value in the BulletConfig after validation and defaults are applied. Use this to convert values in the config to their final types if you find yourself type-casting or checking for their types repeatedly.

Parameters:

adapter - The function that takes the field (or the default value) represented and converts it to another.

Returns:

This Entry for chaining.

getDefaultValue

public Object getDefaultValue()

Get the defaultValue in the Entry after applying the cast, if present.

Returns:

The defaultValue after any casts.