com.nt.udc.util.state

Class SynchronousStateManager

java.lang.Object

com.nt.udc.util.state.StateManager

com.nt.udc.util.state.SynchronousStateManager

public class SynchronousStateManager
extends StateManager

Field Summary

Fields inherited from class com.nt.udc.util.state.StateManager

activeObjArray, activeObjListenersArray, baseStateDir, logger, scratchDir, stateBufferFileName, stateBufferObjArray, stateDirObjArray

Constructor Summary

Constructors

Constructor and Description
SynchronousStateManager(LoggerIfc logger, java.io.File scratchDir) Creates the default StateManager
SynchronousStateManager(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
StateManagementType	getType() Returns this type of StateManager.
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.
void	restoreState() This method causes the state to be restored immediately.
void	saveState() This method causes the state to be saved immediately.
void	saveState(Callback callback) This method causes the state to be saved immediately.
void	setMergeThreshold(int threshold) Sets the number of state saves allowed before a merge occurs.
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 com.nt.udc.util.state.StateManager

manageActiveObject

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronousStateManager

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

Creates the default StateManager

Parameters:

logger - Activity logger

scratchDir - Directory which to store state data

SynchronousStateManager

public SynchronousStateManager(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.

Overrides:

shutdown in class StateManager

setStateBufferFileName

public void setStateBufferFileName(java.lang.String stateBufferFileName)

Sets the current state buffer file.

Overrides:

setStateBufferFileName in class StateManager

Parameters:

stateBufferFileName - Buffer file, containing the states.

manageState

public void manageState(StateBufferSaveable state)

Adds a single StateBufferSaveable object to be managed.

Overrides:

manageState in class StateManager

Parameters:

stateDirObj - State object to manage

manageState

public void manageState(StateDirectorySaveable state)

Adds a single StateDirectorySaveable object to be managed.

Overrides:

manageState in class StateManager

Parameters:

stateDirObj - State object to manage

manageStates

public void manageStates(StateBufferSaveable[] states)

Adds an array of StateBufferSaveable objects for managing.

Overrides:

manageStates in class StateManager

Parameters:

states - Array of state objects

manageStates

public void manageStates(StateDirectorySaveable[] states)

Adds an array of StateDirectorySaveable objects for managing.

Overrides:

manageStates in class StateManager

Parameters:

states - Array of state objects

setMergeThreshold

public void setMergeThreshold(int threshold)

Sets the number of state saves allowed before a merge occurs.

saveState

public void saveState()
               throws StateException

This method causes the state to be saved immediately.

Specified by:

saveState in class StateManager

Throws:

StateException

saveState

public void saveState(Callback callback)
               throws StateException

This method causes the state to be saved immediately. The callback is not used.

Specified by:

saveState in class StateManager

Throws:

StateException

restoreState

public void restoreState()
                  throws StateException

This method causes the state to be restored immediately.

Specified by:

restoreState in class StateManager

Throws:

StateException

getType

public StateManagementType getType()

Description copied from class: StateManager

Returns this type of StateManager.

Specified by:

getType in class StateManager