com.uber.rave

Class Rave

java.lang.Object

com.uber.rave.Rave

public class Rave
extends java.lang.Object

The main entry point for Rave validation.

     To use Rave in your library create add the following class to some package in your library.
     
          public final class MyFactory implements ValidatorFactory {
             public BaseValidator generateValidator() {
                   return new MyFactory_Generated_Validator();
             }
          }
     
     You can replace MyFactory with an class name like. However we recommend [whatever]Factory as a convention.
 

Then, example usage: Rave.getInstance().validate(myModelObject);

Constructor Summary

Constructors

Constructor and Description
Rave()

Method Summary

Modifier and Type	Method and Description
static Rave	getInstance() Get an instance of RAVE validator.
void	validate(java.lang.Object object) Validate an object.
void	validateIgnoreUnsupported(java.lang.Object object) Validate an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rave

public Rave()

Method Detail

getInstance

public static Rave getInstance()

Get an instance of RAVE validator.

Returns:

the singleton instance of the RAVE validator.

validate

public void validate(java.lang.Object object)
              throws RaveException

Validate an object.

Parameters:

object - the object to be validated.

Throws:

RaveException - if validation fails.

validateIgnoreUnsupported

public void validateIgnoreUnsupported(java.lang.Object object)
                               throws InvalidModelException

Validate an object. If the object is not supported, nothing will happen. Otherwise the object will be routed to the correct sub-validator which knows how to validate it.

Parameters:

object - the object to be validated.

Throws:

InvalidModelException - if validation fails.