atg.service.validator

Class Validators.OptionValidator<T>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

atg.service.validator.ChildValidator<T>, ConfigurableValidator<T>, Validator<T>

Direct Known Subclasses:

Validators.MonthNumberStringValidator

Enclosing interface:

Validators

public static class Validators.OptionValidator<T>
extends Validators.RequiredValidator<T>

A validator that validates that the specific option is one of the valid options.

Field Summary

Fields inherited from interface atg.service.validator.ConfigurableValidator

CLASS_VERSION

Fields inherited from interface atg.service.validator.ChildValidator

CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
OptionValidator() Create a new instance.
OptionValidator(java.util.Set<T> pOptions) Create a new instance.
OptionValidator(java.util.Set<T> pOptions, java.lang.Class<? extends T> pClass) Create a new instance.
OptionValidator(java.lang.String pErrorCode, boolean pRequired, java.util.Set<T> pOptions) Create a new instance.
OptionValidator(java.lang.String pErrorCode, boolean pRequired, java.util.Set<T> pOptions, java.lang.Class<T> pClass) Create a new instance.
OptionValidator(java.lang.String pErrorCode, java.util.Set<T> pOptions) Create a new instance.
OptionValidator(java.lang.String pErrorCode, java.util.Set<T> pOptions, java.lang.Class<T> pClass) Create a new instance.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	getBeanPropertyValueForValidation(java.lang.Object pBean, java.lang.String pPropertyName) Get the bean property value for update.
java.util.Set<T>	getOptions() Return the set of valid options.
java.lang.Object	getOptionsAsArrayOrCollection() Returns property optionsAsArrayOrCollection.
java.lang.String[]	getPreferredOptionalSourcePropertyNames() Returns property preferredOptionalSourcePropertyNames.
void	setOptions(java.util.Set<T> pOptions)
void	setOptionsAsArrayOrCollection(java.lang.Object pOptionsAsArrayOrCollection) Sets property optionsAsArrayOrCollection.
void	setPreferredOptionalSourcePropertyNames(java.lang.String[] pPreferredOptionalSourcePropertyNames) Sets property preferredOptionalSourcePropertyNames.
T	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

getClassesRequired, getClassRequired, getRequiredOption, getRequiredPredicate, isRequired, isSourceOnly, keyMustBePresent, setClassesRequired, setClassRequired, setRequired, setRequiredOption, setRequiredPredicate, setSourceOnly

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

assertAlphanumeric, assertBoolean, assertDateTime, assertDouble, assertInstanceOf, assertInstanceOf, assertInteger, assertInteger, assertLong, assertNotBlankString, assertNotEmpty, assertNotEmpty, assertNotNull, assertNotNull, assertString, assertString, assertString, assertUnicodeAlphanumeric, createInstance, createInstance, getCheckedBeanPropertyValueForValidation, getErrorCode, getNameForClass, getNameForClasses, getParentValidator, getPropertyNames, getPropertyValue, getPropertyValue, hasProperty, isDigits, isRequired, setErrorCode, setParentValidator, 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.ConfigurableValidator

getErrorCode, setErrorCode

Methods inherited from interface atg.service.validator.Validator

validateBeanProperty

Constructor Detail

OptionValidator

public OptionValidator()

Create a new instance. This version is primarily useful for the payload schema framework.

OptionValidator

public OptionValidator(java.util.Set<T> pOptions,
                       java.lang.Class<? extends T> pClass)

Create a new instance.

Parameters:

pOptions - the set of available options

pClass - the required class, if any.

OptionValidator

public OptionValidator(java.util.Set<T> pOptions)

Create a new instance.

Parameters:

pOptions - the set of available options

OptionValidator

public OptionValidator(java.lang.String pErrorCode,
                       java.util.Set<T> pOptions)

Create a new instance.

Parameters:

pOptions - the set of available options

pErrorCode - the error code to report on failure

OptionValidator

public OptionValidator(java.lang.String pErrorCode,
                       java.util.Set<T> pOptions,
                       java.lang.Class<T> pClass)

Create a new instance.

Parameters:

pOptions - the set of available options

pErrorCode - the error code to report on failure

pClass - the required class, if any.

OptionValidator

public OptionValidator(java.lang.String pErrorCode,
                       boolean pRequired,
                       java.util.Set<T> pOptions,
                       java.lang.Class<T> pClass)

Create a new instance.

Parameters:

pOptions - the set of available options

pRequired - whether a non-null v

pErrorCode - the error code to report on failure

pClass - the required class, if any.

OptionValidator

public OptionValidator(java.lang.String pErrorCode,
                       boolean pRequired,
                       java.util.Set<T> pOptions)

Create a new instance.

Parameters:

pOptions - the set of available options

pErrorCode - the error code to report on failure

pRequired - whether a non-null value is required.

Method Detail

setPreferredOptionalSourcePropertyNames

public void setPreferredOptionalSourcePropertyNames(java.lang.String[] pPreferredOptionalSourcePropertyNames)

Sets property preferredOptionalSourcePropertyNames. Properties to try before falling back to the default property name.

getPreferredOptionalSourcePropertyNames

public java.lang.String[] getPreferredOptionalSourcePropertyNames()

Returns property preferredOptionalSourcePropertyNames. Properties to try before falling back to the default property name.

getOptions

public java.util.Set<T> getOptions()

Return the set of valid options.

setOptions

public void setOptions(java.util.Set<T> pOptions)

setOptionsAsArrayOrCollection

public void setOptionsAsArrayOrCollection(java.lang.Object pOptionsAsArrayOrCollection)

Sets property optionsAsArrayOrCollection. A psuedo-property for setting options from an array or collection.

getOptionsAsArrayOrCollection

public java.lang.Object getOptionsAsArrayOrCollection()

Returns property optionsAsArrayOrCollection. A psuedo-property for setting options from an array or collection.

validateValue

public T 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<T>

Overrides:

validateValue in class Validators.RequiredValidator<T>

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.

getBeanPropertyValueForValidation

protected java.lang.Object getBeanPropertyValueForValidation(java.lang.Object pBean,
                                                             java.lang.String pPropertyName)
                                                      throws PropertyNotFoundException

Description copied from class: Validators.ValidatorImpl

Get the bean property value for update. This method provides means of overriding the fetching of values, allowing for aliases and the like.

Overrides:

getBeanPropertyValueForValidation in class Validators.ValidatorImpl<T>

Parameters:

pBean - the bean to get the property value from

pPropertyName - the name of the property whose value should be fetched.

Returns:

the property value.

Throws:

PropertyNotFoundException