atg.service.validator

Class Validators.RequiredValidator<T>

java.lang.Object

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

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

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

All Implemented Interfaces:

Validator<T>

Direct Known Subclasses:

SwitchingUpdatingValidator, Validators.BooleanValidator, Validators.CollectionValidator, Validators.DateTimeToLongValidator, Validators.DateTimeValidator, Validators.DoubleValidator, Validators.FloatValidator, Validators.IntegerValidator, Validators.LocaleStringValidator, Validators.LongValidator, Validators.MapValidator, Validators.NumberValidator, Validators.OptionValidator, Validators.RequiredValueValidator, Validators.ShortValidator, Validators.StringValidator, Validators.TimestampValidator, Validators.UrlValidator

Enclosing interface:

Validators

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

Adds optionally requiring a non-null value (required defaults to true).

Field Summary

Fields inherited from interface atg.service.validator.Validator

CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
RequiredValidator() Create a new instance with required set to true.
RequiredValidator(boolean pRequired) Create a new instance with required set to pRequired.
RequiredValidator(boolean pRequired, java.lang.Class<?> pClassRequired) Create a new instance
RequiredValidator(java.lang.String pErrorCode) Create a new instance.
RequiredValidator(java.lang.String pErrorCode, boolean pRequired) Create a new instance with required set to pRequired.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	getClassRequired() Returns property classRequired.
Validators.RequiredOption	getRequiredOption() Returns property requiredOption.
atg.service.validator.RequiredPredicate	getRequiredPredicate() Returns property requiredPredicate.
boolean	isRequired() Get the whether a non-null valid is required.
boolean	keyMustBePresent(ValidatorContext<?> pContext, java.lang.String pPropertyName, java.lang.Object pSource, java.lang.Object pTarget, boolean pIsBean)
void	setClassRequired(java.lang.Class<?> pClassRequired) Sets property classRequired.
void	setRequired(boolean pRequired) Set the whether a non-null valid is required.
void	setRequiredOption(Validators.RequiredOption pRequiredOption) Sets property requiredOption.
void	setRequiredPredicate(atg.service.validator.RequiredPredicate pRequiredPredicate) Sets property requiredPredicate.
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.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

Constructor Detail

RequiredValidator

public RequiredValidator()

Create a new instance with required set to true.

RequiredValidator

public RequiredValidator(boolean pRequired)

Create a new instance with required set to pRequired.

Parameters:

pRequired - whether a non-null value is required by the validator.

RequiredValidator

public RequiredValidator(boolean pRequired,
                         java.lang.Class<?> pClassRequired)

Create a new instance

Parameters:

pRequired - true means required a non-null value, false means a null valid is okay.

pClassRequired - all non-null values must be an instance of this class, if non-null.

RequiredValidator

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

Create a new instance with required set to pRequired.

Parameters:

pRequired - whether a non-null value is required by the validator.

pErrorCode - the error code to report when validation fails

RequiredValidator

public RequiredValidator(java.lang.String pErrorCode)

Create a new instance.

Parameters:

pErrorCode - the error code to report when validation fails

Method Detail

setRequiredOption

public void setRequiredOption(Validators.RequiredOption pRequiredOption)

Sets property requiredOption. Set the required option.

getRequiredOption

public Validators.RequiredOption getRequiredOption()

Returns property requiredOption. Set the required option.

setRequired

public void setRequired(boolean pRequired)

Set the whether a non-null valid is required.

Parameters:

pRequired - true means required a non-null value, false means a null valid is okay.

isRequired

public boolean isRequired()

Get the whether a non-null valid is required.

Returns:

true if non-null value is required, false means a null valid is okay.

keyMustBePresent

public boolean keyMustBePresent(ValidatorContext<?> pContext,
                                java.lang.String pPropertyName,
                                java.lang.Object pSource,
                                java.lang.Object pTarget,
                                boolean pIsBean)

Overrides:

keyMustBePresent in class Validators.ValidatorImpl<T>

setRequiredPredicate

public void setRequiredPredicate(atg.service.validator.RequiredPredicate pRequiredPredicate)

Sets property requiredPredicate. An instance that can override the default "required" logic.

getRequiredPredicate

public atg.service.validator.RequiredPredicate getRequiredPredicate()

Returns property requiredPredicate. An instance that can override the default "required" logic.

setClassRequired

public void setClassRequired(java.lang.Class<?> pClassRequired)

Sets property classRequired. All non-null values must be an instance of this class, if set.

getClassRequired

public java.lang.Class<?> getClassRequired()

Returns property classRequired. All non-null values must be an instance of this class, if set.

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.NonNullValidator<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.