de.hybris.platform.btg.rule

Interface RuleDataContainer<T extends java.io.Serializable>

Type Parameters:

T - Data type of the elements that the container holds.

All Known Implementing Classes:

AbstractRuleDataContainer, JaloSessionRuleDataContainer, MockRuleDataContainer

public interface RuleDataContainer<T extends java.io.Serializable>

Provides access to runtime BTG rule data. This data might be too volatile to be stored in database (e.g. information about HTTP requests that user makes in a web shop). This interface allows BTG framework to access such data. This container is intended to work in a multi-threaded environment. To support this, there are certain guarantees:

• Container keeps track of how many times the same element has been added using add(Serializable) method.
• If an element has been added several times, it is removed only after the delete(Serializable) method is called the same number of times.

This guarantees that if multiple threads perform a processing like: add() ... someOperation ... remove(), then the container will provide correct information about contained elements. The getAll() method returns "unified" view of the data, which means that if many threads will insert the same element, it will be reported only once.

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.

Method Detail

add

void add(T element)

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 getAll() method will return only one instance of such element. If an element is added many times, the delete(Serializable) method must be called the same number of times to remove it from the container.

contains

boolean contains(T element)

Checks if given element is contained within this container.

clear

void clear()

Removes all elements from the container

delete

void delete(T element)

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.

deleteAll

void deleteAll(T element)

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

getAll

java.util.Collection<T> getAll()

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.