com.thecoderscorner.menu.domain.state.MenuState< T > Class Template Reference

Inheritance diagram for com.thecoderscorner.menu.domain.state.MenuState< T >:

Public Member Functions
	MenuState (StateStorageType storageType, MenuItem item, boolean changed, boolean active, T value)
MenuItem	getItem ()
StateStorageType	getStorageType ()
boolean	isChanged ()
boolean	isActive ()
T	getValue ()
boolean	equals (Object o)
int	hashCode ()

Detailed Description

The base class of menu state, stores the value, if it's active and changed. Generally it's best to work with state via com.thecoderscorner.menu.domain.util.MenuItemHelper

Parameters

<T>	the type of current value.

Constructor & Destructor Documentation

MenuState()

com.thecoderscorner.menu.domain.state.MenuState< T >.MenuState	(	StateStorageType	storageType,
		MenuItem	item,
		boolean	changed,
		boolean	active,
		T	value
	)

normally these states are created from the menu item, instead of directly

Parameters

changed	if the item has changed
active	if the item is active.
value	the current value

Member Function Documentation

getItem()

MenuItem com.thecoderscorner.menu.domain.state.MenuState< T >.getItem

(

)

Gets the menu item associated with this state.

Returns

the menu item

Implements com.thecoderscorner.menu.domain.state.AnyMenuState.

getStorageType()

StateStorageType com.thecoderscorner.menu.domain.state.MenuState< T >.getStorageType

(

)

The storage type for this state, eg if it is a MenuState specialised for Integer, then the state type will be INTEGER.

Returns

the storage type

Implements com.thecoderscorner.menu.domain.state.AnyMenuState.

getValue()

T com.thecoderscorner.menu.domain.state.MenuState< T >.getValue

(

)

gets the current value

Returns

current value

Implements com.thecoderscorner.menu.domain.state.AnyMenuState.

isActive()

boolean com.thecoderscorner.menu.domain.state.MenuState< T >.isActive

(

)

gets the active status

Returns

active status

Implements com.thecoderscorner.menu.domain.state.AnyMenuState.

isChanged()

boolean com.thecoderscorner.menu.domain.state.MenuState< T >.isChanged

(

)

gets the changed status

Returns

changed status

Implements com.thecoderscorner.menu.domain.state.AnyMenuState.

---

The documentation for this class was generated from the following file:

• src/main/java/com/thecoderscorner/menu/domain/state/MenuState.java