org.eclipse.osbp.runtime.common.state

Interface IDataState

All Known Implementing Classes:

DataState, DirtyDataAwareGlobalState, DirtyDataState, GlobalDataState

public interface IDataState

Different versions of objects may be available. For instance a changed and an unchanged version of a bean. This class is responsible to handle beans and offer them in a common context. It caches registered beans in a GC-aware manner.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDataState.Hashing Returns the hash code or key for the given object.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object key) Returns true, if a dirty version of the given object is available.
boolean	empty() Returns true if the cache is empty.
Object	get(Object key) Returns the dirty version of the object if available.
void	invalidate(Object key) Invalidates the object with the given key.
void	register(Object key, Object object) Registers the given object by the passed key.
void	registerAll(Collection<Object> objects, IDataState.Hashing hasher) Registers all objects provided by the collection.
long	size() Returns the size of the cached objects.

Method Detail

size

long size()

Returns the size of the cached objects.

Returns:

the size

empty

boolean empty()

Returns true if the cache is empty.

Returns:

true, if successful

contains

boolean contains(Object key)

Returns true, if a dirty version of the given object is available.

Parameters:

key - the key

Returns:

true, if successful

get

Object get(Object key)

Returns the dirty version of the object if available.

Parameters:

key - the key

Returns:

the object

register

void register(Object key,
              Object object)

Registers the given object by the passed key.

Parameters:

key - the key

object - the object

registerAll

void registerAll(Collection<Object> objects,
                 IDataState.Hashing hasher)

Registers all objects provided by the collection. The hasher is used, to calculate proper keys for the map.

Parameters:

objects - the objects

hasher - the hasher

invalidate

void invalidate(Object key)

Invalidates the object with the given key.

Parameters:

key - the key