Package cdc.util.validation

Class Validators

java.lang.Object

cdc.util.validation.Validators

public class Validators
extends java.lang.Object

Registry of validators.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Validators.Printer

Field Summary

Fields

Modifier and Type	Field	Description
static cdc.util.debug.Printable	PRINTER

Method Summary

Modifier and Type	Method	Description
static java.util.Set<java.lang.String>	getNames()
static Validator<? super java.lang.String>	getStringValidator(java.lang.String name)
static Validator<? super java.lang.String>	getStringValidator(java.lang.String name, cdc.util.lang.FailureReaction reaction)
static <T> Validator<? super T>	getValidator(java.lang.Class<T> valueClass, java.lang.String name)	Returns the validator that has a name and a value type.
static <T> Validator<? super T>	getValidator(java.lang.Class<T> valueClass, java.lang.String name, cdc.util.lang.FailureReaction reaction)	Returns the validator that has a name and a value type.
static Validator<?>	getValidator(java.lang.String name)	Returns the validator that has a name.
static Validator<?>	getValidator(java.lang.String name, cdc.util.lang.FailureReaction reaction)	Returns the validator that has a name.
static boolean	hasValidator(java.lang.String name)	Returns true if a validator with a name exists.
static void	register(Validator<?> validator, java.lang.String name)	Register a validator with a name.
static <T> java.util.List<ValidationRecord>	validate(java.lang.Class<T> valueClass, java.lang.String validatorName, cdc.util.lang.FailureReaction reaction, T value, java.lang.String valueName)	Validates a value with a validator and returns a list of validation records.
static <T> void	validate(java.lang.Class<T> valueClass, java.lang.String validatorName, cdc.util.lang.FailureReaction reaction, T value, java.lang.String valueName, ValidationHandler handler)	Validates a value with a validator.
static <T> void	validate(java.lang.Class<T> valueClass, java.lang.String validatorName, cdc.util.lang.FailureReaction reaction, T value, java.lang.String valueName, java.util.List<ValidationRecord> records)	Validates a value with a validator and fills a list of validation records.
static void	validateRaw(java.lang.String validatorName, cdc.util.lang.FailureReaction reaction, java.lang.Object value, java.lang.String valueName, ValidationHandler handler)	Validates a raw value with a validator.
static void	validateRaw(java.lang.String validatorName, cdc.util.lang.FailureReaction reaction, java.lang.Object value, java.lang.String valueName, java.util.List<ValidationRecord> records)	Validates a raw value with a validator and fills a list of validation records.
static java.util.List<ValidationRecord>	validatRaw(java.lang.String validatorName, cdc.util.lang.FailureReaction reaction, java.lang.Object value, java.lang.String valueName)	Validates a raw value with a validator and returns a list of validation records.

Methods inherited from class java.lang.Object

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

Field Detail

PRINTER

public static final cdc.util.debug.Printable PRINTER

Method Detail

register

public static void register(Validator<?> validator,
                            java.lang.String name)

Register a validator with a name.

Parameters:

validator - The validator.

name - The name.

Throws:

java.lang.IllegalArgumentException - When validator or name is null, or when a validator with that name is already registered.

getNames

public static java.util.Set<java.lang.String> getNames()

Returns:

A set of registered validators names.

hasValidator

public static boolean hasValidator(java.lang.String name)

Returns true if a validator with a name exists.

Parameters:

name - The name.

Returns:

true if a validator named name exists.

getValidator

public static Validator<?> getValidator(java.lang.String name,
                                        cdc.util.lang.FailureReaction reaction)

Returns the validator that has a name.

Parameters:

name - The name.

reaction - The reaction to adopt if no matching validator is found.

Returns:

The validator named name or null or an exception, depending on reaction.

Throws:

cdc.util.lang.NotFoundException - When no validator is found and reaction is FailureReaction.FAIL.

getValidator

public static Validator<?> getValidator(java.lang.String name)

Returns the validator that has a name.

Parameters:

name - The name.

Returns:

The validator named name.

Throws:

cdc.util.lang.NotFoundException - When no validator is found.

getValidator

public static <T> Validator<? super T> getValidator(java.lang.Class<T> valueClass,
                                                    java.lang.String name,
                                                    cdc.util.lang.FailureReaction reaction)

Returns the validator that has a name and a value type.

Type Parameters:

T - The validator value type.

Parameters:

valueClass - The validator value class.

name - The name.

reaction - The reaction to adopt if no matching validator is found.

Returns:

the validator named name or null or an exception, depending on reaction.

Throws:

cdc.util.lang.NotFoundException - When no validator is found and reaction is FailureReaction.FAIL.

java.lang.IllegalArgumentException - When a validator is found but its value type does not match valueClass.

getValidator

public static <T> Validator<? super T> getValidator(java.lang.Class<T> valueClass,
                                                    java.lang.String name)

Returns the validator that has a name and a value type.

Type Parameters:

T - The validator value type.

Parameters:

valueClass - The validator value class.

name - The name.

Returns:

the validator named name or null or an exception.

Throws:

cdc.util.lang.NotFoundException - When no validator is found.

java.lang.IllegalArgumentException - When a validator is found but its value type does not match valueClass.

getStringValidator

public static Validator<? super java.lang.String> getStringValidator(java.lang.String name,
                                                                     cdc.util.lang.FailureReaction reaction)

getStringValidator

public static Validator<? super java.lang.String> getStringValidator(java.lang.String name)

validate

public static <T> void validate(java.lang.Class<T> valueClass,
                                java.lang.String validatorName,
                                cdc.util.lang.FailureReaction reaction,
                                T value,
                                java.lang.String valueName,
                                ValidationHandler handler)

Validates a value with a validator.

Type Parameters:

T - The value type.

Parameters:

valueClass - The value class.

validatorName - The validator name.

reaction - The reaction to adopt if no matching validator is found.

value - The value.

valueName - The name that must be given to value in messages.

handler - The validation messages handler.

Throws:

cdc.util.lang.NotFoundException - When no validator is found and reaction is FailureReaction.FAIL.

java.lang.IllegalArgumentException - When a validator is found but its value type does not match valueClass.

validate

public static <T> void validate(java.lang.Class<T> valueClass,
                                java.lang.String validatorName,
                                cdc.util.lang.FailureReaction reaction,
                                T value,
                                java.lang.String valueName,
                                java.util.List<ValidationRecord> records)

Validates a value with a validator and fills a list of validation records.

Type Parameters:

T - The value type.

Parameters:

valueClass - The value class.

validatorName - The validator name.

reaction - The reaction to adopt if no matching validator is found.

value - The value.

valueName - The name that must be given to value in messages.

records - The list of validation records that must be filled.

Throws:

cdc.util.lang.NotFoundException - When no validator is found and reaction is FailureReaction.FAIL.

java.lang.IllegalArgumentException - When a validator is found but its value type does not match valueClass.

validate

public static <T> java.util.List<ValidationRecord> validate(java.lang.Class<T> valueClass,
                                                            java.lang.String validatorName,
                                                            cdc.util.lang.FailureReaction reaction,
                                                            T value,
                                                            java.lang.String valueName)

Validates a value with a validator and returns a list of validation records.

Type Parameters:

T - The value type.

Parameters:

valueClass - The value class.

validatorName - The validator name.

reaction - The reaction to adopt if no matching validator is found.

value - The value.

valueName - The name that must be given to value in messages.

Returns:

A list of validation records, possibly empty.

Throws:

cdc.util.lang.NotFoundException - When no validator is found and reaction is FailureReaction.FAIL.

java.lang.IllegalArgumentException - When a validator is found but its value type does not match valueClass.

validateRaw

public static void validateRaw(java.lang.String validatorName,
                               cdc.util.lang.FailureReaction reaction,
                               java.lang.Object value,
                               java.lang.String valueName,
                               ValidationHandler handler)

Validates a raw value with a validator.

Parameters:

validatorName - The validator name.

reaction - The reaction to adopt if no matching validator is found.

value - The value.

valueName - The name that must be given to value in messages.

handler - The validation messages handler.

Throws:

cdc.util.lang.NotFoundException - When no validator is found and reaction is FailureReaction.FAIL.

java.lang.ClassCastException - If value is not null and cannot be assigned to value type of the found validator.

validateRaw

public static void validateRaw(java.lang.String validatorName,
                               cdc.util.lang.FailureReaction reaction,
                               java.lang.Object value,
                               java.lang.String valueName,
                               java.util.List<ValidationRecord> records)

Validates a raw value with a validator and fills a list of validation records.

Parameters:

validatorName - The validator name.

reaction - The reaction to adopt if no matching validator is found.

value - The value.

valueName - The name that must be given to value in messages.

records - The list of validation records that must be filled.

Throws:

cdc.util.lang.NotFoundException - When no validator is found and reaction is FailureReaction.FAIL.

java.lang.ClassCastException - If value is not null and cannot be assigned to value type of the found validator.

validatRaw

public static java.util.List<ValidationRecord> validatRaw(java.lang.String validatorName,
                                                          cdc.util.lang.FailureReaction reaction,
                                                          java.lang.Object value,
                                                          java.lang.String valueName)

Validates a raw value with a validator and returns a list of validation records.

Parameters:

validatorName - The validator name.

reaction - The reaction to adopt if no matching validator is found.

value - The value.

valueName - The name that must be given to value in messages.

Returns:

A list of validation records, possibly empty.

Throws:

cdc.util.lang.NotFoundException - When no validator is found and reaction is FailureReaction.FAIL.

java.lang.IllegalArgumentException - When a validator is found but its value type does not match valueClass.