Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
java
java
	interface IState: IIdentifiable
	{
		/// <summary>
		/// Transform the state instance into an array of bytes
		/// </summary>
		/// <param name="state">The state to be turned into a byte array</param>
		/// <returns></returns>
		byte[] ToByteArray();
	}

	public interface IManageState
	{
		/// <summary>
		/// Store the linkable component's current State
		/// </summary>
		/// <returns>Object that identifies the stored state.</returns>
		IState KeepCurrentState();

		/// <summary>
		/// Creates an instance of the state using array of bytes
		/// </summary>
		/// <param name="stateID">Object that identifies the state to be restored.</param>
		IState CreateStateFromByteArray(byte[] state);

		/// <summary>
		/// Restores the state identified by the parameter stateID. If the state identifier identified by
		/// stateID is not known by the linkable component an exception should be trown.
		/// </summary>
		/// <param name="stateID">Object that identifies the state to be restored.</param>
		void RestoreState(IState state);

		/// <summary>
		/// Clears a state from the linkable component's memory. If the state identifier identified by
		/// stateID is not known by the linkable component an exception should be trown.
		/// </summary>
		/// <param name="stateID">Object that identifies the state to be cleared.</param>
		void ClearState(IState state);
		
		/// <summary>
		/// All available states created using KeepCurrentState()
		/// </summary>
		IEnumerable<IState> AvailableStates { get; }
	}

...