atg.service.validator

Class Validators.UrlStringValidator

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

All Implemented Interfaces:

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

Enclosing interface:

Validators

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

Validator to ensure that a value is a valid URL.

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPrefix() Returns property prefix.
Validators.RequiredOption	getRequiredOption() Returns property requiredOption.
java.lang.String	getRequiredProtocol() Returns property requiredProtocol.
boolean	isRequired() Get the whether a non-null valid is required.
boolean	isSourceOnly() Returns property sourceOnly.
void	setPrefix(java.lang.String pPrefix) Sets property prefix.
void	setRequired(boolean pRequired) Set the whether a non-null valid is required.
void	setRequiredOption(Validators.RequiredOption pRequiredOption) Sets property requiredOption.
void	setRequiredProtocol(java.lang.String pRequiredProtocol) Sets property requiredProtocol.
void	setSourceOnly(boolean pSourceOnly) Sets property sourceOnly.
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

getClassesRequired, getClassRequired, getRequiredPredicate, keyMustBePresent, setClassesRequired, setClassRequired, setRequiredPredicate

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

UrlStringValidator

public UrlStringValidator()

UrlStringValidator

public UrlStringValidator(java.lang.String pErrorCode)

UrlStringValidator

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

Method Detail

setRequiredProtocol

public void setRequiredProtocol(java.lang.String pRequiredProtocol)

Sets property requiredProtocol. The required protocol for the URL. If null, any protocol will be allowed.

getRequiredProtocol

public java.lang.String getRequiredProtocol()

Returns property requiredProtocol. The required protocol for the URL.

setRequiredOption

public void setRequiredOption(Validators.RequiredOption pRequiredOption)

Sets property requiredOption. Set the required option.

Specified by:

setRequiredOption in interface ConfigurableValidator<java.lang.String>

Overrides:

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

getRequiredOption

public Validators.RequiredOption getRequiredOption()

Returns property requiredOption. Set the required option.

Specified by:

getRequiredOption in interface ConfigurableValidator<java.lang.String>

Overrides:

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

setSourceOnly

public void setSourceOnly(boolean pSourceOnly)

Sets property sourceOnly. Set to read value from the source only.

Specified by:

setSourceOnly in interface ConfigurableValidator<java.lang.String>

Overrides:

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

isSourceOnly

public boolean isSourceOnly()

Returns property sourceOnly. Set to read value from the source only.

Specified by:

isSourceOnly in interface ConfigurableValidator<java.lang.String>

Overrides:

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

Returns:

if source only, false otherwise.

setRequired

public void setRequired(boolean pRequired)

Set the whether a non-null valid is required.

Overrides:

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

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.

Overrides:

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

Returns:

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

setPrefix

public void setPrefix(java.lang.String pPrefix)

Sets property prefix. A prefix that will be prepended to a non-null URL value before validation.

getPrefix

public java.lang.String getPrefix()

Returns property prefix. A prefix that will be prepended to a non-null URL value before validation.

Returns:

the prefix, if any.

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.