com.sdicons.json.validator

Class ValidatorBuilder

java.lang.Object

com.sdicons.json.validator.ValidatorBuilder

public class ValidatorBuilder
extends Object

A builder class to create atomic and composite JSON validators. The validators can be constructed manually but it is a much easier job using this builder.

 
 Validator v = vb.range(50, 100);
 p = new JSONParser("55");
 json = p.nextValue();
 v.validate(json);
 
 

Constructor Summary

Constructors

Constructor and Description
ValidatorBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
Validator	and(String ruleName, Validator... validators) Create a named and-combination Andof a series of validators.
Validator	and(Validator... validators) Create an anonymous and-combination And of a series of validators.
Validator	array() Create an anonymous Array validator.
Validator	array(String ruleName) Create a named Array validator.
Validator	bool() Create an anonymous Bool validator.
Validator	bool(String ruleName) Create a named Bool validator.
Validator	complex() Create an anonymus Complex validator to check if a value is an array or an object.
Validator	complex(String ruleName) Create a named Complex validator to check if a value is an array or an object.
Validator	content(String ruleName, Validator rule) Create a named Content validator that puts constraints on the contents of an array or an object.
Validator	content(Validator rule) Create an anonymous Content validator that puts constraints on the contents of an array or an object.
Validator	decimal() Create an anonymous Decimal validator to check if a value contains a decimal.
Validator	decimal(String ruleName) Create a named Decimal validator to check if a value is a decimal.
Validator	enumeration(JSONValue... values) Create an anonymous Enumeration validation rule.
Validator	enumeration(String... values) A convenience method to create a named Enumeration validation using a set of String values.
Validator	enumeration(String ruleName, JSONValue... values) Create a named Enumeration validation rule.
Validator	enumeration(String ruleName, String... values) A convenience method to create a named Enumeration validation using a set of String values.
Validator	falsep() Create an anonymous False validatioin rule that always fails.
Validator	falsep(String ruleName) Create a named False validation rule that always fails.
Validator	getRule(String ruleName) Get a named validator that was previously built using this builder.
Validator	intp() Create an anonymous Int validation rule.
Validator	intp(String ruleName) Create a named Int validation rule.
Validator	length(Integer min, Integer max) Create an anonymous Length validation rule to check the length of an array or a string.
Validator	length(String ruleName, Integer min, Integer max) Create a named Length validator to check the length of an array or a string.
Validator	not(String ruleName, Validator rule) Create a named logical Not validation which flips the result of an inner validation.
Validator	not(Validator rule) Create an anonymous logical Not validation which reverses the result of an inner validation.
Validator	nr() Create an anonymous Nr validator to see if a value is a number.
Validator	nr(String ruleName) Create a named Nr validator to see if a value is a number.
Validator	nullp() Create an anonymous Null checking validator.
Validator	nullp(String ruleName) Create a named Null checking validator.
Validator	object() Create an anonymous Object validator to check if a value is an object
Validator	object(String ruleName) Create a named Object validator to check if a value is an object.
Validator	or(String ruleName, Validator... validators) Create a named composite Or validation.
Validator	or(Validator... validators) Create an anonymous Or validation rule.
Validator	properties(Properties.PropRule... rules) Create an anonymous Properties validator to check the key/value pairs of an object.
Validator	properties(String ruleName, Properties.PropRule... rules) Create a named Properties validator to check the key/value pairs of an object.
static Properties.PropRule	propRule(String propName, Validator rule, boolean optional) Create a Properties.PropRule that is used to build a Properties validator for objects.
Validator	range(Integer min, Integer max) An anonymous Range validator.
Validator	range(String ruleName, Integer min, Integer max) Create a named Range validator.
Validator	ref(String ref) Create an anonymous Ref validator.
Validator	ref(String ruleName, String ref) Create a named Ref validator.
Validator	regexp(String pattern) Create an anonymous Regexp validator to validate strings against regular expressions.
Validator	regexp(String ruleName, String pattern) Create a named Regexp validator to validate strings against regular expressions.
Validator	simple() Create an anonymous Simple validator to check that a value is atomic.
Validator	simple(String ruleName) Create a named Simple validator to check that a value is atomic.
Validator	string() Create an anonymous Str validator to check if a value is a string.
Validator	string(String ruleName) Create a named Str validator to check if a value is a string.
static Switch.SwitchCase	switchcase(Validator rule, JSONValue... values) Create a Switch.SwitchCase that can be used to build a Switch validator.
Validator	switchrule(String ruleName, String discriminator, Switch.SwitchCase... cases) Create a named Switch validator.
Validator	switchrule(String discriminator, Switch.SwitchCase... cases) Create an anonymous Switch validator.
Validator	truep() Create an anonymous True validation rule that always succeeds.
Validator	truep(String ruleName) Create a named True validation rule that always succeeds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatorBuilder

public ValidatorBuilder()

Method Detail

getRule

public Validator getRule(String ruleName)

Get a named validator that was previously built using this builder.

Parameters:

ruleName - The name of the validator rule.

Returns:

The requested validator rule.

bool

public Validator bool()

Create an anonymous Bool validator.

Returns:

A validator that validates boolean values.

bool

public Validator bool(String ruleName)

Create a named Bool validator.

Parameters:

ruleName - The name of the rule you are building.

Returns:

A named validator that validates boolean values.

range

public Validator range(Integer min,
              Integer max)

An anonymous Range validator.

Parameters:

min - The lower bound (inclusive). Value null means that there is no lower boundary.

max - The upper bound (inclusive). Value null means that there is no upper boundary.

Returns:

The range validator.

range

public Validator range(String ruleName,
              Integer min,
              Integer max)

Create a named Range validator.

Parameters:

ruleName - The name of the rule being created.

min - The lower boundary (inclusive). Value null means that there is no lower boundary.

max - The upper bound (inclusive). Value null means that there is no upper boundary.

Returns:

The named validator.

and

public Validator and(String ruleName,
            Validator... validators)

Create a named and-combination Andof a series of validators. The validation process halts when the first failure is encountered.

Parameters:

ruleName - The name of the rule under construction.

validators - The array of validators that will be combined using the and operator.

Returns:

The requested validator.

and

public Validator and(Validator... validators)

Create an anonymous and-combination And of a series of validators. The validation process halts when the first failure is encountered.

Parameters:

validators - The array of validators that will be combined using the and operator.

Returns:

The requested validator.

ref

public Validator ref(String ruleName,
            String ref)

Create a named Ref validator. It creates an alias for another named rule. It is useful to refer to another rule inside a composite validator.

Parameters:

ruleName - The name of the validator under construction.

ref - The name of the rule you are referring to.

Returns:

The new validator.

ref

public Validator ref(String ref)

Create an anonymous Ref validator. It is useful to refer to another rule inside a composite validator.

Parameters:

ref - The name of the rule you are referring to.

Returns:

The new validator.

array

public Validator array(String ruleName)

Create a named Array validator.

Parameters:

ruleName - The name of the rule under construction.

Returns:

The newly created validator.

array

public Validator array()

Create an anonymous Array validator.

Returns:

The newly created validator.

complex

public Validator complex(String ruleName)

Create a named Complex validator to check if a value is an array or an object.

Parameters:

ruleName - The name of the validation rule.

Returns:

The validator.

complex

public Validator complex()

Create an anonymus Complex validator to check if a value is an array or an object.

Returns:

The newly created validator.

content

public Validator content(String ruleName,
                Validator rule)

Create a named Content validator that puts constraints on the contents of an array or an object.

Parameters:

ruleName - The name of the content validation rule.

rule - The validation rule that applies to the elements of the array or object.

Returns:

The new content validator.

content

public Validator content(Validator rule)

Create an anonymous Content validator that puts constraints on the contents of an array or an object.

Parameters:

rule - The validation rule that applies to the elements of the array or object.

Returns:

The new content validator.

decimal

public Validator decimal(String ruleName)

Create a named Decimal validator to check if a value is a decimal.

Parameters:

ruleName - The name of the validation rule.

Returns:

The new validation rule.

decimal

public Validator decimal()

Create an anonymous Decimal validator to check if a value contains a decimal.

Returns:

The new validation rule.

enumeration

public Validator enumeration(String ruleName,
                    JSONValue... values)

Create a named Enumeration validation rule. Check if a value belongs to a predefined set of values.

Parameters:

ruleName - The name of the validation rule.

values - The values of the enumeration.

Returns:

The enumeration validation rule.

enumeration

public Validator enumeration(JSONValue... values)

Create an anonymous Enumeration validation rule. Check if a value belongs to a predefined set of values.

Parameters:

values -

Returns:

The enumeration validation rule.

enumeration

public Validator enumeration(String ruleName,
                    String... values)

A convenience method to create a named Enumeration validation using a set of String values. The elements of the enumeration are JSONValue instances, but this method lets you construct the enumeration using plain Strings.

Parameters:

ruleName - The name of the validation rule.

values - The elements of the enumeration set, they will be converted to JSONString values.

Returns:

The enumeration validation rule.

enumeration

public Validator enumeration(String... values)

A convenience method to create a named Enumeration validation using a set of String values. The elements of the enumeration are JSONValue instances, but this method lets you construct the enumeration using plain Strings.

Parameters:

values - The String values of the enumeration, they will be converted to JSONStrings.

Returns:

The enumeration validation rule.

truep

public Validator truep(String ruleName)

Create a named True validation rule that always succeeds. We need to include this for the logic system to be complete.

Parameters:

ruleName - The name of the validation.

Returns:

The newly created validation rule.

truep

public Validator truep()

Create an anonymous True validation rule that always succeeds. We need to include this for the logic system to be complete.

Returns:

The newly created validation rule.

falsep

public Validator falsep(String ruleName)

Create a named False validation rule that always fails. We need to include this for the logic system to be complete.

Parameters:

ruleName - The name of our validation rule.

Returns:

The new validation rule.

falsep

public Validator falsep()

Create an anonymous False validatioin rule that always fails. We need to include this for the logic system to be complete.

Returns:

The new validation rule.

intp

public Validator intp(String ruleName)

Create a named Int validation rule.

Parameters:

ruleName - The name for our new rule.

Returns:

The new validation rule.

intp

public Validator intp()

Create an anonymous Int validation rule.

Returns:

The new validation rule.

length

public Validator length(Integer min,
               Integer max)

Create an anonymous Length validation rule to check the length of an array or a string.

Parameters:

min - The minimum length for the value (string or array).

max - The maximum length the value can have (string or array).

Returns:

The new validator.

length

public Validator length(String ruleName,
               Integer min,
               Integer max)

Create a named Length validator to check the length of an array or a string.

Parameters:

ruleName - The name of the validation rule.

min - The minimum length for the value (string or array).

max - The maximum length for the value (string or array).

Returns:

The new length validator.

not

public Validator not(String ruleName,
            Validator rule)

Create a named logical Not validation which flips the result of an inner validation.

Parameters:

ruleName - The name of our validation rule.

rule - The inner validation, the result will be reversed.

Returns:

The new validator.

not

public Validator not(Validator rule)

Create an anonymous logical Not validation which reverses the result of an inner validation.

Parameters:

rule - The inner validation, the result of it will be reversed.

Returns:

The new validator.

nr

public Validator nr(String ruleName)

Create a named Nr validator to see if a value is a number.

Parameters:

ruleName - The name of the validation rule.

Returns:

The new validator.

nr

public Validator nr()

Create an anonymous Nr validator to see if a value is a number.

Returns:

The new validator.

nullp

public Validator nullp(String ruleName)

Create a named Null checking validator.

Parameters:

ruleName - A name for the validation rule.

Returns:

The new validator.

nullp

public Validator nullp()

Create an anonymous Null checking validator.

Returns:

The new validator.

object

public Validator object(String ruleName)

Create a named Object validator to check if a value is an object.

Parameters:

ruleName - The name of the rule.

Returns:

The new validator.

object

public Validator object()

Create an anonymous Object validator to check if a value is an object

Returns:

The new validator.

or

public Validator or(String ruleName,
           Validator... validators)

Create a named composite Or validation. The value must match against one of the inner rules.

Parameters:

ruleName - The name for our rule.

validators - The inner validators, one of it must succeed on the value for the complete matcher to succeed.

Returns:

The new validator.

or

public Validator or(Validator... validators)

Create an anonymous Or validation rule. The value must match against one of the inner rules.

Parameters:

validators - The inner validators, one of it must succeed on the value for the complete matcher to succeed.

Returns:

The new validator.

regexp

public Validator regexp(String ruleName,
               String pattern)

Create a named Regexp validator to validate strings against regular expressions.

Parameters:

ruleName - The name of the regular expression rule.

pattern - The regular expression itself.

Returns:

The new validator.

regexp

public Validator regexp(String pattern)

Create an anonymous Regexp validator to validate strings against regular expressions.

Parameters:

pattern - The regular expression.

Returns:

The new validator.

simple

public Validator simple(String ruleName)

Create a named Simple validator to check that a value is atomic.

Parameters:

ruleName - The name of the new validator.

Returns:

The new validator.

simple

public Validator simple()

Create an anonymous Simple validator to check that a value is atomic.

Returns:

the new validator.

string

public Validator string(String ruleName)

Create a named Str validator to check if a value is a string.

Parameters:

ruleName - The name of the validator.

Returns:

The new validator.

string

public Validator string()

Create an anonymous Str validator to check if a value is a string.

Returns:

The new validator.

properties

public Validator properties(String ruleName,
                   Properties.PropRule... rules)

Create a named Properties validator to check the key/value pairs of an object.

Parameters:

ruleName - The name of the validator.

rules - An array of Properties.PropRule, each rule can validate a specific property of the object. You can use the propRule(String, Validator, boolean) method to quickly create the property rules.

Returns:

The new validator.

properties

public Validator properties(Properties.PropRule... rules)

Create an anonymous Properties validator to check the key/value pairs of an object.

Parameters:

rules - An array of Properties.PropRule, each rule can validate a specific property of the object. You can use the propRule(String, Validator, boolean) method to quickly create the property rules.

Returns:

The new validator.

switchrule

public Validator switchrule(String ruleName,
                   String discriminator,
                   Switch.SwitchCase... cases)

Create a named Switch validator.

Parameters:

ruleName - The name of the rule.

discriminator - The name of the field that will be used to select a Switch.SwitchCase.

cases - An array of Switch.SwitchCase elements. You can use the switchcase(Validator, JSONValue...) method to quickly create a case.

Returns:

The new validator.

switchrule

public Validator switchrule(String discriminator,
                   Switch.SwitchCase... cases)

Create an anonymous Switch validator.

Parameters:

discriminator - The name of the field that will be used to select a Switch.SwitchCase.

cases - An array of Switch.SwitchCase elements. You can use the switchcase(Validator, JSONValue...) method to quickly create a case.

Returns:

The new validator.

switchcase

public static Switch.SwitchCase switchcase(Validator rule,
                           JSONValue... values)

Create a Switch.SwitchCase that can be used to build a Switch validator.

Parameters:

rule - The internal validator.

values - The discriminating values. If the discriminator is one of these values, the rule will be applied to the complete object.

Returns:

The SwitchCase.

propRule

public static Properties.PropRule propRule(String propName,
                           Validator rule,
                           boolean optional)

Create a Properties.PropRule that is used to build a Properties validator for objects.

Parameters:

propName - The name of the object property to which this rule applies.

rule - The validator for this property.

optional - A flag to indicate if the property is optional or not. If it is not optional, a validation error will occur if the object does not have a property with that name.

Returns:

The property rule.