org.lsst.ccs.gconsole.util.session

Class AbstractSavable

java.lang.Object

org.lsst.ccs.gconsole.util.session.AbstractSavable

All Implemented Interfaces:

Savable

public abstract class AbstractSavable
extends Object
implements Savable

Adapter class intended to simplify implementing Savable interface.

Author:

onoprien

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSavable() Default constructor.
protected	AbstractSavable(Serializable descriptor) Constructs an instance, setting the state descriptor instance.

Method Summary

Modifier and Type	Method and Description
Serializable	getDescriptor() Returns a reference to the state descriptor maintained by this class.
void	restore(Serializable descriptor) Restores this component to the state specified by the provided descriptor.
Serializable	save() Returns JavaBean describing the current state of this component.
void	setDescriptor(Serializable descriptor) Sets the maintained by this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSavable

protected AbstractSavable()

Default constructor. The state descriptor instance is not set.

AbstractSavable

protected AbstractSavable(Serializable descriptor)

Constructs an instance, setting the state descriptor instance.

Parameters:

descriptor - JavaBean encapsulating the state.

Method Detail

getDescriptor

public Serializable getDescriptor()

Returns a reference to the state descriptor maintained by this class.

Returns:

JavaBean encapsulating the state, or null if the state descriptor has not been set.

setDescriptor

public void setDescriptor(Serializable descriptor)

Sets the maintained by this class.

Parameters:

descriptor - JavaBean encapsulating the state.

restore

public void restore(Serializable descriptor)

Restores this component to the state specified by the provided descriptor. The default implementation provided by this class forwards the call to setDescriptor(java.io.Serializable).

Specified by:

restore in interface Savable

Parameters:

descriptor - JavaBean encapsulating the state.

save

public Serializable save()

Returns JavaBean describing the current state of this component. The default implementation provided by this class 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.