Package yapion.hierarchy.validators

Class Validator

java.lang.Object

yapion.hierarchy.validators.Validator

public final class Validator
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Validator.ValidationOption

Constructor Summary

Constructors

Constructor	Description
Validator()

Method Summary

Modifier and Type	Method	Description
Validator	add(Validator validator)	Add all ValidatorVariable of another Validator to this Validator.
Validator	add(ValidatorVariable variable)	Add a new ValidatorVariable which will validate a small portion of any YAPIONObject.
Validator	setValidationHook(ValidationHook validationHook)	JavaDoc found under ValidationHook
java.lang.String	toString()
boolean	validate(YAPIONObject yapionObject)	Validate a specified YAPIONObject with the specified ValidatorVariable's given by the user.
static Validator	validator(YAPIONObject yapionObject)	Creates an Validator for the given YAPIONObject with just the Validator.ValidationOption.STRUCTURE.
static Validator	validator(YAPIONObject yapionObject, Validator.ValidationOption... validationOptions)	Creates an Validator for the given YAPIONObject with the Validator.ValidationOption's.

Methods inherited from class java.lang.Object

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

Constructor Detail

Validator

public Validator()

Method Detail

setValidationHook

public Validator setValidationHook(ValidationHook validationHook)

JavaDoc found under ValidationHook

Parameters:

validationHook - the ValidationHook to use

add

public Validator add(ValidatorVariable variable)

Add a new ValidatorVariable which will validate a small portion of any YAPIONObject. This method throws an YAPIONException if the path in the ValidatorVariable is null or the type is null.

Parameters:

variable - the ValidatorVariable to add

add

public Validator add(Validator validator)

Add all ValidatorVariable of another Validator to this Validator.

Parameters:

validator - the Validator to add

validate

public boolean validate(YAPIONObject yapionObject)

Validate a specified YAPIONObject with the specified ValidatorVariable's given by the user.

Parameters:

yapionObject - the YAPIONObject to validate

Returns:

true if the YAPIONObject was valid, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validator

public static Validator validator(YAPIONObject yapionObject)

Creates an Validator for the given YAPIONObject with just the Validator.ValidationOption.STRUCTURE.

Parameters:

yapionObject - the example YAPIONObject

Returns:

the Validator for the given YAPIONObject

validator

public static Validator validator(YAPIONObject yapionObject,
                                  Validator.ValidationOption... validationOptions)

Creates an Validator for the given YAPIONObject with the Validator.ValidationOption's.

Parameters:

yapionObject - the example YAPIONObject

validationOptions - what the validator should validate

Returns:

the Validator for the given YAPIONObject