de.richtercloud.reflection.form.builder.storage

Interface Storage<T,C extends StorageConf>

Type Parameters:

T - the type the storage ought to be restricted

C - the type of configuration this type of storage needs

All Known Implementing Classes:

AbstractStorage, XMLStorage

public interface Storage<T,C extends StorageConf>

Author:

richter

Method Summary

Modifier and Type	Method and Description
void	delete(T object)
C	getStorageConf()
boolean	isStarted()
void	refresh(Object object)
void	registerPostStoreCallback(T object, StorageCallback callback) Registers a callback which is executed right after object is stored with store(java.lang.Object).
void	registerPreStoreCallback(T object, StorageCallback callback) Registers a callback which is executed right before object is stored with store(java.lang.Object).
<U extends T> U	retrieve(Object id, Class<U> clazz) Retrieves the instance with ID id of type clazz from storage.
void	shutdown() Frees eventually aquired resources.
void	start() Starts referenced resources.
void	store(T object)
void	update(T object)

Method Detail

delete

void delete(T object)
     throws StorageException

Throws:

StorageException

store

void store(T object)
    throws StorageException

Throws:

StorageException

retrieve

<U extends T> U retrieve(Object id,
                         Class<U> clazz)
                  throws StorageException

Retrieves the instance with ID id of type clazz from storage.

Type Parameters:

U - allows enforcing a subtype of the type of the storage via the clazz parameter

Parameters:

id -

clazz -

Returns:

the retrieved object

Throws:

StorageException - wraps any exception occuring during storage

update

void update(T object)
     throws StorageException

Throws:

StorageException

refresh

void refresh(Object object)
      throws StorageException

Throws:

StorageException

start

void start()
    throws StorageCreationException

Starts referenced resources. Needs to be called after creating an instance of any subclass (except if the subclass especially states that it's not necessary).

Throws:

StorageCreationException - wraps any exception which occurs during the creation of this storage

isStarted

boolean isStarted()

shutdown

void shutdown()

Frees eventually aquired resources.

getStorageConf

C getStorageConf()

registerPostStoreCallback

void registerPostStoreCallback(T object,
                               StorageCallback callback)
                        throws StorageException

Registers a callback which is executed right after object is stored with store(java.lang.Object). Note that entities are supposed to be equals in all persistent entity states transient, attached, detached and removedhttps://vladmihalcea.com/2014/07/30/a-beginners-guide-to-jpahibernate-entity-state-transitions/ and if they're not this method will explicitly has undefined behaviour.

Parameters:

object - the object the callback ought to be registered for

callback - the callback to register

Throws:

StorageException - wraps any exception occuring during storage

registerPreStoreCallback

void registerPreStoreCallback(T object,
                              StorageCallback callback)
                       throws StorageException

Registers a callback which is executed right before object is stored with store(java.lang.Object). Note that entities are supposed to be equals in all persistent entity states transient, attached, detached and removedhttps://vladmihalcea.com/2014/07/30/a-beginners-guide-to-jpahibernate-entity-state-transitions/ and if they're not this method will explicitly has undefined behaviour.

Parameters:

object - the object the callback ought to be registered for

callback - the callback to register

Throws:

StorageException - wraps any exception occuring during storage