com.nt.udc.util.state

Class StateManager

java.lang.Object

com.nt.udc.util.state.StateManager

Direct Known Subclasses:

AsynchronousStateManager, SynchronousStateManager

public abstract class StateManager
extends java.lang.Object

The StateManager is responsible for holding a set of StateDirectorySaveable or StateBufferSaveable Objects, and saving/restoring those Objects when told to.

Field Summary

Fields

Modifier and Type	Field and Description
protected StateFreezable[]	activeObjArray
protected int[]	activeObjListenersArray
protected java.io.File	baseStateDir
protected LoggerIfc	logger
protected java.io.File	scratchDir
protected java.lang.String	stateBufferFileName
protected StateBufferSaveable[]	stateBufferObjArray
protected StateDirectorySaveable[]	stateDirObjArray

Constructor Summary

Constructors

Constructor and Description
StateManager(LoggerIfc logger, java.io.File scratchDir) Creates the default StateManager
StateManager(LoggerIfc logger, java.io.File scratchDir, java.lang.String stateBufferFileName) Creates the StateManager with a buffer file.

Method Summary

Methods

Modifier and Type	Method and Description
abstract StateManagementType	getType() Returns this type of StateManager.
void	manageActiveObject(StateFreezable activeObject) Manages a single active Object.
void	manageState(StateBufferSaveable state) Adds a single StateBufferSaveable object to be managed.
void	manageState(StateDirectorySaveable state) Adds a single StateDirectorySaveable object to be managed.
void	manageStates(StateBufferSaveable[] states) Adds an array of StateBufferSaveable objects for managing.
void	manageStates(StateDirectorySaveable[] states) Adds an array of StateDirectorySaveable objects for managing.
abstract void	restoreState() Restores the state of the system.
abstract void	saveState() This method saves the state.
abstract void	saveState(Callback callback) This method requests a save state from the StateSaver.
void	setStateBufferFileName(java.lang.String stateBufferFileName) Sets the current state buffer file.
void	shutdown() Shuts down the StateManager, and cleans up any remaining state-related files.

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

activeObjArray

protected StateFreezable[] activeObjArray

activeObjListenersArray

protected int[] activeObjListenersArray

stateBufferFileName

protected java.lang.String stateBufferFileName

logger

protected LoggerIfc logger

scratchDir

protected java.io.File scratchDir

baseStateDir

protected java.io.File baseStateDir

Constructor Detail

StateManager

public StateManager(LoggerIfc logger,
            java.io.File scratchDir)

Creates the default StateManager

Parameters:

logger - Activity logger

scratchDir - Directory which to store state data

StateManager

public StateManager(LoggerIfc logger,
            java.io.File scratchDir,
            java.lang.String stateBufferFileName)

Creates the StateManager with a buffer file.

Parameters:

logger - Activity logger

scratchDir - Directory which to store state data.

stateBufferFileName - Buffer File name

Method Detail

shutdown

public void shutdown()

Shuts down the StateManager, and cleans up any remaining state-related files.

setStateBufferFileName

public void setStateBufferFileName(java.lang.String stateBufferFileName)

Sets the current state buffer file.

Parameters:

stateBufferFileName - Buffer file, containing the states.

manageState

public void manageState(StateBufferSaveable state)

Adds a single StateBufferSaveable object to be managed.

Parameters:

stateDirObj - State object to manage

manageState

public void manageState(StateDirectorySaveable state)

Adds a single StateDirectorySaveable object to be managed.

Parameters:

stateDirObj - State object to manage

manageStates

public void manageStates(StateBufferSaveable[] states)

Adds an array of StateBufferSaveable objects for managing.

Parameters:

states - Array of state objects

manageStates

public void manageStates(StateDirectorySaveable[] states)

Adds an array of StateDirectorySaveable objects for managing.

Parameters:

states - Array of state objects

manageActiveObject

public void manageActiveObject(StateFreezable activeObject)

Manages a single active Object. This Object will be told to freeze before all state saving routines occur. Note that using this method implies that there are **NO** order dependencies related to the given Object.

Parameters:

activeObject - Object to be frozen during state save

getType

public abstract StateManagementType getType()

Returns this type of StateManager.

saveState

public abstract void saveState(Callback callback)
                        throws StateException

This method requests a save state from the StateSaver. (Where applicable)

Throws:

StateException

saveState

public abstract void saveState()
                        throws StateException

This method saves the state.

Throws:

StateException

restoreState

public abstract void restoreState()
                           throws StateException

Restores the state of the system.

Throws:

StateException