gov.sandia.cognition.framework.lite
Class CognitiveModuleStateWrapper

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.framework.lite.CognitiveModuleStateWrapper
All Implemented Interfaces:
CognitiveModuleState, CloneableSerializable, Serializable, Cloneable

public class CognitiveModuleStateWrapper
extends AbstractCloneableSerializable
implements CognitiveModuleState

The CognitiveModuleStateWrapper wraps some other object as a CognitiveModuleState object. The only condition is that the internal object must be Cloneable and Serializable.

Since:
2.0
Author:
Justin Basilico, Kevin R. Dixon
See Also:
Serialized Form

Constructor Summary
CognitiveModuleStateWrapper()
          Creates a new instance of CognitiveModuleStateWrapper.
CognitiveModuleStateWrapper(CloneableSerializable internalState)
          Creates a new instance of CognitiveModuleStateWrapper.
 
Method Summary
 CognitiveModuleStateWrapper clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 CloneableSerializable getInternalState()
          Gets the internal state object.
 void setInternalState(CloneableSerializable internalState)
          Sets the internal state object.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CognitiveModuleStateWrapper

public CognitiveModuleStateWrapper()
Creates a new instance of CognitiveModuleStateWrapper. The initial state object is null.


CognitiveModuleStateWrapper

public CognitiveModuleStateWrapper(CloneableSerializable internalState)
Creates a new instance of CognitiveModuleStateWrapper.

Parameters:
internalState - The internal state object.
Method Detail

clone

public CognitiveModuleStateWrapper clone()
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CognitiveModuleState
Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

getInternalState

public CloneableSerializable getInternalState()
Gets the internal state object.

Returns:
The internal state object.

setInternalState

public void setInternalState(CloneableSerializable internalState)
Sets the internal state object.

Parameters:
internalState - The internal state object.