atg.service.validator

Class Validators.IntegerValidator

java.lang.Object

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

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

atg.service.validator.Validators.RequiredValidator<java.lang.Integer>

atg.service.validator.Validators.IntegerValidator

All Implemented Interfaces:

atg.service.validator.ChildValidator<java.lang.Integer>, ConfigurableValidator<java.lang.Integer>, Validator<java.lang.Integer>

Enclosing interface:

Validators

public static class Validators.IntegerValidator
extends Validators.RequiredValidator<java.lang.Integer>

Validator to ensure that a value is a valid integer. This has a few configurations to (dis)allow negative numbers or zero. Effectively this can be configured to be a Whole number validator by disallowing negative numbers or zero.

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
IntegerValidator()
IntegerValidator(boolean pRequired)
IntegerValidator(boolean pRequired, boolean pAllowNegative)
IntegerValidator(java.lang.String pErrorCode)
IntegerValidator(java.lang.String pErrorCode, boolean pRequired)
IntegerValidator(java.lang.String pErrorCode, boolean pRequired, boolean pAllowNegative)
IntegerValidator(java.lang.String pErrorCode, boolean pRequired, boolean pAllowNegative, boolean pAllowZero)

Method Summary

Modifier and Type	Method and Description
boolean	isAllowNegative() Whether we allow a non-negative number.
boolean	isAllowZero()
void	setAllowNegative(boolean pAllowNegative) Set whether we allow a non-negative number.
void	setAllowZero(boolean pAllowZero)
java.lang.Integer	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, getBeanPropertyValueForValidation, 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

IntegerValidator

public IntegerValidator()

IntegerValidator

public IntegerValidator(boolean pRequired)

IntegerValidator

public IntegerValidator(boolean pRequired,
                        boolean pAllowNegative)

IntegerValidator

public IntegerValidator(java.lang.String pErrorCode)

IntegerValidator

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

IntegerValidator

public IntegerValidator(java.lang.String pErrorCode,
                        boolean pRequired,
                        boolean pAllowNegative)

IntegerValidator

public IntegerValidator(java.lang.String pErrorCode,
                        boolean pRequired,
                        boolean pAllowNegative,
                        boolean pAllowZero)

Method Detail

isAllowNegative

public boolean isAllowNegative()

Whether we allow a non-negative number.

setAllowNegative

public void setAllowNegative(boolean pAllowNegative)

Set whether we allow a non-negative number.

isAllowZero

public boolean isAllowZero()

Returns:

true if zero is allowed; this is true by default.

setAllowZero

public void setAllowZero(boolean pAllowZero)

Parameters:

pAllowZero - set to true if zero is allowed; true by default.

validateValue

public java.lang.Integer 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.lang.Integer>

Overrides:

validateValue in class Validators.RequiredValidator<java.lang.Integer>

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.