com.nt.udc.util.state

Class StateSaver

java.lang.Object

com.nt.udc.util.state.StateSaver

Direct Known Subclasses:

AsynchronousStateSaver

public class StateSaver
extends java.lang.Object

The class will save the state of a set of registered Objects. Be sure no processing takes place while the state is being saved, or the saved state may be inaccurate.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	baseStateDir
protected LoggerIfc	logger
protected java.lang.String	stateBufferFileName
protected StateBufferSaveable[]	stateBufferObjArray
protected DatedStringComparator	stateDirComp
protected FilenameGenerator	stateDirGenerator
protected StateDirectorySaveable[]	stateDirObjArray
protected java.io.FilenameFilter	tmpFilter

Constructor Summary

Constructors

Constructor and Description
StateSaver(LoggerIfc logger, java.io.File baseStateDir) Creates a StateSaver Object.

Method Summary

Modifier and Type	Method and Description
void	saveState() Saves the state of the registered Objects.
void	setBufferArray(StateBufferSaveable[] array) Sets the array of StateBufferSaveable Objects to save.
void	setDirArray(StateDirectorySaveable[] array) Sets the array of StateDirectorySaveable Objects to save.
void	setStateBufferFileName(java.lang.String stateBufferFileName) Sets the current state buffer file.

Methods inherited from class java.lang.Object

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

Field Detail

stateDirObjArray

protected StateDirectorySaveable[] stateDirObjArray

stateBufferObjArray

protected StateBufferSaveable[] stateBufferObjArray

stateBufferFileName

protected java.lang.String stateBufferFileName

logger

protected LoggerIfc logger

baseStateDir

protected java.io.File baseStateDir

stateDirGenerator

protected FilenameGenerator stateDirGenerator

stateDirComp

protected DatedStringComparator stateDirComp

tmpFilter

protected java.io.FilenameFilter tmpFilter

Constructor Detail

StateSaver

public StateSaver(LoggerIfc logger,
                  java.io.File baseStateDir)

Creates a StateSaver Object.

Parameters:

logger - Logger for warnings and errors.

baseStateDir - Location of state sub-directories.

Method Detail

setBufferArray

public void setBufferArray(StateBufferSaveable[] array)

Sets the array of StateBufferSaveable Objects to save.

Parameters:

array - Array of StateBufferSaveable Objects to save.

setDirArray

public void setDirArray(StateDirectorySaveable[] array)

Sets the array of StateDirectorySaveable Objects to save.

Parameters:

array - Array of StateDirectorySaveable Objects to save.

setStateBufferFileName

public void setStateBufferFileName(java.lang.String stateBufferFileName)

Sets the current state buffer file.

Parameters:

stateBufferFileName - Buffer file, containing the states.

saveState

public void saveState()
               throws StateException

Saves the state of the registered Objects.

Throws:

StateException