org.lsst.ccs.gconsole.services.persist

Interface Persistable

All Superinterfaces:

Savable

All Known Implementing Classes:

AbstractChannelsFilter, Configuration, FilterFixed, FilterMonitored, FilterOutOfRange, GenericFilter, MonitorOnly, States, TestFilter, TestPersistable

public interface Persistable
extends Savable

A component that can be persisted between console sessions using PersistenceService. The save() and restore() methods save/restore the component state to/from a JavaBean. Exactly what is being saved and restored is up to a specific component - in general, one should not expect that saving and then restoring a component will result in an identical object. The getDescriptor() method provides access to the descriptor maintained by this component. Implementations are expected to ensure that any properties set on the descriptor returned by this method are reflected by descriptors subsequently returned by save(), unless modified between the two calls.

Author:

onoprien

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Persistable.Descriptor JavaBean that describes a state of a Persistable component.

Method Summary

Modifier and Type	Method and Description
Persistable.Descriptor	getDescriptor() Returns a reference to the descriptor maintained by this component.
default void	restore(Persistable.Descriptor descriptor) Restores this component to the state specified by the provided JavaBean.
default void	restore(Serializable descriptor) Overrides Savable.restore(Serializable) to forward the call to restore(Descriptor) if the provided argument value is of type Persistable.Descriptor, and do nothing otherwise.
default Persistable.Descriptor	save() Returns JavaBean describing the current state of this component.

Method Detail

restore

default void restore(Serializable descriptor)

Overrides Savable.restore(Serializable) to forward the call to restore(Descriptor) if the provided argument value is of type Persistable.Descriptor, and do nothing otherwise.

Specified by:

restore in interface Savable

Parameters:

descriptor - Descriptor.

restore

default void restore(Persistable.Descriptor descriptor)

Restores this component to the state specified by the provided JavaBean. The default implementation does nothing.

Parameters:

descriptor - JavaBean encapsulating the state.

save

default Persistable.Descriptor save()

Returns JavaBean describing the current state of this component. The default implementation forwards the call to getDescriptor().

Specified by:

save in interface Savable

Returns:

JavaBean encapsulating the state, or null if no state information needs to be saved.

getDescriptor

Persistable.Descriptor getDescriptor()

Returns a reference to the descriptor maintained by this component. Implementations are expected to ensure that this method never returns null, and that any properties set on the descriptor returned by this method are reflected by descriptors subsequently returned by save(), unless modified between the two calls.

Returns:

JavaBean describing this component.