org.granite.client.persistence.collection

Interface PersistentCollection<C>

All Superinterfaces:

java.io.Externalizable, java.io.Serializable

All Known Subinterfaces:

PersistentSortedCollection<C,E>, UnsafePersistentCollection<C>

All Known Implementing Classes:

AbstractPersistentCollection, AbstractPersistentMapCollection, AbstractPersistentSimpleCollection, ObservablePersistentBag, ObservablePersistentList, ObservablePersistentMap, ObservablePersistentSet, ObservablePersistentSortedMap, ObservablePersistentSortedSet, PersistentBag, PersistentList, PersistentMap, PersistentSet, PersistentSortedMap, PersistentSortedSet

public interface PersistentCollection<C>
extends java.io.Externalizable

Base interface for all persistent collections and maps A loader can be defined to execute a particular behaviour when a lazy collection is accessed

Author:

Franck WOLFF

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PersistentCollection.ChangeListener<C> Basic callback interface for change tracking on the collection
static interface	PersistentCollection.InitializationCallback<C> Callback interface for ensuring working on loaded collections/maps
static interface	PersistentCollection.InitializationListener<C> Basic callback interface for loading/unloading
static interface	PersistentCollection.Initializer<C>

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(PersistentCollection.ChangeListener<C> listener) Register a change listener
void	addListener(PersistentCollection.InitializationListener<C> listener) Register a initialization listener
void	clearDirty() Clear the dirty state of the collection
PersistentCollection<C>	clone(boolean uninitialize) Clone a persistent collection
void	dirty() Mark the collection as dirty
Loader<C>	getLoader() Loader for the collection
void	initialize(C content, PersistentCollection.Initializer<C> initializer) Mark the collection as initialized, called after the content is loaded
void	initializing() Mark the collection as currently initializing so next access do not trigger loading
boolean	isDirty() Is the collection dirty ?
void	removeListener(PersistentCollection.ChangeListener<C> listener) Unregister a change listener
void	removeListener(PersistentCollection.InitializationListener<C> listener) Unregister a initialization listener
void	setLoader(Loader<C> loader) Set a loader for the collection
void	uninitialize() Unload the collection and unset its initialized state
boolean	wasInitialized() Was the collection was initialized
void	withInitialized(PersistentCollection.InitializationCallback<C> callback) Execute the specified callback after ensuring the collection has been loaded If it was not loaded, the callack is called asynchronously after loading is complete

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

wasInitialized

boolean wasInitialized()

Was the collection was initialized

Returns:

true if collection initialized

uninitialize

void uninitialize()

Unload the collection and unset its initialized state

initialize

void initialize(C content,
              PersistentCollection.Initializer<C> initializer)

Mark the collection as initialized, called after the content is loaded

initializing

void initializing()

Mark the collection as currently initializing so next access do not trigger loading

clone

PersistentCollection<C> clone(boolean uninitialize)

Clone a persistent collection

Parameters:

uninitialize - true to get an uninitialized clone of a lazy collection

Returns:

cloned collection

getLoader

Loader<C> getLoader()

Loader for the collection

Returns:

loader or null of none defined

setLoader

void setLoader(Loader<C> loader)

Set a loader for the collection

Parameters:

loader - loader that will be called when a lazy collection is accessed

isDirty

boolean isDirty()

Is the collection dirty ?

Returns:

true if the collection has been modified since last server sync

dirty

void dirty()

Mark the collection as dirty

clearDirty

void clearDirty()

Clear the dirty state of the collection

addListener

void addListener(PersistentCollection.ChangeListener<C> listener)

Register a change listener

Parameters:

listener - listener

removeListener

void removeListener(PersistentCollection.ChangeListener<C> listener)

Unregister a change listener

Parameters:

listener - listener

addListener

void addListener(PersistentCollection.InitializationListener<C> listener)

Register a initialization listener

Parameters:

listener - listener

removeListener

void removeListener(PersistentCollection.InitializationListener<C> listener)

Unregister a initialization listener

Parameters:

listener - listener

withInitialized

void withInitialized(PersistentCollection.InitializationCallback<C> callback)

Execute the specified callback after ensuring the collection has been loaded If it was not loaded, the callack is called asynchronously after loading is complete

Parameters:

callback - callback method to execute