de.hybris.platform.btg.rule.impl

Class AbstractRuleDataContainer<T extends java.io.Serializable>

java.lang.Object

de.hybris.platform.btg.rule.impl.AbstractRuleDataContainer<T>

All Implemented Interfaces:

RuleDataContainer<T>

Direct Known Subclasses:

JaloSessionRuleDataContainer, MockRuleDataContainer

public abstract class AbstractRuleDataContainer<T extends java.io.Serializable>
extends java.lang.Object
implements RuleDataContainer<T>

Default implementation for RuleDataContainer. This implementation is immutable by default - the mutable state is encapsulated in StorageElementsContainer instance, which is accessed using getStorageElementsContainer() method. This gives subclasses a freedom of choice where to keep the mutable state.

Constructor Summary

Constructors

Constructor and Description
AbstractRuleDataContainer()

Method Summary

Modifier and Type	Method and Description
void	add(T element) Adds an element to the container.
void	clear() Removes all elements from the container
boolean	contains(T element) Checks if given element is contained within this container.
void	delete(T element) Removes an element from the container if an element has been added only once.
void	deleteAll(T element) Removes an element from the container regardless of how many times it has been added.
java.util.Collection<T>	getAll() Returns all elements that the container holds.
protected abstract StorageElementsContainer<T>	getStorageElementsContainer() Provides access to actual StorageElementsContainer instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRuleDataContainer

public AbstractRuleDataContainer()

Method Detail

add

public void add(T element)

Description copied from interface: RuleDataContainer

Adds an element to the container. It is legal to call this method many times with the same argument. If an element is added many times, it will still be "visible" only once i.e. the RuleDataContainer.getAll() method will return only one instance of such element. If an element is added many times, the RuleDataContainer.delete(Serializable) method must be called the same number of times to remove it from the container.

Specified by:

add in interface RuleDataContainer<T extends java.io.Serializable>

clear

public void clear()

Description copied from interface: RuleDataContainer

Removes all elements from the container

Specified by:

clear in interface RuleDataContainer<T extends java.io.Serializable>

contains

public boolean contains(T element)

Description copied from interface: RuleDataContainer

Checks if given element is contained within this container.

Specified by:

contains in interface RuleDataContainer<T extends java.io.Serializable>

delete

public void delete(T element)

Description copied from interface: RuleDataContainer

Removes an element from the container if an element has been added only once. If the element has been added many times, this method must also be called the same number of times to actually remove the element.

Specified by:

delete in interface RuleDataContainer<T extends java.io.Serializable>

deleteAll

public void deleteAll(T element)

Description copied from interface: RuleDataContainer

Removes an element from the container regardless of how many times it has been added. This means after calling this method the call to RuleDataContainer.contains(Serializable) will return false.

Specified by:

deleteAll in interface RuleDataContainer<T extends java.io.Serializable>

getAll

public java.util.Collection<T> getAll()

Description copied from interface: RuleDataContainer

Returns all elements that the container holds. Does not contain duplicates. If an element has been added many times, it will be reported only once in the result.

Specified by:

getAll in interface RuleDataContainer<T extends java.io.Serializable>

getStorageElementsContainer

protected abstract StorageElementsContainer<T> getStorageElementsContainer()

Provides access to actual StorageElementsContainer instance.