atg.service.validator

Interface MapUpdateHelper<C,I>

All Superinterfaces:

ContainerUpdateHelper<C,I>

public interface MapUpdateHelper<C,I>
extends ContainerUpdateHelper<C,I>

A very simple-minded MapUpdateHelper used by MapUpdatingValidator.

Created: October 03 2015

See Also:

MapUpdatingValidator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
void	putNewTargetValue(C pTargetMap, java.lang.String pKey, I pTargetValue, ValidatorContext<?> pContext) Add a put a target value to the target map.
void	removeKeyFromMap(java.lang.String pKey, java.lang.Object pMapDst, ValidatorContext<?> pContext) Remove the key pKey from the map pMapDst.

Methods inherited from interface atg.service.validator.ContainerUpdateHelper

createMatchingTargetAlsoAdds, createMatchingTargetItem, createTargetContainer, createTargetContainerAlsoSetsAsProperty

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

removeKeyFromMap

void removeKeyFromMap(java.lang.String pKey,
                      java.lang.Object pMapDst,
                      ValidatorContext<?> pContext)
               throws PropertyNotFoundException

Remove the key pKey from the map pMapDst. Default implementation simply calls pMapDst.remove(pKey), but subclasses can override if extra (or different) processing is needed to remove the map entry and dispose of the associated value object.

Parameters:

pKey - the key to remove from the map

pMapDst - the destination map from which to remove the key

pContext - the current update context.

Throws:

PropertyNotFoundException

putNewTargetValue

void putNewTargetValue(C pTargetMap,
                       java.lang.String pKey,
                       I pTargetValue,
                       ValidatorContext<?> pContext)
                throws PropertyNotFoundException

Add a put a target value to the target map. Default implementation just does an put. Some implementers may need to displose/unlinnk the old key, or call other code to add to the map.

Parameters:

pTargetMap - the map to add the value to.

pKey - the key to add to the target map.

pTargetValue - the new value to add to the map.

pContext - the update context.

Throws:

PropertyNotFoundException