gumbo.interact
Interface InteractorState

All Superinterfaces:

java.util.Collection, java.util.Set, StateSet

All Known Implementing Classes:

AbstractInteractorState, Interactors.ImmutableInteractorState

public interface InteractorState

extends StateSet

A state set intended as the public delegate for Interactor that maintains interactor state. Can also be used as a general purpose state set, with event route access.

Version:

$Revision: 1.3 $

Author:

Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Method Summary

InteractorState	getInteractorState() Gets a singleton immutable view of this state, which is the current state value, resulting from the last reset or transit.
StateSetField.EventIn	getStateChangeIn() Calls change() with the received state flags (a "masked change").
CollectionField.EventIn	getStateResetIn() Calls reset() with the received state flags.
StateSetField.EventOut	getStateResetOut() Sends an immutable view of this state set when the state resets, whether or not the state value changed.
CollectionField.EventIn	getStateSetIn() Calls set() with the received state flags.
StateSetField.EventOut	getStateTransitOut() Sends an immutable view of this state set when the state transits (as a result of set(), change(), transit()), whether or not the state value changed.

Methods inherited from interface gumbo.util.state.StateSet

change, change, changeAll, getOldState, getStatePolicy, getStateSet, reset, set, transit

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

getStateResetIn

public CollectionField.EventIn getStateResetIn()

Calls reset() with the received state flags.

getStateSetIn

public CollectionField.EventIn getStateSetIn()

Calls set() with the received state flags.

getStateChangeIn

public StateSetField.EventIn getStateChangeIn()

Calls change() with the received state flags (a "masked change").

getStateResetOut

public StateSetField.EventOut getStateResetOut()

Sends an immutable view of this state set when the state resets, whether or not the state value changed. Sent just after stateReset() is called.

getStateTransitOut

public StateSetField.EventOut getStateTransitOut()

Sends an immutable view of this state set when the state transits (as a result of set(), change(), transit()), whether or not the state value changed. Sent just after stateTransit() is called.

getInteractorState

public InteractorState getInteractorState()

Gets a singleton immutable view of this state, which is the current state value, resulting from the last reset or transit.

Returns:

The view (Object). Never null.