atg.service.validator

Class PropertyGatherer.PropertyValidatorListener

java.lang.Object

atg.service.validator.PropertyGatherer.PropertyValidatorListener

All Implemented Interfaces:

ValidatorListener, java.lang.AutoCloseable

Enclosing class:

PropertyGatherer

public class PropertyGatherer.PropertyValidatorListener
extends java.lang.Object
implements ValidatorListener, java.lang.AutoCloseable

Our validator listener that records values. Also implements auto-closeable.

Field Summary

Fields inherited from interface atg.service.validator.ValidatorListener

CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
PropertyValidatorListener(ValidatorContext pContext, java.lang.String pPropertyName) Create a new property validator listener, registered as a listener to pContext.

Method Summary

Modifier and Type	Method and Description
void	close() On close, remove ourself as a listener on the validator.
protected void	doInterPropertyValidation(ValidatorContext pContext) Actually do the inter-property validation, by calling validateBean on our bean validator.
void	errorAdded(ValidatorContext pContext, Validator<?> pValidator, java.lang.String pMessage, java.lang.String pPropertyName, java.lang.Throwable pRootCause) Called just after an error was added to ValidatorContext.
boolean	forceValidationOfExistingProperty(ValidatorContext pContext, java.lang.String pPropertyName, java.lang.Object pSource, java.lang.Object pDestination) Give all listeners a chance to say whether a property should be validated.
int	getCurrentDepth() Get the current ancestor depth count, compared to where we started.
protected java.lang.String	getEffectivePropertyName(java.lang.String pPropertyName) Get the effective property name of the given property.
protected boolean	isCorrectDepth() Return whether or not we are the correct depth to be interested in properties.
void	validateBeanPropertyCalled(ValidatorContext pContext, Validator pValidator, java.lang.String pPropertyName, java.lang.Object pBean, java.lang.Object pResult) Called after a beanProperty has been validated.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyValidatorListener

public PropertyValidatorListener(ValidatorContext pContext,
                                 java.lang.String pPropertyName)

Create a new property validator listener, registered as a listener to pContext.

Parameters:

pContext - the validator context to listen on

pPropertyName - the specific property name we are being created for (may be null)

Method Detail

errorAdded

public void errorAdded(ValidatorContext pContext,
                       Validator<?> pValidator,
                       java.lang.String pMessage,
                       java.lang.String pPropertyName,
                       java.lang.Throwable pRootCause)

Description copied from interface: ValidatorListener

Called just after an error was added to ValidatorContext.

Specified by:

errorAdded in interface ValidatorListener

pValidator - the validator on whose behalf the exception was added (can provide an errorCode to use).

pMessage - the user visible message (should be localized)

pPropertyName - the property name to append to the pushed property path on the context. May be null if there is nothing to add.

pRootCause - the throwable to use as a root cause. If non-null, then pRootCause becomes the nested/caused-by exception.

validateBeanPropertyCalled

public void validateBeanPropertyCalled(ValidatorContext pContext,
                                       Validator pValidator,
                                       java.lang.String pPropertyName,
                                       java.lang.Object pBean,
                                       java.lang.Object pResult)

Description copied from interface: ValidatorListener

Called after a beanProperty has been validated. Note that even if there was an error added during validating the problem, this method will still be invoked (presumably with a null value for pResult).

Note that callers of validateBeanProperty() must invoke ValidatorContext.validateBeanPropertyCalled() in order for listeners to get this notification. ValidatorManager (the core bean-property validator) already does so, but not every validator may do so.

Specified by:

validateBeanPropertyCalled in interface ValidatorListener

Parameters:

pContext - the current validation context.

pValidator - the validator that did the validation.

pPropertyName - the name of the property that was validated.

pBean - the bean whose property was validated.

forceValidationOfExistingProperty

public boolean forceValidationOfExistingProperty(ValidatorContext pContext,
                                                 java.lang.String pPropertyName,
                                                 java.lang.Object pSource,
                                                 java.lang.Object pDestination)

Description copied from interface: ValidatorListener

Give all listeners a chance to say whether a property should be validated. Normally, validation can be skipped if a property is missing from pSource.

Specified by:

forceValidationOfExistingProperty in interface ValidatorListener

Parameters:

pContext - the current validation context.

pPropertyName - the name of the property to be validated.

pSource - the bean containing new property values.

pDestination - the bean containing original property values.

Returns:

true if the property in pDestination should be validated.

doInterPropertyValidation

protected void doInterPropertyValidation(ValidatorContext pContext)

Actually do the inter-property validation, by calling validateBean on our bean validator.

Parameters:

pContext - the current validator context.

close

public void close()

On close, remove ourself as a listener on the validator.

Specified by:

close in interface java.lang.AutoCloseable

isCorrectDepth

protected boolean isCorrectDepth()

Return whether or not we are the correct depth to be interested in properties.

Returns:

true if we are at the correct depth, false otherwise.

getCurrentDepth

public int getCurrentDepth()

Get the current ancestor depth count, compared to where we started.

getEffectivePropertyName

protected java.lang.String getEffectivePropertyName(java.lang.String pPropertyName)

Get the effective property name of the given property. Applies any mappings in the remapped property names map.

Parameters:

pPropertyName - the property name (possibly) remap.

Returns:

either pPropertyName, or it's remapped name