com.uber.rave

Class BaseValidator

java.lang.Object

com.uber.rave.BaseValidator

public abstract class BaseValidator
extends java.lang.Object

This class should only be used by generated validator classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseValidator.ValidationContext This class encapsulates the validation context from which a validation check is happening.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseValidator()

Method Summary

Modifier and Type	Method and Description
protected void	addSupportedClass(java.lang.Class<?> clazz) Add a supported class to this BaseValidator.
protected static java.util.List<RaveError>	checkFloatRange(BaseValidator.ValidationContext validationContext, double value, double from, double to) Check a double value to be in the correct range.
protected static java.util.List<RaveError>	checkIntDef(BaseValidator.ValidationContext validationContext, int value, boolean flag, int... acceptableValues) Check the value of an input int to see if it matches the acceptable values.
protected static java.util.List<RaveError>	checkIntRange(BaseValidator.ValidationContext validationContext, long value, long from, long to) Checks the input long value is within the bounds of from and to inclusive.
protected static java.util.List<RaveError>	checkLongDef(BaseValidator.ValidationContext validationContext, long value, boolean flag, long... acceptableValues) Check the value of an input long to see if it matches the acceptable values.
protected static java.util.List<RaveError>	checkNullable(java.util.Collection<?> collection, boolean isNullable, BaseValidator.ValidationContext validationContext) Checks to see if the object is null.
protected static <K,V> java.util.List<RaveError>	checkNullable(java.util.Map<K,V> map, boolean isNullable, BaseValidator.ValidationContext validationContext) Checks to see if the map is null.
protected static java.util.List<RaveError>	checkNullable(java.lang.Object obj, boolean isNullable, BaseValidator.ValidationContext validationContext) Checks to see if the object is null.
protected static <T> java.util.List<RaveError>	checkNullable(T[] array, boolean isNullable, BaseValidator.ValidationContext validationContext) Checks to see if the object is null.
protected static java.util.List<RaveError>	checkStringDef(boolean isNullable, BaseValidator.ValidationContext validationContext, java.util.Collection<java.lang.String> values, java.lang.String... acceptableValues) Utility to check if the strings in a Collection of strings match acceptable values.
protected static java.util.List<RaveError>	checkStringDef(boolean isNullable, BaseValidator.ValidationContext validationContext, java.lang.String[] values, java.lang.String... acceptableValues) Utility to check if the strings in a array of strings match acceptable values.
protected static java.util.List<RaveError>	checkStringDef(boolean isNullable, BaseValidator.ValidationContext validationContext, java.lang.String value, java.lang.String... acceptableValues) Utility to check if a string is present in a list of strings.
protected java.util.Set<java.lang.Class<?>>	getSupportedClasses()
protected static BaseValidator.ValidationContext	getValidationContext(java.lang.Class<?> clazz) Return an instance of a BaseValidator.ValidationContext.
protected static java.util.List<RaveError>	isSizeOk(java.util.Collection<?> collection, boolean isNullable, long min, long max, long multiple, BaseValidator.ValidationContext validationContext) Validates a collection.
protected static <K,V> java.util.List<RaveError>	isSizeOk(java.util.Map<K,V> map, boolean isNullable, long min, long max, long multiple, BaseValidator.ValidationContext validationContext) Validate the size of an Map.
protected static java.util.List<RaveError>	isSizeOk(java.lang.String string, boolean isNullable, long min, long max, long multiple, BaseValidator.ValidationContext validationContext) Checks to see if the size of the input string is of a size as denoted by min and max.
protected static <T> java.util.List<RaveError>	isSizeOk(T[] array, boolean isNullable, long min, long max, long multiple, BaseValidator.ValidationContext validationContext) Validate the size of an Array.
protected static java.util.List<RaveError>	mergeErrors(java.util.List<RaveError> e1, java.util.List<RaveError> e2) Takes two RaveError lists and merges them into one.
protected static java.util.List<RaveError>	mustBeFalse(boolean input, BaseValidator.ValidationContext validationContext)
protected static java.util.List<RaveError>	mustBeTrue(boolean input, BaseValidator.ValidationContext validationContext) Verifies the input to be always true.
protected java.util.List<RaveError>	reEvaluateAsSuperType(java.lang.Class<?> clazz, java.lang.Object obj) This class kicks the validate call back up through the RAVE api.
protected void	registerSelf() Register this BaseValidator with the Rave registry.
protected abstract void	validateAs(java.lang.Object obj, java.lang.Class<?> clazz) This method targets the inheritance issue for validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseValidator

protected BaseValidator()

Method Detail

getSupportedClasses

protected final java.util.Set<java.lang.Class<?>> getSupportedClasses()

validateAs

protected abstract void validateAs(java.lang.Object obj,
                                   java.lang.Class<?> clazz)
                            throws RaveException

This method targets the inheritance issue for validation. Objects can have multiple validation classes that are inherited. It allows you to specifically validate an object as an inherited class or interface.

Parameters:

obj - the object to validate

clazz - the class to validate it as.

Throws:

RaveException - if validation fails.

reEvaluateAsSuperType

@Nullable
protected final java.util.List<RaveError> reEvaluateAsSuperType(java.lang.Class<?> clazz,
                                                                          java.lang.Object obj)

This class kicks the validate call back up through the RAVE api. This is because this particular validator may not know how to handle the input class. Using the Rave.validate api allows Rave to correctly route the object to the appropriate validator.

Parameters:

clazz - the class to validate this object as.

obj - the object to validate

Returns:

A list of RaveErrors.

registerSelf

protected final void registerSelf()

Register this BaseValidator with the Rave registry.

addSupportedClass

protected final void addSupportedClass(java.lang.Class<?> clazz)

Add a supported class to this BaseValidator.

Parameters:

clazz - the Class to add.

getValidationContext

protected static BaseValidator.ValidationContext getValidationContext(java.lang.Class<?> clazz)

Return an instance of a BaseValidator.ValidationContext.

Parameters:

clazz - the Class to tie to the BaseValidator.ValidationContext

Returns:

the BaseValidator.ValidationContext

mustBeFalse

@Nullable
protected static java.util.List<RaveError> mustBeFalse(boolean input,
                                                                 BaseValidator.ValidationContext validationContext)

isSizeOk

protected static java.util.List<RaveError> isSizeOk(@Nullable
                                                    java.lang.String string,
                                                    boolean isNullable,
                                                    long min,
                                                    long max,
                                                    long multiple,
                                                    BaseValidator.ValidationContext validationContext)

Checks to see if the size of the input string is of a size as denoted by min and max. Also check the multiple constraint of size.

Parameters:

string - The string to validate.

isNullable - if true than null is a valid value for the input string regardless of min and max.

min - The string must be at least this long.

max - The string must not exceed this length.

multiple - The multiple constraint on the Size. If less than zero it is ignored.

validationContext - The context of the item in the class being validated. This is used in case of an error.

Returns:

List of RaveErrors which list the validation violations. Null otherwise.

isSizeOk

protected static java.util.List<RaveError> isSizeOk(@Nullable
                                                    java.util.Collection<?> collection,
                                                    boolean isNullable,
                                                    long min,
                                                    long max,
                                                    long multiple,
                                                    BaseValidator.ValidationContext validationContext)

Validates a collection.

Parameters:

collection - the collection to validate.

isNullable - if true than null is a valid value for the input string regardless of min and max.

min - The collection must have least this many elements in it.

max - The collection can have at most this many elements in it.

multiple - The multiple constraint on the Size. If less than zero it is ignored.

validationContext - The context of the item in the class being validated. This is used in case of an error.

Returns:

List of RaveErrors which list the validation violations. Null otherwise.

isSizeOk

@Nullable
protected static <T> java.util.List<RaveError> isSizeOk(@Nullable
                                                                  T[] array,
                                                                  boolean isNullable,
                                                                  long min,
                                                                  long max,
                                                                  long multiple,
                                                                  BaseValidator.ValidationContext validationContext)

Validate the size of an Array.

Type Parameters:

T - can be anytype.

Parameters:

array - the array to validate.

isNullable - if true than null is a valid value for the input string regardless of min and max.

min - The Array must have least this many elements in it.

max - The Array can have at most this many elements in it.

multiple - The multiple constraint on the Size. If less than zero it is ignored.

validationContext - The context of the item in the class being validated. This is used in case of an error.

Returns:

List of RaveErrors which list the validation violations. Null otherwise.

isSizeOk

@Nullable
protected static <K,V> java.util.List<RaveError> isSizeOk(@Nullable
                                                                    java.util.Map<K,V> map,
                                                                    boolean isNullable,
                                                                    long min,
                                                                    long max,
                                                                    long multiple,
                                                                    BaseValidator.ValidationContext validationContext)

Validate the size of an Map.

Type Parameters:

K - key type of the map and can be any type.

V - value type of the map and can be any type.

Parameters:

map - the Map to validate.

isNullable - if true than null is a valid value for the input string regardless of min and max.

min - the Array must have least this many elements in it.

max - the Array can have at most this many elements in it.

multiple - the multiple constraint on the Size. If less than zero it is ignored.

validationContext - the context of the item in the class being validated. This is used in case of an error.

Returns:

List of RaveErrors which list the validation violations. Null otherwise.

checkNullable

protected static java.util.List<RaveError> checkNullable(@Nullable
                                                         java.lang.Object obj,
                                                         boolean isNullable,
                                                         BaseValidator.ValidationContext validationContext)

Checks to see if the object is null.

Parameters:

obj - the object to validate.

isNullable - is the object is allowed to be null.

validationContext - The context of the item in the class being validated. This is used in case of an error.

Returns:

a list of of RaveErrors if the object is not allowed to be null. Returns null otherwise.

checkNullable

protected static java.util.List<RaveError> checkNullable(@Nullable
                                                         java.util.Collection<?> collection,
                                                         boolean isNullable,
                                                         BaseValidator.ValidationContext validationContext)

Checks to see if the object is null.

Parameters:

collection - the collection to validate.

isNullable - is the object is allowed to be null.

validationContext - the context of the item in the class being validated. This is used in case of an error.

Returns:

a list of of RaveErrors if the object is not allowed to be null. Returns null otherwise.

checkNullable

protected static <T> java.util.List<RaveError> checkNullable(@Nullable
                                                             T[] array,
                                                             boolean isNullable,
                                                             BaseValidator.ValidationContext validationContext)

Checks to see if the object is null.

Parameters:

array - the array to validate.

isNullable - is the object is allowed to be null.

validationContext - the context of the item in the class being validated. This is used in case of an error.

Returns:

a list of of RaveErrors if the object is not allowed to be null. Returns null otherwise.

checkNullable

protected static <K,V> java.util.List<RaveError> checkNullable(@Nullable
                                                               java.util.Map<K,V> map,
                                                               boolean isNullable,
                                                               BaseValidator.ValidationContext validationContext)

Checks to see if the map is null.

Parameters:

map - the map to validate.

isNullable - is the object is allowed to be null.

validationContext - The context of the item in the class being validated. This is used in case of an error.

Returns:

a list of of RaveErrors if the object is not allowed to be null. Returns null otherwise. This method will also RAVE validate the keys and values of the map if they are RAVE enabled.

mergeErrors

@Nullable
protected static java.util.List<RaveError> mergeErrors(@Nullable
                                                                 java.util.List<RaveError> e1,
                                                                 @Nullable
                                                                 java.util.List<RaveError> e2)

Takes two RaveError lists and merges them into one.

Parameters:

e1 - the first list of RaveErrors

e2 - the second list of RaveErrors

Returns:

the combination of the two or null if both were null.

mustBeTrue

protected static java.util.List<RaveError> mustBeTrue(boolean input,
                                                      BaseValidator.ValidationContext validationContext)

Verifies the input to be always true.

Parameters:

input - the value to validate.

validationContext - The context of the item in the class being validated. This is used in case of an error.

Returns:

null if input is true and a List otherwise.

checkStringDef

protected static java.util.List<RaveError> checkStringDef(boolean isNullable,
                                                          BaseValidator.ValidationContext validationContext,
                                                          @Nullable
                                                          java.lang.String value,
                                                          java.lang.String... acceptableValues)

Utility to check if a string is present in a list of strings. If the string is null then do nothing.

Parameters:

isNullable - if the value is allowed to be null or not.

validationContext - The context of the item in the class being validated. This is used in case of an error.

value - string to look for.

acceptableValues - list of strings to look in.

Returns:

returns an error if string is not present in list. Otherwise returns an empty list.

checkStringDef

protected static java.util.List<RaveError> checkStringDef(boolean isNullable,
                                                          BaseValidator.ValidationContext validationContext,
                                                          @Nullable
                                                          java.util.Collection<java.lang.String> values,
                                                          java.lang.String... acceptableValues)

Utility to check if the strings in a Collection of strings match acceptable values. If the input Collection is null then nothing is done.

Parameters:

isNullable - if the value is allowed to be null or not.

validationContext - The context of the item in the class being validated. This is used in case of an error.

values - a Collection of strings to validate.

acceptableValues - list acceptable values for the input list.

Returns:

returns an error if string is not present in list. Otherwise returns an empty list.

checkStringDef

protected static java.util.List<RaveError> checkStringDef(boolean isNullable,
                                                          BaseValidator.ValidationContext validationContext,
                                                          @Nullable
                                                          java.lang.String[] values,
                                                          java.lang.String... acceptableValues)

Utility to check if the strings in a array of strings match acceptable values. If the input array is null then nothing is done.

Parameters:

isNullable - if the value is allowed to be null or not.

validationContext - The context of the item in the class being validated. This is used in case of an error.

values - a array of strings to validate.

acceptableValues - list acceptable values for the input array.

Returns:

returns an error if string is not present in list. Otherwise returns an empty list.

checkFloatRange

protected static java.util.List<RaveError> checkFloatRange(BaseValidator.ValidationContext validationContext,
                                                           double value,
                                                           double from,
                                                           double to)

Check a double value to be in the correct range. from and to are used as the boundry checks and are inclusive. Note Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY are supported. If used any value is always greater than Double.NEGATIVE_INFINITY and always less than Double.POSITIVE_INFINITY by definition.

Parameters:

validationContext - the BaseValidator.ValidationContext

value - the value to check

from - the lower bound of the check (inclusive)

to - the upper bound of the check (inclusive)

Returns:

the RaveError if the checked value is not within the bounds.

checkIntRange

protected static java.util.List<RaveError> checkIntRange(BaseValidator.ValidationContext validationContext,
                                                         long value,
                                                         long from,
                                                         long to)

Checks the input long value is within the bounds of from and to inclusive.

Parameters:

validationContext - the BaseValidator.ValidationContext

value - the value to check.

from - the lower bound of the check, inclusive.

to - the upper bound of the check, inclusive.

Returns:

the RaveError if the checked value is not within the bounds.

checkIntDef

protected static java.util.List<RaveError> checkIntDef(BaseValidator.ValidationContext validationContext,
                                                       int value,
                                                       boolean flag,
                                                       int... acceptableValues)

Check the value of an input int to see if it matches the acceptable values. This is the check that is run for the IntDef annotation. Note the flag value for this is currently unused but we may add support later.

Parameters:

validationContext - The context of the item in the class being validated. This is used in case of an error.

value - The long value to check.

flag - the is the flag value from IntDef it is currently unsupported.

acceptableValues - the values that the value parameter can take on.

Returns:

an error if value is not present in list of acceptable values. Otherwise returns an empty list.

checkLongDef

protected static java.util.List<RaveError> checkLongDef(BaseValidator.ValidationContext validationContext,
                                                        long value,
                                                        boolean flag,
                                                        long... acceptableValues)

Check the value of an input long to see if it matches the acceptable values. This is the check that is run for the Long annotation. Note the flag value for this is currently unused but we may add support later.

Parameters:

validationContext - The context of the item in the class being validated. This is used in case of an error.

value - The long value to check.

flag - the is the flag value from IntDef it is currently unsupported.

acceptableValues - the values that the value parameter can take on.

Returns:

an error if value is not present in list of acceptable values. Otherwise returns an empty list.