atg.service.validator

Class Validators.StringValidator

java.lang.Object

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

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

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

atg.service.validator.Validators.StringValidator

All Implemented Interfaces:

Validator<java.lang.String>

Direct Known Subclasses:

Validators.IdValidator, Validators.StringTrimmingValidator

Enclosing interface:

Validators

public static class Validators.StringValidator
extends Validators.RequiredValidator<java.lang.String>

A validator that checkes to make sure the value is a string and trims the value (if the string is non-null). If the length of the trimmed string is zero, returns null.

Field Summary

Fields inherited from interface atg.service.validator.Validator

CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
StringValidator()
StringValidator(boolean pRequired)
StringValidator(java.lang.String pErrorCode)
StringValidator(java.lang.String pErrorCode, boolean pRequired)
StringValidator(java.lang.String pErrorCode, boolean pRequired, int pMaxLength)

Method Summary

Modifier and Type	Method and Description
int	getMaxLength() Returns property maxLength.
void	setMaxLength(int pMaxLength) Sets property maxLength.
protected boolean	shouldTrim() Whether we should trim the string.
java.lang.String	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

Constructor Detail

StringValidator

public StringValidator()

StringValidator

public StringValidator(java.lang.String pErrorCode)

StringValidator

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

StringValidator

public StringValidator(boolean pRequired)

StringValidator

public StringValidator(java.lang.String pErrorCode,
                       boolean pRequired,
                       int pMaxLength)

Method Detail

setMaxLength

public void setMaxLength(int pMaxLength)

Sets property maxLength. The maximum length of a string.

getMaxLength

public int getMaxLength()

Returns property maxLength. The maximum length of a string.

shouldTrim

protected boolean shouldTrim()

Whether we should trim the string.

validateValue

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

Overrides:

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

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.