ValidatorContext (ATG Java API)

java.lang.Object
- atg.service.validator.ValidatorContext<E>

Direct Known Subclasses:

ValidatorContext.ValidatorContextImpl
```
public abstract class ValidatorContext<E extends java.lang.Exception>
extends java.lang.Object
```
Holds contextual information during an update. Primarily the stack of parents.
Created: August 07 2014

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ValidatorContext.StackRestorer` A utility class for restoring the stack.
`static class`	`ValidatorContext.UpdateMode` The update mode.
`static class`	`ValidatorContext.ValidatorContextImpl`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

protected static VariableArgumentApplicationLogging LOGGER
The logger to use.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`protected static VariableArgumentApplicationLogging`	`LOGGER` The logger to use.

Constructor Summary

Constructors
Constructor and Description

ValidatorContext(boolean pCreate)
Create a new validator context.

Constructors
Constructor and Description
`ValidatorContext(boolean pCreate)` Create a new validator context.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addException(Validator<?> pValidator, java.lang.String pMessage, java.lang.String pPropertyName, java.lang.Throwable pRootCause)` Add an exception with the specified message.
`void`	`addPropertyValueChangeListeners(PropertyValueChangeListener pListener)` Add new property change listener
`void`	`addValidatorListener(ValidatorListener pListener)` Add the specified validator listener.
`protected void`	`appendPropertyPath(java.lang.StringBuilder pBuilder)` Append the current parent property path to pBuilder.
`boolean`	`canApplyUpdatesToTarget()` Returns property applyUpdatesToTarget.
`void`	`checkForPropertyValueChange(java.lang.Object pBean, java.lang.String pPropertyName, java.lang.Object pNewValue)` Called by the framework to determine if a property value has changed.
`protected abstract E`	`createException(Validator<?> pValidator, java.lang.String pMessage, java.lang.String pPropertyName, java.lang.Throwable pRootCause)` Create an exception of the parameterized subtype.
`void`	`dumpWherePushed()`
`void`	`dumpWherePushedNames()`
`boolean`	`forceValidationOfExistingProperty(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.
`java.util.Set<java.lang.String>`	`getAllowableUnknownPropertyNames()` Gets the allowable unknown property names.
`int`	`getAncestorCount()` Return the number of ancestors on the stack.
`java.lang.Object`	`getAncestorDst(int pIndex)` Get the specified destination ancester, relative to the size.
`java.lang.Object`	`getAncestorSrc(int pIndex)` Get the specified source ancester, relative to the size.
`<T> T`	`getAttribute(java.lang.String pName)` Get the specified attribute to the specified name.
`java.util.Map<java.lang.String,java.lang.Object>`	`getAttributes()` Returns property attributes.
`java.lang.String`	`getDefaultErrorCode()` Returns property defaultErrorCode.
`<T> T`	`getDstParentOfClass(java.lang.Class<T> pParentClass)` Return the parent of the specified class.
`int`	`getErrorCount()` Return the error count property.
`java.util.List<E>`	`getErrors()` Return the exceptions property.
`java.util.List<java.lang.String>`	`getFilter()` Returns property filter.
`int`	`getParentCount()` Get a count of the number of parents.
`java.lang.Object`	`getParentDst()` Get the immediate parent.
`protected <T> T`	`getParentOfClass(java.lang.Class<T> pParentClass, java.util.List<java.lang.Object> pParents)` Get a parent of the specified class.
`java.lang.String`	`getParentPropertyName()` Get the parent property name.
`atg.core.util.ArrayStack<java.lang.Object>`	`getParentsDst()` The current set of desination parent beans being updated.
`java.lang.Object`	`getParentSrc()` Get the immediate parent.
`atg.core.util.ArrayStack<java.lang.Object>`	`getParentsSrc()` The current set of source parent beans being updated.
`atg.core.util.ArrayStack<java.lang.String>`	`getPropertyNames()` Get the stack of property names.
`java.lang.String`	`getPropertyPath()` Get the parent current property path.
`java.lang.String`	`getPropertyPath(java.lang.String pPropertyName)` Get the property path, with pPropertyName as the last property.
`atg.service.validator.RepositoryItemHelper`	`getRepositoryItemHelper()` Get Repository Item Helper
`<T> T`	`getSrcParentOfClass(java.lang.Class<T> pParentClass)` Return the source parent of the specified class.
`ValidatorContext.UpdateMode`	`getUpdateMode()` Returns property updateMode.
`java.util.List<ValidatorListener>`	`getValidatorListeners()` Returns property validatorListeners.
`boolean`	`hasErrors()` Whether we have any errors on our context.
`boolean`	`isCreate()` Whether this is a create operation.
`boolean`	`isFetchingValueForCopy()` Returns property fetchingValueForCopy.
`boolean`	`isFilterForInclude()` Returns property filterForInclude.
`boolean`	`isModifiedValue()` Returns property modifiedValue.
`boolean`	`isNullOutPresentButNullProperties()` Returns property nullOutPresentButNullProperties.
`boolean`	`isShouldRecurse()` Returns property shouldRecurse.
`boolean`	`isSourceUsesExternalPropertyNames()` Returns property sourceUsesExternalPropertyNames.
`boolean`	`isSuccess()` Whether or not we are successful.
`boolean`	`isTreatUnknownPropertiesAsErrors()` Returns property treatUnknownPropertiesAsErrors.
`boolean`	`isUpdate()` Whether this is an update operation.
`boolean`	`isUpdating()` Returns property updating.
`boolean`	`isValidateExistingProperties()` Returns property validateExistingProperties.
`boolean`	`notifyIfPropertyValueChanged(java.lang.Object pBean, java.lang.String pPropertyName, java.lang.Object pNewValue, java.lang.Object pOldValue)` Called by the framework to determine if a property value has changed.
`java.lang.String`	`peekPropertyName()` Return the most recently added property name on the property names stack.
`void`	`popParents()` Pop pair of src/dst parents from the context stack.
`void`	`popParents(java.lang.Object pSrc, java.lang.Object pDst)` Pop pair of src/dst parents from the context stack.
`java.lang.String`	`popPropertyName()` Pop the current property name from the stack.
`void`	`pushParents(java.lang.Object pParentSrc, java.lang.Object pParentDst)` Push a parent onto the context stack.
`ValidatorContext.StackRestorer`	`pushParentsIfNeeded(java.lang.Object pParentSrc, java.lang.Object pParentDst)` Push parents if needed.
`void`	`pushPropertyName(java.lang.String pPropertyName)` Push the current property name being processed onto the stack.
`<T> T`	`removeAttribute(java.lang.String pName)` remove the specified attribute.
`void`	`removePropertyValueChangeListeners(PropertyValueChangeListener pListener)` Remove a property change listener
`void`	`removeValidatorListener(ValidatorListener pListener)` Remove the specified validator listener.
`void`	`replaceParentDst(java.lang.Object pNew)` Replace the current destination parent.
`void`	`setAllowableUnknownPropertyNames(java.util.Set<java.lang.String> pAllowableUnknownPropertyNames)` Sets the allowable unknown property names.
`void`	`setApplyUpdatesToTarget(boolean pApplyUpdatesToTarget)` Sets property applyUpdatesToTarget.
`void`	`setAttribute(java.lang.String pName, java.lang.Object pValue)` Set the specified attribute to the specified name.
`void`	`setCreate(boolean pCreate)` Set the create flag.
`void`	`setDefaultErrorCode(java.lang.String pDefaultErrorCode)` Sets property defaultErrorCode.
`void`	`setErrors(java.util.List<E> pErrors)` Replace our list of errors.
`void`	`setFetchingValueForCopy(boolean pFetchingValueForCopy)` Sets property fetchingValueForCopy.
`void`	`setFilter(java.util.List<java.lang.String> pFilter)` Sets property filter.
`void`	`setFilterForInclude(boolean pFilterForInclude)` Sets property filterForInclude.
`void`	`setModifiedValue(boolean pModifiedValue)` Sets property modifiedValue.
`void`	`setNullOutPresentButNullProperties(boolean pNullOutPresentButNullProperties)` Sets property nullOutPresentButNullProperties.
`void`	`setRepositoryItemHelper(atg.service.validator.RepositoryItemHelper pRepositoryItemHelper)` Set Repository Item Helper
`void`	`setShouldRecurse(boolean pShouldRecurse)` Sets property shouldRecurse.
`void`	`setSourceUsesExternalPropertyNames(boolean pSourceUsesExternalPropertyNames)` Sets property sourceUsesExternalPropertyNames.
`void`	`setTreatUnknownPropertiesAsErrors(boolean pTreatUnknownPropertiesAsErrors)` Sets property treatUnknownPropertiesAsErrors.
`void`	`setUpdateMode(ValidatorContext.UpdateMode pUpdateMode)` Sets property updateMode.
`void`	`setUpdating(boolean pUpdating)` Sets property updating.
`void`	`setValidateExistingProperties(boolean pValidateExistingProperties)` Sets property validateExistingProperties.
`void`	`setValidatorListeners(java.util.List<ValidatorListener> pValidatorListeners)` Sets property validatorListeners.
`void`	`throwException()`
`void`	`validateBeanPropertyCalled(Validator pValidator, java.lang.String pPropertyName, java.lang.Object pBean, java.lang.Object pResult)` Should be called after a beanProperty has been validated.
`static boolean`	`valuesDiffer(java.lang.Object pObj1, java.lang.Object pObj2)` Utility method for checking equality between 2 objects

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - LOGGER
```
protected static final VariableArgumentApplicationLogging LOGGER
```
    The logger to use.
- Constructor Detail
  - ValidatorContext
```
public ValidatorContext(boolean pCreate)
```
    Create a new validator context.
    
    Parameters:
    
    pCreate - if true, this is for a create, if false, is for an update.
- Method Detail
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
```
    Returns property attributes. A bag o' attributes to hold any extra needed data.
  - setAttribute
```
public void setAttribute(java.lang.String pName,
                         java.lang.Object pValue)
```
    Set the specified attribute to the specified name.
  - getAttribute
```
public <T> T getAttribute(java.lang.String pName)
```
    Get the specified attribute to the specified name.
  - removeAttribute
```
public <T> T removeAttribute(java.lang.String pName)
```
    remove the specified attribute.
  - setCreate
```
public void setCreate(boolean pCreate)
```
    Set the create flag. This may need to be invoked when one needs to create a new sub-item on an existing bean.
  - isCreate
```
public boolean isCreate()
```
    Whether this is a create operation.
  - isUpdate
```
public boolean isUpdate()
```
    Whether this is an update operation.
  - getErrors
```
public java.util.List<E> getErrors()
```
    Return the exceptions property.
    
    Returns:
    
    the (possibly empty) list of errors.
  - setErrors
```
public void setErrors(java.util.List<E> pErrors)
```
    Replace our list of errors.
    
    Parameters:
    
    pList - the list to use. Any errors will be added to this instance.
  - setFetchingValueForCopy
```
public void setFetchingValueForCopy(boolean pFetchingValueForCopy)
```
    Sets property fetchingValueForCopy. True if we currently fetching a value for an property copy.
  - isFetchingValueForCopy
```
public boolean isFetchingValueForCopy()
```
    Returns property fetchingValueForCopy. True if we currently fetching a value for an property copy.
  - setNullOutPresentButNullProperties
```
public void setNullOutPresentButNullProperties(boolean pNullOutPresentButNullProperties)
```
    Sets property nullOutPresentButNullProperties. Whether to null out target properties if there is a source property present in the source map or JSON object.
  - isNullOutPresentButNullProperties
```
public boolean isNullOutPresentButNullProperties()
```
    Returns property nullOutPresentButNullProperties. Whether to null out target properties if there is a source property present in the source map or JSON object.
  - setSourceUsesExternalPropertyNames
```
public void setSourceUsesExternalPropertyNames(boolean pSourceUsesExternalPropertyNames)
```
    Sets property sourceUsesExternalPropertyNames. Whether the source of an update uses external property names.
  - isSourceUsesExternalPropertyNames
```
public boolean isSourceUsesExternalPropertyNames()
```
    Returns property sourceUsesExternalPropertyNames. Whether the source of an update uses external property names.
    
    Returns:
    
    true if the source uses external property names.
  - getErrorCount
```
public int getErrorCount()
```
    Return the error count property. The number of errors/exceptions that have been added.
  - hasErrors
```
public boolean hasErrors()
```
    Whether we have any errors on our context.
  - isSuccess
```
public boolean isSuccess()
```
    Whether or not we are successful.
  - setShouldRecurse
```
public void setShouldRecurse(boolean pShouldRecurse)
```
    Sets property shouldRecurse. Whether updates should be recursive, if there are any ValidatorManagerValidators to handle bean-ish sub-properties. Defaults to true.
  - isShouldRecurse
```
public boolean isShouldRecurse()
```
    Returns property shouldRecurse. Whether updates should be recursive, if there are any ValidatorManagerValidators to handle bean-ish sub-properties. Defaults to true.
  - setFilter
```
public void setFilter(java.util.List<java.lang.String> pFilter)
```
    Sets property filter. A list of the properties to include or exclude (see filterForInclude).
  - getFilter
```
public java.util.List<java.lang.String> getFilter()
```
    Returns property filter. A list of the properties to include or exclude (see filterForInclude).
  - setFilterForInclude
```
public void setFilterForInclude(boolean pFilterForInclude)
```
    Sets property filterForInclude. Whether the filter is for include or exclude. Defaults to false (filter, if any, is for excludes).
  - isFilterForInclude
```
public boolean isFilterForInclude()
```
    Returns property filterForInclude. Whether the filter is for include or exclude. Defaults to false (filter, if any, is for excludes).
  - setModifiedValue
```
public void setModifiedValue(boolean pModifiedValue)
```
    Sets property modifiedValue. Whether we have modified a value (called setProperty).
  - isModifiedValue
```
public boolean isModifiedValue()
```
    Returns property modifiedValue. Whether we have modified a value (called setProperty).
  - setTreatUnknownPropertiesAsErrors
```
public void setTreatUnknownPropertiesAsErrors(boolean pTreatUnknownPropertiesAsErrors)
```
    Sets property treatUnknownPropertiesAsErrors. Whether to treat properties that don't have validators as errors.
  - isTreatUnknownPropertiesAsErrors
```
public boolean isTreatUnknownPropertiesAsErrors()
```
    Returns property treatUnknownPropertiesAsErrors. Whether to treat properties that don't have validators as errors.
  - setDefaultErrorCode
```
public void setDefaultErrorCode(java.lang.String pDefaultErrorCode)
```
    Sets property defaultErrorCode. An error code to be the default error code.
  - getDefaultErrorCode
```
public java.lang.String getDefaultErrorCode()
```
    Returns property defaultErrorCode. An error code to be the default error code.
  - setValidateExistingProperties
```
public void setValidateExistingProperties(boolean pValidateExistingProperties)
```
    Sets property validateExistingProperties. Whether to validate existing properties.
  - isValidateExistingProperties
```
public boolean isValidateExistingProperties()
```
    Returns property validateExistingProperties. Whether to validate existing properties.
  - setUpdating
```
public void setUpdating(boolean pUpdating)
```
    Sets property updating. True if an update is in progress, false if we are only validating.
  - isUpdating
```
public boolean isUpdating()
```
    Returns property updating. True if an update is in progress, false if we are only validating.
  - canApplyUpdatesToTarget
```
public boolean canApplyUpdatesToTarget()
```
    Returns property applyUpdatesToTarget. True if we can update the target with property value changes, otherwise false.
    
    Returns:
    
    if we can apply property changes otherwise
  - setApplyUpdatesToTarget
```
public void setApplyUpdatesToTarget(boolean pApplyUpdatesToTarget)
```
    Sets property applyUpdatesToTarget. True if we can update the target with property value changes, otherwise false.
    
    Parameters:
    
    pCanApplyUpdateToTarget - property value to set
  - addPropertyValueChangeListeners
```
public void addPropertyValueChangeListeners(PropertyValueChangeListener pListener)
```
    Add new property change listener
    
    Parameters:
    
    pListener - of type PropertyValueChangeListener
  - removePropertyValueChangeListeners
```
public void removePropertyValueChangeListeners(PropertyValueChangeListener pListener)
```
    Remove a property change listener
    
    Parameters:
    
    pListener - of type PropertyValueChangeListener
  - setRepositoryItemHelper
```
public void setRepositoryItemHelper(atg.service.validator.RepositoryItemHelper pRepositoryItemHelper)
```
    Set Repository Item Helper
    
    Parameters:
    
    pRepositoryItemHelper - of type RepositoryItemHelper
  - getRepositoryItemHelper
```
public atg.service.validator.RepositoryItemHelper getRepositoryItemHelper()
```
    Get Repository Item Helper
    
    Returns:
    
    the set Repository Item Helper
  - getParentsSrc
```
public atg.core.util.ArrayStack<java.lang.Object> getParentsSrc()
```
    The current set of source parent beans being updated. Note this should only be modified by methods on this class, not directly.
  - getParentCount
```
public int getParentCount()
```
    Get a count of the number of parents.
  - getParentPropertyName
```
public java.lang.String getParentPropertyName()
```
    Get the parent property name. May return null.
  - getParentOfClass
```
protected <T> T getParentOfClass(java.lang.Class<T> pParentClass,
                                 java.util.List<java.lang.Object> pParents)
```
    Get a parent of the specified class.
    
    Parameters:
    
    pParentClass - class to return the first parent of
    
    pParents - the stack of parents.
  - getSrcParentOfClass
```
public <T> T getSrcParentOfClass(java.lang.Class<T> pParentClass)
```
    Return the source parent of the specified class.
  - getParentsDst
```
public atg.core.util.ArrayStack<java.lang.Object> getParentsDst()
```
    The current set of desination parent beans being updated.
  - getDstParentOfClass
```
public <T> T getDstParentOfClass(java.lang.Class<T> pParentClass)
```
    Return the parent of the specified class.
  - pushParents
```
public void pushParents(java.lang.Object pParentSrc,
                        java.lang.Object pParentDst)
```
    Push a parent onto the context stack.
    
    Parameters:
    
    pParentSrc - our source bean
    
    pParentDst - our destination bean
  - pushParentsIfNeeded
```
public ValidatorContext.StackRestorer pushParentsIfNeeded(java.lang.Object pParentSrc,
                                                          java.lang.Object pParentDst)
```
    Push parents if needed.
    
    Parameters:
    
    pParentSrc - our source bean
    
    pParentDst - our destination bean (may be null).
    
    Returns:
    
    null if nothing was pushed/altered. Otherwise, return an object that can be used to restore the state of the stack.
  - popParents
```
public void popParents()
```
    Pop pair of src/dst parents from the context stack.
  - popParents
```
public void popParents(java.lang.Object pSrc,
                       java.lang.Object pDst)
```
    Pop pair of src/dst parents from the context stack.
  - dumpWherePushed
```
public void dumpWherePushed()
```
  - dumpWherePushedNames
```
public void dumpWherePushedNames()
```
  - getAncestorCount
```
public int getAncestorCount()
```
    Return the number of ancestors on the stack.
  - getParentSrc
```
public java.lang.Object getParentSrc()
```
    Get the immediate parent.
  - getAncestorSrc
```
public java.lang.Object getAncestorSrc(int pIndex)
```
    Get the specified source ancester, relative to the size. Therefore, 1 means get the parent source object, 2 means get the grandparent source object, etc.
    
    Parameters:
    
    pIndex - the index specifying how many generations to go up. Must be at least 1 (for immediate parent).
  - getParentDst
```
public java.lang.Object getParentDst()
```
    Get the immediate parent.
  - getAncestorDst
```
public java.lang.Object getAncestorDst(int pIndex)
```
    Get the specified destination ancester, relative to the size. Therefore, 1 means get the parent destination object, 2 means get the grandparent destination object, etc.
    
    Parameters:
    
    pIndex - the index specifying how many generations to go up. Must be at least 1 (for immediate parent).
  - replaceParentDst
```
public void replaceParentDst(java.lang.Object pNew)
```
    Replace the current destination parent. This method may be invoked if the old destination parent was null, and a target object has since been created. It may also be invoked when the target object is immutable, and must be replaced. Note that parents should have been previously pushed.
    
    Parameters:
    
    pNew - the new destination parent.
  - pushPropertyName
```
public void pushPropertyName(java.lang.String pPropertyName)
```
    Push the current property name being processed onto the stack. The property name can either be a proper property name (like "homeAddress") or an array index using brackets (like "[0]").
    
    Parameters:
    
    pPropertyName - the property name to push. Should not be null.
  - popPropertyName
```
public java.lang.String popPropertyName()
```
    Pop the current property name from the stack.
    
    Returns:
    
    the property name from the stack.
  - peekPropertyName
```
public java.lang.String peekPropertyName()
```
    Return the most recently added property name on the property names stack.
    
    Returns:
    
    the most resent property name or null.
  - getPropertyNames
```
public atg.core.util.ArrayStack<java.lang.String> getPropertyNames()
```
    Get the stack of property names.
  - appendPropertyPath
```
protected void appendPropertyPath(java.lang.StringBuilder pBuilder)
```
    Append the current parent property path to pBuilder.
    
    Parameters:
    
    pBuilder - the string build to append the property path to.
  - getPropertyPath
```
public java.lang.String getPropertyPath()
```
    Get the parent current property path. Depends on validators having called pushPropertyName.
    
    Returns:
    
    the parent property path in dot notation.
  - getPropertyPath
```
public java.lang.String getPropertyPath(java.lang.String pPropertyName)
```
    Get the property path, with pPropertyName as the last property.
    
    Parameters:
    
    pPropertyName - the property name to use as the last property name in the property path.
    
    Returns:
    
    the property path in dot notation.
  - setUpdateMode
```
public void setUpdateMode(ValidatorContext.UpdateMode pUpdateMode)
```
    Sets property updateMode. The current update mode.
  - getUpdateMode
```
public ValidatorContext.UpdateMode getUpdateMode()
```
    Returns property updateMode. The current update mode.
  - getAllowableUnknownPropertyNames
```
public java.util.Set<java.lang.String> getAllowableUnknownPropertyNames()
```
    Gets the allowable unknown property names. These are the names of properties which are not defined in the schema xml but which shouldn't be treated as unknown (i.e. shouldn't cause a validation error). An example would be the Hal "links" property
    
    Returns:
    
    allowable unknown property names
  - setAllowableUnknownPropertyNames
```
public void setAllowableUnknownPropertyNames(java.util.Set<java.lang.String> pAllowableUnknownPropertyNames)
```
    Sets the allowable unknown property names. These are the names of properties which are not defined in the schema xml but which shouldn't be treated as unknown (i.e. shouldn't cause a validation error). An example would be the Hal "links" property
    
    Parameters:
    
    pAllowableUnknownPropertyNames - - allowable unknown property names to set
  - setValidatorListeners
```
public void setValidatorListeners(java.util.List<ValidatorListener> pValidatorListeners)
```
    Sets property validatorListeners. The list of validator listeners.
  - getValidatorListeners
```
public java.util.List<ValidatorListener> getValidatorListeners()
```
    Returns property validatorListeners. The list of validator listeners.
  - addValidatorListener
```
public void addValidatorListener(ValidatorListener pListener)
```
    Add the specified validator listener.
    
    Parameters:
    
    pListener - the listener to add.
  - removeValidatorListener
```
public void removeValidatorListener(ValidatorListener pListener)
```
    Remove the specified validator listener.
    
    Parameters:
    
    pListener - the listener to add.
  - checkForPropertyValueChange
```
public void checkForPropertyValueChange(java.lang.Object pBean,
                                        java.lang.String pPropertyName,
                                        java.lang.Object pNewValue)
```
    Called by the framework to determine if a property value has changed. Method gets the current "old value" and delegates the overloaded checkForPropertyValueChange method
    
    Parameters:
    
    pBean - - target bean
    
    pPropertyName - - property name
    
    pNewValue - - new value
  - notifyIfPropertyValueChanged
```
public boolean notifyIfPropertyValueChanged(java.lang.Object pBean,
                                            java.lang.String pPropertyName,
                                            java.lang.Object pNewValue,
                                            java.lang.Object pOldValue)
```
    Called by the framework to determine if a property value has changed. If so notify any property change listeners and return true; otherwise return false;
    
    Parameters:
    
    pBean - - target bean
    
    pPropertyName - - property name
    
    pNewValue - - new value
    
    pExistingValue - - existing value
  - valuesDiffer
```
public static boolean valuesDiffer(java.lang.Object pObj1,
                                   java.lang.Object pObj2)
```
    Utility method for checking equality between 2 objects
    
    Parameters:
    
    pObj1 - - 1st object to compare
    
    pObj2 - - 2nd object to compare
    
    Returns:
    
    if the objects differ otherwise
  - addException
```
public void addException(Validator<?> pValidator,
                         java.lang.String pMessage,
                         java.lang.String pPropertyName,
                         java.lang.Throwable pRootCause)
```
    Add an exception with the specified message.
    
    Parameters:
    
    pValidator - the validator on whose behalf the exception is being 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.
  - createException
```
protected abstract E createException(Validator<?> pValidator,
                                     java.lang.String pMessage,
                                     java.lang.String pPropertyName,
                                     java.lang.Throwable pRootCause)
```
    Create an exception of the parameterized subtype.
    
    Parameters:
    
    pValidator - the validator on whose behalf the exception is being 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.
    
    Returns:
    
    the created exception.
  - throwException
```
public void throwException()
                    throws E extends java.lang.Exception
```
    Throws:
    
    E extends java.lang.Exception
  - validateBeanPropertyCalled
```
public void validateBeanPropertyCalled(Validator pValidator,
                                       java.lang.String pPropertyName,
                                       java.lang.Object pBean,
                                       java.lang.Object pResult)
```
    Should be called after a beanProperty has been validated. Note that even if there was an error added during validating the property, 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.
    
    Parameters:
    
    pValidator - the validator that did the validation.
    
    pPropertyName - the name of the property that was validated.
    
    pBean - the bean whose property wasvalidated.
    
    pResult - the result of validation (may be null).
  - forceValidationOfExistingProperty
```
public boolean forceValidationOfExistingProperty(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. Normally, validation can be skipped if a property is missing from pSource.
    
    Parameters:
    
    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.

Class ValidatorContext<E extends java.lang.Exception>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

LOGGER

Constructor Detail

ValidatorContext

Method Detail

getAttributes

setAttribute

getAttribute

removeAttribute

setCreate

isCreate

isUpdate

getErrors

setErrors

setFetchingValueForCopy

isFetchingValueForCopy

setNullOutPresentButNullProperties

isNullOutPresentButNullProperties

setSourceUsesExternalPropertyNames

isSourceUsesExternalPropertyNames

getErrorCount

hasErrors

isSuccess

setShouldRecurse

isShouldRecurse

setFilter

getFilter

setFilterForInclude

isFilterForInclude

setModifiedValue

isModifiedValue

setTreatUnknownPropertiesAsErrors

isTreatUnknownPropertiesAsErrors

setDefaultErrorCode

getDefaultErrorCode

setValidateExistingProperties

isValidateExistingProperties

setUpdating

isUpdating

canApplyUpdatesToTarget

setApplyUpdatesToTarget

addPropertyValueChangeListeners

removePropertyValueChangeListeners

setRepositoryItemHelper

getRepositoryItemHelper

getParentsSrc

getParentCount

getParentPropertyName

getParentOfClass

getSrcParentOfClass

getParentsDst

getDstParentOfClass

pushParents

pushParentsIfNeeded

popParents

popParents

dumpWherePushed

dumpWherePushedNames

getAncestorCount

getParentSrc

getAncestorSrc

getParentDst

getAncestorDst

replaceParentDst

pushPropertyName

popPropertyName

peekPropertyName

getPropertyNames

appendPropertyPath

getPropertyPath

getPropertyPath

setUpdateMode

getUpdateMode