Skip navigation links
A B C E F G I L M N R S T U V 

A

addSupportedClass(Class<?>) - Method in class com.uber.rave.BaseValidator
Add a supported class to this BaseValidator.

B

BaseValidator - Class in com.uber.rave
This class should only be used by generated validator classes.
BaseValidator() - Constructor for class com.uber.rave.BaseValidator
 
BaseValidator.ValidationContext - Class in com.uber.rave
This class encapsulates the validation context from which a validation check is happening.

C

checkFloatRange(BaseValidator.ValidationContext, double, double, double) - Static method in class com.uber.rave.BaseValidator
Check a double value to be in the correct range.
checkIntDef(BaseValidator.ValidationContext, int, boolean, int...) - Static method in class com.uber.rave.BaseValidator
Check the value of an input int to see if it matches the acceptable values.
checkIntRange(BaseValidator.ValidationContext, long, long, long) - Static method in class com.uber.rave.BaseValidator
Checks the input long value is within the bounds of from and to inclusive.
checkLongDef(BaseValidator.ValidationContext, long, boolean, long...) - Static method in class com.uber.rave.BaseValidator
Check the value of an input long to see if it matches the acceptable values.
checkNullable(Object, boolean, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Checks to see if the object is null.
checkNullable(Collection<?>, boolean, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Checks to see if the object is null.
checkNullable(T[], boolean, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Checks to see if the object is null.
checkNullable(Map<K, V>, boolean, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Checks to see if the map is null.
checkStringDef(boolean, BaseValidator.ValidationContext, String, String...) - Static method in class com.uber.rave.BaseValidator
Utility to check if a string is present in a list of strings.
checkStringDef(boolean, BaseValidator.ValidationContext, Collection<String>, String...) - Static method in class com.uber.rave.BaseValidator
Utility to check if the strings in a Collection of strings match acceptable values.
checkStringDef(boolean, BaseValidator.ValidationContext, String[], String...) - Static method in class com.uber.rave.BaseValidator
Utility to check if the strings in a array of strings match acceptable values.
CLASS_NOT_SUPPORTED_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 
com.uber.rave - package com.uber.rave
A runtime annotation validation engine for Android and Java applications.
com.uber.rave.annotation - package com.uber.rave.annotation
 

E

Excluded - Annotation Type in com.uber.rave.annotation
Apply this annotation to methods that RAVE should not generate validation code for.

F

FLOAT_RANGE_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 

G

generateValidator() - Method in interface com.uber.rave.ValidatorFactory
 
getClassElement() - Method in class com.uber.rave.RaveError
This method returns the description of what element in the class failed validation, for example the method name.
getClazz() - Method in class com.uber.rave.RaveError
 
getErrorMsg() - Method in class com.uber.rave.RaveError
 
getInstance() - Static method in class com.uber.rave.Rave
Get an instance of RAVE validator.
getMessage() - Method in exception com.uber.rave.RaveException
 
getRaveErrorIterator() - Method in exception com.uber.rave.RaveException
This method will return an iterator over the RaveErrors which can be used to view error details or modify the error list.
getSupportedClasses() - Method in class com.uber.rave.BaseValidator
 
getValidationContext(Class<?>) - Static method in class com.uber.rave.BaseValidator
Return an instance of a BaseValidator.ValidationContext.

I

INT_DEF_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 
INT_RANGE_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 
InvalidModelException - Exception in com.uber.rave
This exception is used when objects fail validation.
InvalidModelException(List<RaveError>) - Constructor for exception com.uber.rave.InvalidModelException
 
isSizeOk(String, boolean, long, long, long, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Checks to see if the size of the input string is of a size as denoted by min and max.
isSizeOk(Collection<?>, boolean, long, long, long, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Validates a collection.
isSizeOk(T[], boolean, long, long, long, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Validate the size of an Array.
isSizeOk(Map<K, V>, boolean, long, long, long, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Validate the size of an Map.

L

LONG_DEF_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 

M

mergeErrors(List<RaveError>, List<RaveError>) - Static method in class com.uber.rave.BaseValidator
Takes two RaveError lists and merges them into one.
MUST_BE_FALSE_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 
MUST_BE_TRUE_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 
MustBeFalse - Annotation Type in com.uber.rave.annotation
Annotation to denote that some function must return false.
mustBeFalse(boolean, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
 
MustBeTrue - Annotation Type in com.uber.rave.annotation
Annotation to denote that some function must return false.
mustBeTrue(boolean, BaseValidator.ValidationContext) - Static method in class com.uber.rave.BaseValidator
Verifies the input to be always true.

N

NON_NULL_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 

R

Rave - Class in com.uber.rave
The main entry point for Rave validation.
Rave() - Constructor for class com.uber.rave.Rave
 
RaveError - Class in com.uber.rave
Holds a single Rave error.
RaveError(Class<?>, String, String) - Constructor for class com.uber.rave.RaveError
 
RaveError(BaseValidator.ValidationContext, String) - Constructor for class com.uber.rave.RaveError
 
RaveErrorStrings - Class in com.uber.rave
The error messages produced by validations.
RaveException - Exception in com.uber.rave
The exception thrown when validation fails.
reEvaluateAsSuperType(Class<?>, Object) - Method in class com.uber.rave.BaseValidator
This class kicks the validate call back up through the RAVE api.
registerSelf() - Method in class com.uber.rave.BaseValidator
Register this BaseValidator with the Rave registry.

S

setValidatedItemName(String) - Method in class com.uber.rave.BaseValidator.ValidationContext
The the context name for this BaseValidator.ValidationContext object.
STRING_DEF_ERROR - Static variable in class com.uber.rave.RaveErrorStrings
 

T

toString() - Method in class com.uber.rave.RaveError
 

U

UnsupportedObjectException - Exception in com.uber.rave
This exception is used when an attempt is made to validate an object that is not supported by any of the RAVE generated validator classes.
UnsupportedObjectException(List<RaveError>) - Constructor for exception com.uber.rave.UnsupportedObjectException
 

V

validate(Object) - Method in class com.uber.rave.Rave
Validate an object.
validateAs(Object, Class<?>) - Method in class com.uber.rave.BaseValidator
This method targets the inheritance issue for validation.
Validated - Annotation Type in com.uber.rave.annotation
The annotation to mark some object to be validated by a BaseValidator.
validateIgnoreUnsupported(Object) - Method in class com.uber.rave.Rave
Validate an object.
Validator - Annotation Type in com.uber.rave
Annotation to indicate what assumptions RAVE should make when generating validation code for a ValidatorFactory.
Validator.Mode - Enum in com.uber.rave
Indicates different kinds of modes RAVE can run in.
ValidatorFactory - Interface in com.uber.rave
This class should be extended by one class in each library that uses RAVE.
valueOf(String) - Static method in enum com.uber.rave.Validator.Mode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.uber.rave.Validator.Mode
Returns an array containing the constants of this enum type, in the order they are declared.
A B C E F G I L M N R S T U V 
Skip navigation links