atg.service.validator

Class Validators.ValidatorImpl<T>

java.lang.Object

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

All Implemented Interfaces:

Validator<T>

Direct Known Subclasses:

UpdatingValidator.NoOpValidator, Validators.NonNullValidator, Validators.NullObjectIfNulledValidator, Validators.NullObjectIfNullValidator, atg.service.validator.ValidatorWrapperImpl

Enclosing interface:

Validators

public abstract static class Validators.ValidatorImpl<T>
extends java.lang.Object
implements Validator<T>

validator impl that can ensure a given value is a specific number type

Field Summary

Fields inherited from interface atg.service.validator.Validator

CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
ValidatorImpl() Create a new instance.
ValidatorImpl(java.lang.String pErrorCode) Create a new instance.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	assertAlphanumeric(java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext) Assert that the value is an alphanumeric string.
java.lang.Boolean	assertBoolean(java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext)
java.util.Date	assertDateTime(java.lang.String pPropertyName, java.lang.Object pValue, boolean pAssertNotNegative, ValidatorContext<?> pContext) Assert that the value is a date.
java.lang.Double	assertDouble(java.lang.String pPropertyName, java.lang.Object pValue, boolean pAssertNotNegative, ValidatorContext<?> pContext) Assert that the value is a double.
<C> C	assertInstanceOf(java.lang.String pPropertyName, java.lang.Object pValue, boolean pAllowNull, java.lang.Class<C> pClass, ValidatorContext<?> pContext) Assert that pValue is an instance of the specified type.
java.lang.Integer	assertInteger(java.lang.String pPropertyName, java.lang.Object pValue, boolean pAssertNotNegative, ValidatorContext<?> pContext) Assert that the value is an integer.
java.lang.Long	assertLong(java.lang.String pPropertyName, java.lang.Object pValue, boolean pAssertNotNegative, ValidatorContext<?> pContext) Assert that the value is a long.
java.lang.String	assertNotBlankString(java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext) Assert that the value is not a blank String.
java.lang.Object	assertNotEmpty(java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext) Assert that the value is not empty
java.lang.Object	assertNotEmpty(java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext, java.lang.String pErrorText) Assert that the value is not empty
java.lang.Object	assertNotNull(java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext) Assert that the value is not null.
java.lang.Object	assertNotNull(java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext, java.lang.String pErrorText) Assert that the value is not null.
java.lang.String	assertString(java.lang.String pPropertyName, java.lang.Object pValue, int pMaxLength, boolean pTrim, ValidatorContext<?> pContext) Assert that the value is a string and check its max length.
java.lang.String	assertString(java.lang.String pPropertyName, java.lang.Object pValue, int pMaxLength, ValidatorContext<?> pContext) Assert that the value is a string and check its max length.
java.lang.String	assertString(java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext) Assert that the value is a string
<C> C	createInstance(java.lang.String pPropertyName, java.lang.Class<C> pClass) Create an instance of the specified class as a part of setting/updating property pPropertyName.
protected java.lang.Object	getBeanPropertyValueForValidation(java.lang.Object pBean, java.lang.String pPropertyName) Get the bean property value for update.
java.lang.String	getErrorCode() Returns property errorCode.
protected java.lang.String	getNameForClass(java.lang.Class<?> pClass) Get the name for the specified path to report back to the user for an assertInstanceOf failure.
java.util.Set<java.lang.String>	getPropertyNames(java.lang.Object pObject) Get the property names of the specified object.
<V> V	getPropertyValue(java.lang.Object pBean, java.lang.String pPropertyName) Used DynamicBeans to get the specified property value.
<V> V	getPropertyValue(java.lang.Object pBean, java.lang.String pPropertyName, boolean pAllowSubProperties, java.lang.Class<V> pExpectedClass) Used DynamicBeans to set the specified property value.
boolean	hasProperty(java.lang.Object pObject, java.lang.String pPropertyName) Return whether the specified object has the specified property.
boolean	isDigits(java.lang.String pDigits) Return whether the specified string is composed only of digits, and is non-empty.
boolean	isRequired(ValidatorContext<?> pContext, Validators.RequiredOption pRequired) Implements default logic for combining a RequiredOption with ValidatorContext to determine if a property is required.
boolean	keyMustBePresent(ValidatorContext<?> pContext, java.lang.String pPropertyName, java.lang.Object pSource, java.lang.Object pTarget, boolean pIsBean)
void	setErrorCode(java.lang.String pErrorCode) Sets property errorCode.
void	setPropertyValue(java.lang.Object pBean, java.lang.String pPropertyName, java.lang.Object pValue, ValidatorContext<?> pContext) Used DynamicBeans to set the specified property value.
T	validateBeanProperty(java.lang.String pPropertyName, java.lang.Object pBean, ValidatorContext<?> pContext) Validate a property of the bean pPropertyValue.
T	validateValue(java.lang.String pPropertyName, java.lang.Object pPropertyValue, ValidatorContext<?> pContext) Validate (and possibly convert) the specified property value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatorImpl

public ValidatorImpl()

Create a new instance.

ValidatorImpl

public ValidatorImpl(java.lang.String pErrorCode)

Create a new instance.

Parameters:

pErrorCode - the error code to use for errors.

Method Detail

setErrorCode

public void setErrorCode(java.lang.String pErrorCode)

Sets property errorCode. An error code to set on exceptions. This may be used by some ValidatorContexts that create exceptions (like Cloud's CCException) that use a non-translated error code.

getErrorCode

public java.lang.String getErrorCode()

Returns property errorCode. An error code to set on exceptions. This may be used by some ValidatorContexts that create exceptions (like Cloud's CCException) that use a non-translated error code.

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>

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.

validateBeanProperty

public T validateBeanProperty(java.lang.String pPropertyName,
                              java.lang.Object pBean,
                              ValidatorContext<?> pContext)

Validate a property of the bean pPropertyValue.

Specified by:

validateBeanProperty in interface Validator<T>

Parameters:

pPropertyName - the property of pBean to validate

pBean - the bean to fetch pPropertyName from and validate

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

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

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

keyMustBePresent

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

assertBoolean

public java.lang.Boolean assertBoolean(java.lang.String pPropertyName,
                                       java.lang.Object pValue,
                                       ValidatorContext<?> pContext)

assertInstanceOf

public <C> C assertInstanceOf(java.lang.String pPropertyName,
                              java.lang.Object pValue,
                              boolean pAllowNull,
                              java.lang.Class<C> pClass,
                              ValidatorContext<?> pContext)

Assert that pValue is an instance of the specified type.

Parameters:

pPropertyName - the property name in question

pValue - the value to check

pAllowNull - whether a null value is allowed

pClass - the class which pValue must be an instance of

pContext - the current validation context.

Returns:

pValue cast to the specified class.

getNameForClass

protected java.lang.String getNameForClass(java.lang.Class<?> pClass)

Get the name for the specified path to report back to the user for an assertInstanceOf failure.

Parameters:

pClass - the class whose name to return.

Returns:

the simple name or the canonical name.

assertInteger

public java.lang.Integer assertInteger(java.lang.String pPropertyName,
                                       java.lang.Object pValue,
                                       boolean pAssertNotNegative,
                                       ValidatorContext<?> pContext)

Assert that the value is an integer.

Parameters:

pPropertyName - the property name to use.

pAssertNotNegative - if true, only accept non-negative values.

pContext - the validator context.

Returns:

pValue as an Integer, or null.

assertLong

public java.lang.Long assertLong(java.lang.String pPropertyName,
                                 java.lang.Object pValue,
                                 boolean pAssertNotNegative,
                                 ValidatorContext<?> pContext)

Assert that the value is a long.

Parameters:

pPropertyName - the property name to use.

pAssertNotNegative - if true, only accept non-negative values.

pContext - the validator context.

Returns:

pValue as an Long, or null.

assertDouble

public java.lang.Double assertDouble(java.lang.String pPropertyName,
                                     java.lang.Object pValue,
                                     boolean pAssertNotNegative,
                                     ValidatorContext<?> pContext)

Assert that the value is a double.

Parameters:

pPropertyName - the property name to use.

pAssertNotNegative - if true, only accept non-negative values.

pContext - the validator context.

Returns:

pValue as an Double, or null.

assertDateTime

public java.util.Date assertDateTime(java.lang.String pPropertyName,
                                     java.lang.Object pValue,
                                     boolean pAssertNotNegative,
                                     ValidatorContext<?> pContext)

Assert that the value is a date. If a string, converts from ISO8601 format. If an integer or long, treats it as millis from the epoch.

Parameters:

pPropertyName - the property name to use.

pAssertNotNegative - if true, only accept non-negative values.

pContext - the validator context.

Returns:

pValue cast or converted to a Date.

isDigits

public boolean isDigits(java.lang.String pDigits)

Return whether the specified string is composed only of digits, and is non-empty.

Parameters:

pDigits - the string to check.

Returns:

true if the string is composed of digits

assertNotNull

public java.lang.Object assertNotNull(java.lang.String pPropertyName,
                                      java.lang.Object pValue,
                                      ValidatorContext<?> pContext)

Assert that the value is not null.

Parameters:

pPropertyName - the property name

pValue - the value to check

pContext - the current validator context.

Returns:

pValue.

assertNotNull

public java.lang.Object assertNotNull(java.lang.String pPropertyName,
                                      java.lang.Object pValue,
                                      ValidatorContext<?> pContext,
                                      java.lang.String pErrorText)

Assert that the value is not null.

Parameters:

pPropertyName - the property name

pValue - the value to check

pContext - the current validator context.

pErrorText - the error text to use, or null to use the default error text.

Returns:

pValue.

assertNotEmpty

public java.lang.Object assertNotEmpty(java.lang.String pPropertyName,
                                       java.lang.Object pValue,
                                       ValidatorContext<?> pContext)

Assert that the value is not empty

Parameters:

pPropertyName - the property name

pValue - the value to check

pContext - the current validator context.

Returns:

pValue or null.

assertNotEmpty

public java.lang.Object assertNotEmpty(java.lang.String pPropertyName,
                                       java.lang.Object pValue,
                                       ValidatorContext<?> pContext,
                                       java.lang.String pErrorText)

Assert that the value is not empty

Parameters:

pPropertyName - the property name

pValue - the value to check

pContext - the current validator context.

pErrorText - the error text to use, or null to use the default error text.

Returns:

pValue or null.

assertString

public java.lang.String assertString(java.lang.String pPropertyName,
                                     java.lang.Object pValue,
                                     ValidatorContext<?> pContext)

Assert that the value is a string

Parameters:

pPropertyName - the property name

pValue - the value to check

pContext - the current validator context.

Returns:

pValue or null.

assertString

public java.lang.String assertString(java.lang.String pPropertyName,
                                     java.lang.Object pValue,
                                     int pMaxLength,
                                     ValidatorContext<?> pContext)

Assert that the value is a string and check its max length.

Parameters:

pPropertyName - the property name

pValue - the value to check

pMaxLength - the maximum length of the string. -1 means no maximum length.

pContext - the current validator context.

Returns:

pValue null.

assertString

public java.lang.String assertString(java.lang.String pPropertyName,
                                     java.lang.Object pValue,
                                     int pMaxLength,
                                     boolean pTrim,
                                     ValidatorContext<?> pContext)

Assert that the value is a string and check its max length. If pTrim is true and the value is all whitespace, null is returned.

Parameters:

pPropertyName - the property name

pValue - the value to check

pMaxLength - the maximum length of the string. -1 means no maximum length.

pTrim - trim off leading and trailing whitespace.

pContext - the current validator context.

Returns:

pValue or null.

assertNotBlankString

public java.lang.String assertNotBlankString(java.lang.String pPropertyName,
                                             java.lang.Object pValue,
                                             ValidatorContext<?> pContext)

Assert that the value is not a blank String.

Parameters:

pPropertyName - the property name

pValue - the value to check

pContext - the current validator context.

Returns:

pValue or null.

assertAlphanumeric

public java.lang.Object assertAlphanumeric(java.lang.String pPropertyName,
                                           java.lang.Object pValue,
                                           ValidatorContext<?> pContext)

Assert that the value is an alphanumeric string.

Parameters:

pPropertyName - the property name

pValue - the value to check

pContext - the current validator context.

Returns:

pValue or null.

setPropertyValue

public void setPropertyValue(java.lang.Object pBean,
                             java.lang.String pPropertyName,
                             java.lang.Object pValue,
                             ValidatorContext<?> pContext)
                      throws PropertyNotFoundException

Used DynamicBeans to set the specified property value.

Parameters:

pBean - the bean to set the property on.

pPropertyName - the name of the value.

pValue - the value to set.

Throws:

PropertyNotFoundException - if the property value could not be set.

getPropertyValue

public <V> V getPropertyValue(java.lang.Object pBean,
                              java.lang.String pPropertyName)
                       throws PropertyNotFoundException

Used DynamicBeans to get the specified property value.

Parameters:

pBean - the bean to set the property on

pPropertyName - the name of the value

Throws:

PropertyNotFoundException - if the property value could not be set.

getPropertyValue

public <V> V getPropertyValue(java.lang.Object pBean,
                              java.lang.String pPropertyName,
                              boolean pAllowSubProperties,
                              java.lang.Class<V> pExpectedClass)
                       throws PropertyNotFoundException,
                              java.lang.IllegalArgumentException

Used DynamicBeans to set the specified property value.

Parameters:

pBean - the bean to set the property on

pPropertyName - the name of the value

pAllowSubProperties - Allow the setting of the value of a sub-property.

pExpectedClass - the expected class the property should be an instance of (if any).

Returns:

the fetched property value (may be null).

Throws:

PropertyNotFoundException - if the property value could not be set.

java.lang.IllegalArgumentException

hasProperty

public boolean hasProperty(java.lang.Object pObject,
                           java.lang.String pPropertyName)
                    throws java.beans.IntrospectionException

Return whether the specified object has the specified property.

Parameters:

pObject - the (possibly dynamic) bean to check for a property.

pPropertyName - the property name.

Returns:

true if pObject has the specified property, false otherwise.

Throws:

java.beans.IntrospectionException

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames(java.lang.Object pObject)
                                                 throws java.beans.IntrospectionException

Get the property names of the specified object. Check for maps and flavors of JSONObject... failed that, falls back to DynamicBeans.

Parameters:

pObject - the (possibly dynamic) bean to get property names

Returns:

the set of property names.

Throws:

java.beans.IntrospectionException

createInstance

public <C> C createInstance(java.lang.String pPropertyName,
                            java.lang.Class<C> pClass)
                     throws java.beans.IntrospectionException

Create an instance of the specified class as a part of setting/updating property pPropertyName.

Parameters:

pPropertyName - the name of the property the new instance is being created for.

pClass - the class the new property is being created for.

Returns:

a new instance of pClass

Throws:

java.beans.IntrospectionException - if things go wrong.

isRequired

public boolean isRequired(ValidatorContext<?> pContext,
                          Validators.RequiredOption pRequired)

Implements default logic for combining a RequiredOption with ValidatorContext to determine if a property is required.

Parameters:

pContext - the current validator context.

pRequired - a required option.

Returns:

true if the current property should be required, false otherwise.