atg.service.validator

Class Validators.MapValidator<V>

java.lang.Object

atg.service.validator.Validators.ValidatorImpl<T>

atg.service.validator.Validators.NonNullValidator<T>

atg.service.validator.Validators.RequiredValidator<java.util.Map<java.lang.String,V>>

atg.service.validator.Validators.MapValidator<V>

All Implemented Interfaces:

Parentable, ParentValidator<java.util.Map<java.lang.String,V>>, Validator<java.util.Map<java.lang.String,V>>

Direct Known Subclasses:

MapUpdatingValidator

Enclosing interface:

Validators

public static class Validators.MapValidator<V>
extends Validators.RequiredValidator<java.util.Map<java.lang.String,V>>
implements ParentValidator<java.util.Map<java.lang.String,V>>

Validate a map whose keys are strings and values are the the specified class. Uses dynamic beans to get the properties, so can take a JSONObject or Map as its source. Applies the same validator to all keys.

Field Summary

Fields inherited from interface atg.service.validator.ParentValidator

CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
MapValidator(boolean pRequired) Create a new map validator.
MapValidator(boolean pRequired, Validator<? extends V> pValueValidator) Create a new map validator.
MapValidator(java.lang.String pErrorCode, boolean pRequired) Create a new map validator.
MapValidator(java.lang.String pErrorCode, boolean pRequired, Validator<? extends V> pValueValidator) Create a new instance.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Object,Validator<?>>	getChildValidatorMap() Return a map form of the child validators, used for generating a human readable representation of the parent-child relationship.
java.util.Collection<? extends Validator<?>>	getChildValidators() Get any child validators.
java.lang.Object	getDefaultKeyForChildValidatorMap() Return the default key for the childValidatorMap, if any.
void	setChildValidatorMap(java.util.Map<?,Validator<?>> pChildMap) Set the child validator map.
java.util.Map<java.lang.String,V>	validateValue(java.lang.String pPropertyName, java.lang.Object pPropertyValue, ValidatorContext<?> pContext) Validate (and possibly convert) the specified property value.

Methods inherited from class atg.service.validator.Validators.RequiredValidator

getClassRequired, getRequiredOption, getRequiredPredicate, isRequired, keyMustBePresent, setClassRequired, setRequired, setRequiredOption, setRequiredPredicate

Methods inherited from class atg.service.validator.Validators.ValidatorImpl

assertAlphanumeric, assertBoolean, assertDateTime, assertDouble, assertInstanceOf, assertInteger, assertLong, assertNotBlankString, assertNotEmpty, assertNotEmpty, assertNotNull, assertNotNull, assertString, assertString, assertString, createInstance, getBeanPropertyValueForValidation, getErrorCode, getNameForClass, getPropertyNames, getPropertyValue, getPropertyValue, hasProperty, isDigits, isRequired, setErrorCode, setPropertyValue, validateBeanProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.service.validator.Validator

validateBeanProperty

Constructor Detail

MapValidator

public MapValidator(boolean pRequired)

Create a new map validator.

Parameters:

pRequired - whether a non-null value is required.

MapValidator

public MapValidator(boolean pRequired,
                    Validator<? extends V> pValueValidator)

Create a new map validator.

Parameters:

pRequired - whether a non-null value is required.

pValueValidator - the validator to use to validate every value.

MapValidator

public MapValidator(java.lang.String pErrorCode,
                    boolean pRequired)

Create a new map validator.

Parameters:

pErrorCode - the error code to use in case of error.

pRequired - whether a non-null value is required

MapValidator

public MapValidator(java.lang.String pErrorCode,
                    boolean pRequired,
                    Validator<? extends V> pValueValidator)

Create a new instance.

Parameters:

pErrorCode - the error code to use.

pRequired - whether the validator is required.

pValueValidator - the validator to use on the values of the map.

Method Detail

validateValue

public java.util.Map<java.lang.String,V> validateValue(java.lang.String pPropertyName,
                                                       java.lang.Object pPropertyValue,
                                                       ValidatorContext<?> pContext)

Description copied from interface: Validator

Validate (and possibly convert) the specified property value.

Specified by:

validateValue in interface Validator<java.util.Map<java.lang.String,V>>

Overrides:

validateValue in class Validators.RequiredValidator<java.util.Map<java.lang.String,V>>

Parameters:

pPropertyName - the name of the property being validated. This is typically used as a key for fetching the value from pProperties.

pPropertyValue - the fetched property value

pContext - the current validation context.

Returns:

the validated (and possibly converted) value. May return null for invalid property data. May return ValidatorConstants.NULL_OBJECT indicating the that target property should be updated to null.

getChildValidators

public java.util.Collection<? extends Validator<?>> getChildValidators()

Description copied from interface: Parentable

Get any child validators.

Specified by:

getChildValidators in interface Parentable

Returns:

the collection of child validators.

getChildValidatorMap

public java.util.Map<java.lang.Object,Validator<?>> getChildValidatorMap()

Description copied from interface: Parentable

Return a map form of the child validators, used for generating a human readable representation of the parent-child relationship. The keys might be property names (for ParentValidator), "*" for every child property or map element, or "[*]" for a validator that is applied to every elemen of a collection.

Specified by:

getChildValidatorMap in interface Parentable

setChildValidatorMap

public void setChildValidatorMap(java.util.Map<?,Validator<?>> pChildMap)

Description copied from interface: Parentable

Set the child validator map. May throw

Specified by:

setChildValidatorMap in interface Parentable

Parameters:

pChildMap - the child validator map.

getDefaultKeyForChildValidatorMap

public java.lang.Object getDefaultKeyForChildValidatorMap()

Description copied from interface: Parentable

Return the default key for the childValidatorMap, if any. The default key is used for validating values without an entry in the validator map.

Specified by:

getDefaultKeyForChildValidatorMap in interface Parentable

Returns:

the default key, or null if no default key is supported.