Index (tcMenuJavaAPI 1.5.0 API)

A B C D E F G H I J K L M N O P R S T U V W Y
All Classes All Packages

A

aBooleanMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
ABSOLUTE - com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType
ABSOLUTE_LIST - com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType
AbstractMenuItemVisitor<T> - Class in com.thecoderscorner.menu.domain.util: Abstract version of the interface MenuItemVisitor, it implements all the methods by defaulting the behaviour to the anyItem() method.
AbstractMenuItemVisitor() - Constructor for class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.ActionMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem: See the MenuItemVistor for more info.
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.EnumMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.FloatMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.MenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.SubMenuItem
ACCEPT - com.thecoderscorner.menu.remote.commands.MenuButtonType
ACKNOWLEDGEMENT - com.thecoderscorner.menu.remote.commands.MenuCommandType
ackReceived(CorrelationId, MenuItem, AckStatus) - Method in interface com.thecoderscorner.menu.remote.RemoteControllerListener: Indicates that an acknowledgment has been received from the embedded device.
AckStatus - Enum in com.thecoderscorner.menu.remote.commands: An enumeration that represents all the possible status / error return codes from the remote.
ACTION - com.thecoderscorner.menu.remote.commands.DialogMode
ACTION_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
ActionMenuItem - Class in com.thecoderscorner.menu.domain: ActionMenuItem represents a menu item that is a one shot action, in that when triggered it just runs the callback on the embedded side.
ActionMenuItem() - Constructor for class com.thecoderscorner.menu.domain.ActionMenuItem
ActionMenuItem(String, int, String, int, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.ActionMenuItem
ActionMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs an ActionMenuItemBuilder using the standard builder pattern.
ActionMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.ActionMenuItemBuilder
addEnumValue(String) - Method in class com.thecoderscorner.menu.domain.EnumMenuItemBuilder
addListener(RemoteControllerListener) - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: register for events when the tree becomes fully populated, a menu item changes or there's a change in connectivity.
addMenuItem(SubMenuItem, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: add a new menu item to a sub menu, for the top level menu use ROOT.
addOrUpdateItem(int, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: This will either add or update an existing item, depending if the ID is already present.
aFloatMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.FloatMenuItemBuilder
aLargeNumberItemBuilder() - Static method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItemBuilder
anActionMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.ActionMenuItemBuilder
ANALOG_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
AnalogMenuItem - Class in com.thecoderscorner.menu.domain: Represents an analog (numeric) menu item, it is always a zero based integer when retrieved from storage, but it can have an offset and divisor, so therefore is able to represent decimal values.
AnalogMenuItem() - Constructor for class com.thecoderscorner.menu.domain.AnalogMenuItem
AnalogMenuItem(String, int, int, String, int, int, int, String, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.AnalogMenuItem
AnalogMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs an AnalogMenuItem using the standard builder pattern.
AnalogMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
anAnalogMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
anEnumMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.EnumMenuItemBuilder
anyItem(MenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor: Whenever a visit method is not implemented, then anyItem is called instead.
ApiPlatform - Enum in com.thecoderscorner.menu.remote.protocol: Provides a list of the support platforms as an enumeration.
ARDUINO - com.thecoderscorner.menu.remote.protocol.ApiPlatform
ARDUINO32 - com.thecoderscorner.menu.remote.protocol.ApiPlatform
aRuntimeListMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder
asSubMenu(MenuItem) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper: Returns the menu item as a sub menu or null
aSubMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
aTextMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.EditableTextMenuItemBuilder
attemptPairing() - Method in class com.thecoderscorner.menu.remote.protocol.PairingHelper
attemptPairing(Optional<Consumer<AuthStatus>>) - Method in interface com.thecoderscorner.menu.remote.ConnectorFactory
attemptPairing(Optional<Consumer<AuthStatus>>) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: A pairing connection is purely used to initialise the security between the device and the API.
attemptPairing(Optional<Consumer<AuthStatus>>) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder
AUTHENTICATED - com.thecoderscorner.menu.remote.AuthStatus
AuthStatus - Enum in com.thecoderscorner.menu.remote: the authentication states that a RemoteMenuController can be in.
AWAITING_CONNECTION - com.thecoderscorner.menu.remote.AuthStatus
AwaitingBootstrapState - Class in com.thecoderscorner.menu.remote.states
AwaitingBootstrapState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.AwaitingBootstrapState

B

baseFromExisting(MenuItem) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
BaseMessageProcessingState - Class in com.thecoderscorner.menu.remote.states
BaseMessageProcessingState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
BigDecimalMenuState - Class in com.thecoderscorner.menu.domain.state
BigDecimalMenuState(MenuItem<BigDecimal>, boolean, boolean, BigDecimal) - Constructor for class com.thecoderscorner.menu.domain.state.BigDecimalMenuState: Creates a state that can store a big decimal
BOOLEAN_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
BooleanMenuItem - Class in com.thecoderscorner.menu.domain: A menu item that can only hold boolean values (true or false).
BooleanMenuItem() - Constructor for class com.thecoderscorner.menu.domain.BooleanMenuItem
BooleanMenuItem(String, int, int, String, BooleanMenuItem.BooleanNaming, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.BooleanMenuItem
BooleanMenuItem.BooleanNaming - Enum in com.thecoderscorner.menu.domain
BooleanMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs a BooleanMenuItemBuilder using the standard builder pattern.
BooleanMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
BooleanMenuState - Class in com.thecoderscorner.menu.domain.state: An implementation of menu state for booleans.
BooleanMenuState(MenuItem<Boolean>, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.state.BooleanMenuState
BootItemMenuCommand<T extends MenuItem,V> - Class in com.thecoderscorner.menu.remote.commands
BootItemMenuCommand(int, T, V) - Constructor for class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
BOOTSTRAP - com.thecoderscorner.menu.remote.commands.MenuCommandType
BootstrapInProgressState - Class in com.thecoderscorner.menu.remote.states
BootstrapInProgressState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.BootstrapInProgressState
BOOTSTRAPPING - com.thecoderscorner.menu.remote.AuthStatus
build() - Method in interface com.thecoderscorner.menu.remote.ConnectorFactory
build() - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Once the above methods have been called to fill in the blanks, then call build to get the actual instance.
build() - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Once the above methods have been called to fill in the blanks, then call build to get the actual instance.

C

CANCEL - com.thecoderscorner.menu.remote.commands.MenuButtonType
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.AwaitingBootstrapState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.BootstrapInProgressState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.ConnectionReadyState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.JoinMessageArrivedState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.NoOperationInitialState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.PairingAuthFailedState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.PairingAuthSuccessState
canSendCommandToRemote(MenuCommand) - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorState: called before any command is sent in order for the state to disallow
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.SendPairingMessageState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.SerialAwaitFirstMsgState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.SocketAwaitJoinState
canSendCommandToRemote(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.StreamNotConnectedState
CHANGE_INT_FIELD - com.thecoderscorner.menu.remote.commands.MenuCommandType
changeItem(MenuItem<T>, MenuState<T>) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Change the value that's associated with a menu item.
changeState(AuthStatus) - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
changeState(AuthStatus) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
changeState(RemoteConnectorState) - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
changeState(RemoteConnectorState) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
changeTypeFromInt(int) - Static method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
changeTypeToInt(MenuChangeCommand.ChangeType) - Static method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
checkIfThereIsAnHbEnd(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
clock - Variable in class com.thecoderscorner.menu.remote.StreamRemoteConnector
close() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: Force close a connection when its known to be bad, the connector will try and establish a new connection.
close() - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
close() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
close() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
CLOSE - com.thecoderscorner.menu.remote.commands.MenuButtonType
com.thecoderscorner.menu.domain - package com.thecoderscorner.menu.domain
com.thecoderscorner.menu.domain.state - package com.thecoderscorner.menu.domain.state
com.thecoderscorner.menu.domain.util - package com.thecoderscorner.menu.domain.util
com.thecoderscorner.menu.remote - package com.thecoderscorner.menu.remote
com.thecoderscorner.menu.remote.commands - package com.thecoderscorner.menu.remote.commands
com.thecoderscorner.menu.remote.protocol - package com.thecoderscorner.menu.remote.protocol
com.thecoderscorner.menu.remote.rs232 - package com.thecoderscorner.menu.remote.rs232
com.thecoderscorner.menu.remote.socket - package com.thecoderscorner.menu.remote.socket
com.thecoderscorner.menu.remote.states - package com.thecoderscorner.menu.remote.states
com.thecoderscorner.tcmenu.javaapi - module com.thecoderscorner.tcmenu.javaapi
CommandFactory - Class in com.thecoderscorner.menu.remote.commands: These static helper methods are the preferred way to create command message that can be sent and received from a remote connection.
CommandFactory() - Constructor for class com.thecoderscorner.menu.remote.commands.CommandFactory
CONNECTION_READY - com.thecoderscorner.menu.remote.AuthStatus
connectionChange(RemoteConnector, AuthStatus) - Method in interface com.thecoderscorner.menu.remote.ConnectionChangeListener: Called by the connector upon state change
ConnectionChangeListener - Interface in com.thecoderscorner.menu.remote: Use this interface to subscribe to connection change events, such as when the underlying connector disconnects or reconnects with hardware.
ConnectionReadyState - Class in com.thecoderscorner.menu.remote.states
ConnectionReadyState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.ConnectionReadyState
connectionState(RemoteInformation, AuthStatus) - Method in interface com.thecoderscorner.menu.remote.RemoteControllerListener: Indicates a change in connectivity
ConnectMode - Enum in com.thecoderscorner.menu.remote
ConnectorFactory - Interface in com.thecoderscorner.menu.remote
context - Variable in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
CorrelationId - Class in com.thecoderscorner.menu.remote.protocol: A correlation ID that allows events sent from the client or server to be linked via this ID.
CorrelationId() - Constructor for class com.thecoderscorner.menu.remote.protocol.CorrelationId: Creates a new correlation ID that is relatively unique
CorrelationId(String) - Constructor for class com.thecoderscorner.menu.remote.protocol.CorrelationId: Creates a correlation id with the specified value, for existing correlation ids
createFromExistingWithId(MenuItem, int) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper: creates a copy of the menu item chosen, with the ID changed to newId

D

DELTA - com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType
DIALOG_UPDATE - com.thecoderscorner.menu.remote.commands.MenuCommandType
DialogMode - Enum in com.thecoderscorner.menu.remote.commands
dialogUpdate(DialogMode, String, String, MenuButtonType, MenuButtonType) - Method in interface com.thecoderscorner.menu.remote.RemoteControllerListener: Called when a dialog event occurs on the remote, be it to show or hide a dialog
disconnectInterval - Variable in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
DNET_API - com.thecoderscorner.menu.remote.protocol.ApiPlatform
doesBufferHaveEOM(ByteBuffer) - Static method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

E

EditableLargeNumberMenuItem - Class in com.thecoderscorner.menu.domain: A menu item that corresponds to the large number type on the device.
EditableLargeNumberMenuItem(String, int, int, String, int, int, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem
EditableLargeNumberMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs a EditableTextMenuItemBuilder using the standard builder pattern.
EditableLargeNumberMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItemBuilder
EditableTextMenuItem - Class in com.thecoderscorner.menu.domain: An implementation of menu item that can store text strings.
EditableTextMenuItem() - Constructor for class com.thecoderscorner.menu.domain.EditableTextMenuItem
EditableTextMenuItem(String, int, int, String, int, EditItemType, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.EditableTextMenuItem
EditableTextMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs a EditableTextMenuItemBuilder using the standard builder pattern.
EditableTextMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.EditableTextMenuItemBuilder
EditItemType - Enum in com.thecoderscorner.menu.domain
eepromAddress - Variable in class com.thecoderscorner.menu.domain.MenuItem
eepromSizeForItem(MenuItem) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper: Gets the size of the eeprom storage for a given element type
EMPTY_CORRELATION - Static variable in class com.thecoderscorner.menu.remote.protocol.CorrelationId
END - com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType
END - com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode
END_OF_MSG - Static variable in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol
enterState() - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
enterState() - Method in class com.thecoderscorner.menu.remote.states.ConnectionReadyState
enterState() - Method in class com.thecoderscorner.menu.remote.states.JoinMessageArrivedState
enterState() - Method in class com.thecoderscorner.menu.remote.states.NoOperationInitialState
enterState() - Method in class com.thecoderscorner.menu.remote.states.PairingAuthFailedState
enterState() - Method in class com.thecoderscorner.menu.remote.states.PairingAuthSuccessState
enterState() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorState: called when a state machine class becomes active
enterState() - Method in class com.thecoderscorner.menu.remote.states.SendPairingMessageState
enterState() - Method in class com.thecoderscorner.menu.remote.states.SocketAwaitJoinState
enterState() - Method in class com.thecoderscorner.menu.remote.states.StreamNotConnectedState
ENUM_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
EnumMenuItem - Class in com.thecoderscorner.menu.domain: A menu item implementation that represents one of a known set of choices, the choices are stored as an integer value, but each choice has a string representation as well.
EnumMenuItem() - Constructor for class com.thecoderscorner.menu.domain.EnumMenuItem
EnumMenuItem(String, int, int, String, List<String>, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.EnumMenuItem
EnumMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs a BooleanMenuItemBuilder using the standard builder pattern.
EnumMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.EnumMenuItemBuilder
equals(Object) - Method in class com.thecoderscorner.menu.domain.ActionMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.EnumMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.FloatMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.state.MenuState
equals(Object) - Method in class com.thecoderscorner.menu.domain.SubMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
equals(Object) - Method in class com.thecoderscorner.menu.remote.commands.MenuAcknowledgementCommand
equals(Object) - Method in class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand
equals(Object) - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
equals(Object) - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
equals(Object) - Method in class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand
equals(Object) - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
equals(Object) - Method in class com.thecoderscorner.menu.remote.commands.MenuPairingCommand
equals(Object) - Method in class com.thecoderscorner.menu.remote.protocol.CorrelationId
ESTABLISHED_CONNECTION - com.thecoderscorner.menu.remote.AuthStatus
executor - Variable in class com.thecoderscorner.menu.remote.StreamRemoteConnector
exitState(RemoteConnectorState) - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
exitState(RemoteConnectorState) - Method in class com.thecoderscorner.menu.remote.states.ConnectionReadyState
exitState(RemoteConnectorState) - Method in class com.thecoderscorner.menu.remote.states.NoOperationInitialState
exitState(RemoteConnectorState) - Method in class com.thecoderscorner.menu.remote.states.PairingAuthFailedState
exitState(RemoteConnectorState) - Method in class com.thecoderscorner.menu.remote.states.PairingAuthSuccessState
exitState(RemoteConnectorState) - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorState: called when a state machine class is deactivated
exitState(RemoteConnectorState) - Method in class com.thecoderscorner.menu.remote.states.StreamNotConnectedState

F

FAILED_AUTH - com.thecoderscorner.menu.remote.AuthStatus
FIELD_TERMINATOR - Static variable in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol
findParent(MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Finds the submenu that the provided object belongs to.
FLOAT_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
FloatMenuItem - Class in com.thecoderscorner.menu.domain: FloatMenuItem represents a menu item that uses a floating point value.
FloatMenuItem() - Constructor for class com.thecoderscorner.menu.domain.FloatMenuItem
FloatMenuItem(String, int, String, int, int, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.FloatMenuItem
FloatMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs a FloatMenuItem using the standard builder pattern.
FloatMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.FloatMenuItemBuilder
FloatMenuState - Class in com.thecoderscorner.menu.domain.state: An implementation of menu state for Strings.
FloatMenuState(MenuItem<Float>, boolean, boolean, Float) - Constructor for class com.thecoderscorner.menu.domain.state.FloatMenuState
fromChannel(ByteBuffer) - Method in interface com.thecoderscorner.menu.remote.MenuCommandProtocol: Retrieves a message from the channel, or throws an exception if the message is not fully formed.
fromChannel(ByteBuffer) - Method in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol
fromId(int) - Static method in enum com.thecoderscorner.menu.domain.EditItemType
fromKeyToApiPlatform(int) - Static method in class com.thecoderscorner.menu.remote.protocol.ProtocolUtil: get the api platform given it's integer key value.
FULLY_AUTHENTICATED - com.thecoderscorner.menu.remote.ConnectMode
functionName - Variable in class com.thecoderscorner.menu.domain.MenuItem

G

getAckStatus() - Method in class com.thecoderscorner.menu.remote.commands.MenuAcknowledgementCommand
getAllMenuItems() - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Gets every menu item held in this menu tree, will be unique
getAllSubMenus() - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Returns all the submenus that are currently stored
getApiVersion() - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
getAppUuid() - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
getAtLeastBytes(ByteBuffer, int, StreamRemoteConnector.ReadMode) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
getAtLeastBytes(ByteBuffer, int, StreamRemoteConnector.ReadMode) - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
getAtLeastBytes(ByteBuffer, int, StreamRemoteConnector.ReadMode) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector: Reads at least the number of bytes requested waiting if need be for more data.
getAuthenticationStatus() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.AwaitingBootstrapState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.BootstrapInProgressState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.ConnectionReadyState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.JoinMessageArrivedState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.NoOperationInitialState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.PairingAuthFailedState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.PairingAuthSuccessState
getAuthenticationStatus() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.SendPairingMessageState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.SerialAwaitFirstMsgState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.SocketAwaitJoinState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.states.StreamNotConnectedState
getAuthenticationStatus() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
getBootType() - Method in class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand
getBuffer() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
getButton1() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
getButton2() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
getButtonName() - Method in enum com.thecoderscorner.menu.remote.commands.MenuButtonType
getChangeType() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
getClock() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
getClock() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
getCode() - Method in enum com.thecoderscorner.menu.remote.commands.MenuCommandType
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuAcknowledgementCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuActionBootCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuAnalogBootCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuBooleanBootCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
getCommandType() - Method in interface com.thecoderscorner.menu.remote.commands.MenuCommand: The type of message received.
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuEnumBootCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuFloatBootCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuLargeNumBootCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuPairingCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuRuntimeListBootCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuSubBootCommand
getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuTextBootCommand
getConnectionName() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: Gets the name of this connector locally
getConnectionName() - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
getConnectionName() - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
getConnectionName() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
getConnector() - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: get the underlying connectivity, rarely needed
getCorrelationId() - Method in class com.thecoderscorner.menu.remote.commands.MenuAcknowledgementCommand
getCorrelationId() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
getCorrelationId() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
getCurrentValue() - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
getDecimalPlaces() - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem
getDescription() - Method in enum com.thecoderscorner.menu.remote.AuthStatus
getDescription() - Method in enum com.thecoderscorner.menu.remote.commands.AckStatus
getDescription() - Method in enum com.thecoderscorner.menu.remote.protocol.ApiPlatform
getDialogMode() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
getDigitsAllowed() - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem
getDivisor() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem: The divisor used when displaying the item, for example value 50 with a divisor of 10 is 5.0
getEepromAddress() - Method in class com.thecoderscorner.menu.domain.MenuItem: gets the eeprom storage address for this item.
getEnumEntries() - Method in class com.thecoderscorner.menu.domain.EnumMenuItem
getFunctionName() - Method in class com.thecoderscorner.menu.domain.MenuItem: Gets the function name for this item
getHeader() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
getHearbeatInterval() - Method in class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand
getHigh() - Method in enum com.thecoderscorner.menu.remote.commands.MenuCommandType
getId() - Method in class com.thecoderscorner.menu.domain.MenuItem: gets the ID for the menu item
getInitialRows() - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItem
getItem() - Method in class com.thecoderscorner.menu.domain.state.MenuState: Gets the menu item associated with this state.
getItemType() - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItem
getKey() - Method in enum com.thecoderscorner.menu.remote.protocol.ApiPlatform
getKeyIdentifier() - Method in interface com.thecoderscorner.menu.remote.MenuCommandProtocol: returns the identifier for this protocol, when used in messages
getKeyIdentifier() - Method in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol
getLow() - Method in enum com.thecoderscorner.menu.remote.commands.MenuCommandType
getMajorVersion() - Method in class com.thecoderscorner.menu.remote.RemoteInformation: the major version of the remote host
getManagedMenu() - Method in class com.thecoderscorner.menu.remote.RemoteMenuController
getMaxValue() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem: The maximum value (0 based integer) that this item can represent
getMenuById(int) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Gets the menu item with the specified ID, finding the submenu if needed.
getMenuItem() - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
getMenuItemId() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
getMenuItems(MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Get a list of all menu items for a given submenu
getMenuState(MenuItem<T>) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Gets the menu state that's associated with a given menu item.
getMinorVersion() - Method in class com.thecoderscorner.menu.remote.RemoteInformation: the minor version of the remote host
getMode() - Method in class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand
getMsgId() - Method in enum com.thecoderscorner.menu.domain.EditItemType
getMyName() - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
getName() - Method in class com.thecoderscorner.menu.domain.MenuItem: gets the name of the menu item
getName() - Method in class com.thecoderscorner.menu.remote.commands.MenuPairingCommand
getName() - Method in class com.thecoderscorner.menu.remote.LocalIdentifier
getName() - Method in class com.thecoderscorner.menu.remote.RemoteInformation: the name of the remote
getNaming() - Method in class com.thecoderscorner.menu.domain.BooleanMenuItem: returns the naming for this boolean, that describes how to render the true/false choice.
getNumDecimalPlaces() - Method in class com.thecoderscorner.menu.domain.FloatMenuItem
getOffset() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem: The offset from 0 that is used when displaying the item, can be negative
getPlatform() - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
getPlatform() - Method in class com.thecoderscorner.menu.remote.RemoteInformation: the platform type of the remote host
getRemoteParty() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector
getRemoteParty() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
getResult() - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor: Returns the result previously stored by set result.
getScheduledExecutor() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
getScheduledExecutor() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
getStatusCode() - Method in enum com.thecoderscorner.menu.remote.commands.AckStatus
getSubMenuById(int) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: gets a submenu by it's ID.
getSubMenuId() - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
getTextLength() - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItem
getThis() - Method in class com.thecoderscorner.menu.domain.ActionMenuItemBuilder
getThis() - Method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
getThis() - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItemBuilder
getThis() - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItemBuilder
getThis() - Method in class com.thecoderscorner.menu.domain.FloatMenuItemBuilder
getThis() - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder
getThis() - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
getTypeVal() - Method in enum com.thecoderscorner.menu.remote.commands.MenuButtonType
getUnderlyingId() - Method in class com.thecoderscorner.menu.remote.protocol.CorrelationId: Gets the underlying ID.
getUnitName() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem: The unit name to appear directly after the value, for example a temprature item may be "oC" where as a volume control could be "dB"
getUuid() - Method in class com.thecoderscorner.menu.remote.commands.MenuPairingCommand
getUuid() - Method in class com.thecoderscorner.menu.remote.LocalIdentifier
getValue() - Method in class com.thecoderscorner.menu.domain.state.MenuState: gets the current value
getValue() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
getValue(String) - Method in class com.thecoderscorner.menu.remote.protocol.TagValTextParser: Gets the value associated with the key from the message.
getValueAsInt(String) - Method in class com.thecoderscorner.menu.remote.protocol.TagValTextParser: Calls the getValue method first and the converts to an integer.
getValueAsIntWithDefault(String, int) - Method in class com.thecoderscorner.menu.remote.protocol.TagValTextParser: Calls the getValue method first and the converts to an integer.
getValues() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
getValueWithDefault(String, String) - Method in class com.thecoderscorner.menu.remote.protocol.TagValTextParser: Gets the value associated with the key from the message if it exists in the underlying map.
getVersionFromProperties() - Static method in class com.thecoderscorner.menu.remote.protocol.ProtocolUtil: gets and caches the current version from the version properties file
GREGORIAN_DATE - com.thecoderscorner.menu.domain.EditItemType

H

handleCoreConnectionStates(ConnectMode) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
hasChildren() - Method in class com.thecoderscorner.menu.domain.ActionMenuItem
hasChildren() - Method in class com.thecoderscorner.menu.domain.MenuItem: has children indicates if this item can contain child items
hasChildren() - Method in class com.thecoderscorner.menu.domain.SubMenuItem
hashCode() - Method in class com.thecoderscorner.menu.domain.ActionMenuItem
hashCode() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem
hashCode() - Method in class com.thecoderscorner.menu.domain.BooleanMenuItem
hashCode() - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItem
hashCode() - Method in class com.thecoderscorner.menu.domain.EnumMenuItem
hashCode() - Method in class com.thecoderscorner.menu.domain.FloatMenuItem
hashCode() - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItem
hashCode() - Method in class com.thecoderscorner.menu.domain.state.MenuState
hashCode() - Method in class com.thecoderscorner.menu.domain.SubMenuItem
hashCode() - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
hashCode() - Method in class com.thecoderscorner.menu.remote.commands.MenuAcknowledgementCommand
hashCode() - Method in class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand
hashCode() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
hashCode() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
hashCode() - Method in class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand
hashCode() - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
hashCode() - Method in class com.thecoderscorner.menu.remote.commands.MenuPairingCommand
hashCode() - Method in class com.thecoderscorner.menu.remote.protocol.CorrelationId
HB_FREQUENCY_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
HB_MODE_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
HEARTBEAT - com.thecoderscorner.menu.remote.commands.MenuCommandType
HIDE - com.thecoderscorner.menu.remote.commands.DialogMode

I

id - Variable in class com.thecoderscorner.menu.domain.MenuItem
ID_NOT_FOUND - com.thecoderscorner.menu.remote.commands.AckStatus: The requested ID was not found
IntegerMenuState - Class in com.thecoderscorner.menu.domain.state: An implementation of menu state for integer values.
IntegerMenuState(MenuItem<Integer>, boolean, boolean, Integer) - Constructor for class com.thecoderscorner.menu.domain.state.IntegerMenuState
internalNewMenuState(MenuState<Boolean>) - Method in class com.thecoderscorner.menu.remote.commands.MenuActionBootCommand
internalNewMenuState(MenuState<Boolean>) - Method in class com.thecoderscorner.menu.remote.commands.MenuBooleanBootCommand
internalNewMenuState(MenuState<Boolean>) - Method in class com.thecoderscorner.menu.remote.commands.MenuSubBootCommand
internalNewMenuState(MenuState<Float>) - Method in class com.thecoderscorner.menu.remote.commands.MenuFloatBootCommand
internalNewMenuState(MenuState<Integer>) - Method in class com.thecoderscorner.menu.remote.commands.MenuAnalogBootCommand
internalNewMenuState(MenuState<Integer>) - Method in class com.thecoderscorner.menu.remote.commands.MenuEnumBootCommand
internalNewMenuState(MenuState<String>) - Method in class com.thecoderscorner.menu.remote.commands.MenuTextBootCommand
internalNewMenuState(MenuState<BigDecimal>) - Method in class com.thecoderscorner.menu.remote.commands.MenuLargeNumBootCommand
internalNewMenuState(MenuState<List<String>>) - Method in class com.thecoderscorner.menu.remote.commands.MenuRuntimeListBootCommand
internalNewMenuState(MenuState<V>) - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
INVALID_CREDENTIALS - com.thecoderscorner.menu.remote.commands.AckStatus: The credentials provided were incorrect
IP_ADDRESS - com.thecoderscorner.menu.domain.EditItemType
isActive() - Method in class com.thecoderscorner.menu.domain.state.MenuState: gets the active status
isChanged() - Method in class com.thecoderscorner.menu.domain.state.MenuState: gets the changed status
isDeviceConnected() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: Indicates if the underlying device is actually connected.
isDeviceConnected() - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
isDeviceConnected() - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
isDeviceConnected() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
isError() - Method in enum com.thecoderscorner.menu.remote.commands.AckStatus
isLocalOnly() - Method in class com.thecoderscorner.menu.domain.MenuItem: Returns if this menu item is only for local viewing and not to be sent remotely
isReadOnly() - Method in class com.thecoderscorner.menu.domain.MenuItem: gets the read only status of this menu item
isRuntimeStructureNeeded(MenuItem) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper: Check if the item is based on a runtime item
isSecured() - Method in class com.thecoderscorner.menu.domain.SubMenuItem
isTreeFullyPopulated() - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: Check if all the menu items from the remote device are available locally yet.
isVisible() - Method in class com.thecoderscorner.menu.domain.MenuItem: Flag indicates if the item should be visible on the UI

J

JAVA_API - com.thecoderscorner.menu.remote.protocol.ApiPlatform
JOIN - com.thecoderscorner.menu.remote.commands.MenuCommandType
JoinMessageArrivedState - Class in com.thecoderscorner.menu.remote.states
JoinMessageArrivedState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.JoinMessageArrivedState

K

KEY_ACK_STATUS - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_ANALOG_DIVISOR_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_ANALOG_MAX_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_ANALOG_OFFSET_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_ANALOG_UNIT_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_BOOLEAN_NAMING - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_BOOT_TYPE_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_BUFFER_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_BUTTON1_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_BUTTON2_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_CHANGE_TYPE - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_CORRELATION_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_CURRENT_VAL - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_EDIT_TYPE - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_EEPROM_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_FLOAT_DECIMAL_PLACES - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_HEADER_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_ID_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_MAX_LENGTH - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_MODE_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_NAME_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_NO_OF_CHOICES - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_PARENT_ID_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_PLATFORM_ID - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_PREPEND_CHOICE - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_PREPEND_NAMECHOICE - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_READONLY_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_REMOTE_NUM - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_UUID_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_VER_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_VISIBLE_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields

L

LARGE_NUM_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
lastReception - Variable in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
LocalIdentifier - Class in com.thecoderscorner.menu.remote: a local identifier holder object that holds the name and UUID
LocalIdentifier(UUID, String) - Constructor for class com.thecoderscorner.menu.remote.LocalIdentifier
localOnly - Variable in class com.thecoderscorner.menu.domain.MenuItem
logByteBuffer(String, ByteBuffer) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector: Helper method that logs the entire message buffer when at debug logging level.
logger - Variable in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
logger - Variable in class com.thecoderscorner.menu.remote.StreamRemoteConnector

M

markDone() - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
MenuAcknowledgementCommand - Class in com.thecoderscorner.menu.remote.commands
MenuAcknowledgementCommand(CorrelationId, AckStatus) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuAcknowledgementCommand
MenuActionBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuActionBootCommand(int, ActionMenuItem, Boolean) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuActionBootCommand
MenuAnalogBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuAnalogBootCommand(int, AnalogMenuItem, int) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuAnalogBootCommand
MenuBooleanBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuBooleanBootCommand(int, BooleanMenuItem, boolean) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuBooleanBootCommand
MenuBootstrapCommand - Class in com.thecoderscorner.menu.remote.commands
MenuBootstrapCommand(MenuBootstrapCommand.BootType) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand
MenuBootstrapCommand.BootType - Enum in com.thecoderscorner.menu.remote.commands
MenuButtonType - Enum in com.thecoderscorner.menu.remote.commands
MenuChangeCommand - Class in com.thecoderscorner.menu.remote.commands
MenuChangeCommand(CorrelationId, int, MenuChangeCommand.ChangeType, String) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
MenuChangeCommand(CorrelationId, int, List<String>) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
MenuChangeCommand.ChangeType - Enum in com.thecoderscorner.menu.remote.commands
MenuCommand - Interface in com.thecoderscorner.menu.remote.commands: Classes extending from MenuCommand can be sent and received on a connector.
MenuCommandProtocol - Interface in com.thecoderscorner.menu.remote: This is a low level part of the API that most people don't need to deal, implementations will translate commands to and from a given protocol.
MenuCommandType - Enum in com.thecoderscorner.menu.remote.commands: Enumeration of the types of messages that can be sent to and from the server.
MenuDialogCommand - Class in com.thecoderscorner.menu.remote.commands
MenuDialogCommand(DialogMode, String, String, MenuButtonType, MenuButtonType, CorrelationId) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
MenuEnumBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuEnumBootCommand(int, EnumMenuItem, int) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuEnumBootCommand
MenuFloatBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuFloatBootCommand(int, FloatMenuItem, Float) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuFloatBootCommand
MenuHeartbeatCommand - Class in com.thecoderscorner.menu.remote.commands
MenuHeartbeatCommand(int, MenuHeartbeatCommand.HeartbeatMode) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand
MenuHeartbeatCommand.HeartbeatMode - Enum in com.thecoderscorner.menu.remote.commands
menuItem() - Method in class com.thecoderscorner.menu.domain.ActionMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.EnumMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.FloatMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
MenuItem<T> - Class in com.thecoderscorner.menu.domain: The base class for all menu items, has the most basic operations available on it that are needed by pretty much all menu items.
MenuItem(String, int, int, String, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.MenuItem
MenuItemBuilder<T extends MenuItemBuilder> - Class in com.thecoderscorner.menu.domain
MenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.MenuItemBuilder
menuItemChanged(MenuItem, boolean) - Method in interface com.thecoderscorner.menu.remote.RemoteControllerListener: Called when a menu item has either been added or changed, the valueOnly indicates if the change is just in the latest value, or also in the MenuItem structure too.
MenuItemHelper - Class in com.thecoderscorner.menu.domain.util: A helper class for dealing with MenuItem objects.
MenuItemHelper() - Constructor for class com.thecoderscorner.menu.domain.util.MenuItemHelper
MenuItemVisitor - Interface in com.thecoderscorner.menu.domain.util: An implementation of the visitor pattern for TcMenu.
MenuJoinCommand - Class in com.thecoderscorner.menu.remote.commands
MenuJoinCommand(String, ApiPlatform, int) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
MenuJoinCommand(UUID, String, ApiPlatform, int) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
MenuLargeNumBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuLargeNumBootCommand(int, EditableLargeNumberMenuItem, BigDecimal) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuLargeNumBootCommand
MenuPairingCommand - Class in com.thecoderscorner.menu.remote.commands
MenuPairingCommand(String, UUID) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuPairingCommand
MenuRuntimeListBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuRuntimeListBootCommand(int, RuntimeListMenuItem, List<String>) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuRuntimeListBootCommand
MenuState<T> - Class in com.thecoderscorner.menu.domain.state: The base class of menu state, stores the value, if it's active and changed.
MenuState(MenuItem<T>, boolean, boolean, T) - Constructor for class com.thecoderscorner.menu.domain.state.MenuState: normally these states are created from the menu item, instead of directly
MenuSubBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuSubBootCommand(int, SubMenuItem, boolean) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuSubBootCommand
MenuTextBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuTextBootCommand(int, EditableTextMenuItem, String) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuTextBootCommand
MenuTree - Class in com.thecoderscorner.menu.domain.state: Menu tree holds all the menu items for a specific remote connection or session.
MenuTree() - Constructor for class com.thecoderscorner.menu.domain.state.MenuTree: Create a basic tree that is initially empty
MenuTree.MoveType - Enum in com.thecoderscorner.menu.domain.state: Some operations support moving items up or down in the tree, when they do they use this enumeration to describe the direction of the move.
MOVE_DOWN - com.thecoderscorner.menu.domain.state.MenuTree.MoveType
MOVE_UP - com.thecoderscorner.menu.domain.state.MenuTree.MoveType
moveItem(SubMenuItem, MenuItem, MenuTree.MoveType) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Moves the item either up or down in the list for that submenu

N

name - Variable in class com.thecoderscorner.menu.domain.MenuItem
NamedDaemonThreadFactory - Class in com.thecoderscorner.menu.remote
NamedDaemonThreadFactory(String) - Constructor for class com.thecoderscorner.menu.remote.NamedDaemonThreadFactory
newAbsoluteListChangeCommand(CorrelationId, int, List<String>) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Creates a new absolute change command given the menu item ID and the absolute change in value.
newAbsoluteMenuChangeCommand(CorrelationId, int, Object) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Creates a new absolute change command given the menu item ID and the absolute change in value.
newAbsoluteMenuChangeCommand(CorrelationId, MenuItem, Object) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Creates a new absolute change command given the menu item and the absolute change in value.
newAcknowledgementCommand(CorrelationId, AckStatus) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create an acknowledgement message for a given correlation and status
newAnalogBootCommand(int, AnalogMenuItem, int) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create a new analog bootstrap command.
newBootstrapCommand(MenuBootstrapCommand.BootType) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Create a new bootstrap message either to indicate the bootstrap start or end
newDeltaChangeCommand(CorrelationId, int, int) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Creates a new delta change command given the menu item ID and the delta change in value.
newDeltaChangeCommand(CorrelationId, MenuItem, int) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Creates a new delta change command given the menu item and the delta change in value.
newDialogCommand(DialogMode, String, String, MenuButtonType, MenuButtonType, CorrelationId) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newHeartbeatCommand(int, MenuHeartbeatCommand.HeartbeatMode) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Create a new heartbeat message with the frequency specified
newJoinCommand(String) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Create a new join command that has a random UUID
newJoinCommand(String, UUID) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Create a new join command that has a fixed UUID that you provide.
newLargeNumberBootItem(int, EditableLargeNumberMenuItem, BigDecimal) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create a new large number bootstrap command.
newMenuActionBootCommand(int, ActionMenuItem) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create a new action bootstrap command.
newMenuBooleanBootCommand(int, BooleanMenuItem, boolean) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create a new boolean bootstrap command.
newMenuEnumBootCommand(int, EnumMenuItem, int) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create a new enum bootstrap command.
newMenuFloatBootCommand(int, FloatMenuItem, Float) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create a new float bootstrap command.
newMenuState(MenuState<V>) - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
newMenuState(Boolean, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.ActionMenuItem
newMenuState(Boolean, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItem: returns a new menu state object, suitable for storing the current value
newMenuState(Boolean, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.SubMenuItem
newMenuState(Float, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.FloatMenuItem
newMenuState(Integer, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem: returns a new state object that represents the current value for the menu.
newMenuState(Integer, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.EnumMenuItem
newMenuState(String, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItem: Returns a new String current value that can be used as the current value in the Menutree
newMenuState(BigDecimal, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem
newMenuState(List<String>, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItem
newMenuState(T, boolean, boolean) - Method in class com.thecoderscorner.menu.domain.MenuItem
newMenuSubBootCommand(int, SubMenuItem) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create a new submenu bootstrap command.
newMenuTextBootCommand(int, EditableTextMenuItem, String) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: create a new text bootstrap command.
newPairingCommand(String, UUID) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newRuntimeListBootCommand(int, RuntimeListMenuItem, List<String>) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory: Create a new runtime list boot command
newThread(Runnable) - Method in class com.thecoderscorner.menu.remote.NamedDaemonThreadFactory
NONE - com.thecoderscorner.menu.remote.commands.MenuButtonType
NoOperationInitialState - Class in com.thecoderscorner.menu.remote.states
NoOperationInitialState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.NoOperationInitialState
NORMAL - com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode
NOT_CONNECTED - Static variable in class com.thecoderscorner.menu.remote.RemoteInformation
NOT_STARTED - com.thecoderscorner.menu.remote.AuthStatus
notifyConnection() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector: Helper method that notifies all connection listeners of a change in connectivity
notifyListeners(MenuCommand) - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
notifyListeners(MenuCommand) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector: Helper method that notifies all listeners of a new command message

O

OK - com.thecoderscorner.menu.remote.commands.MenuButtonType
ON_OFF - com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming
onCommand(RemoteConnector, MenuCommand) - Method in interface com.thecoderscorner.menu.remote.RemoteConnectorListener: Sent by the connector when a message has been decoded.
ONLY_WHEN_EMPTY - com.thecoderscorner.menu.remote.StreamRemoteConnector.ReadMode

P

PAIRING_CONNECTION - com.thecoderscorner.menu.remote.ConnectMode
PAIRING_REQUEST - com.thecoderscorner.menu.remote.commands.MenuCommandType
PairingAuthFailedState - Class in com.thecoderscorner.menu.remote.states
PairingAuthFailedState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.PairingAuthFailedState
PairingAuthSuccessState - Class in com.thecoderscorner.menu.remote.states
PairingAuthSuccessState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.PairingAuthSuccessState
PairingHelper - Class in com.thecoderscorner.menu.remote.protocol
PairingHelper(RemoteConnector, ScheduledExecutorService, Optional<Consumer<AuthStatus>>) - Constructor for class com.thecoderscorner.menu.remote.protocol.PairingHelper
performConnection() - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
performConnection() - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
performConnection() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
PLAIN_TEXT - com.thecoderscorner.menu.domain.EditItemType
processMessage(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.AwaitingBootstrapState
processMessage(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
processMessage(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.BootstrapInProgressState
processMessage(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.ConnectionReadyState
processMessage(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.JoinMessageArrivedState
processMessage(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.SendPairingMessageState
processMessage(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.SerialAwaitFirstMsgState
processMessage(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.SocketAwaitJoinState
processTimeout() - Method in class com.thecoderscorner.menu.remote.states.AwaitingBootstrapState
processTimeout() - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState
processTimeout() - Method in class com.thecoderscorner.menu.remote.states.BootstrapInProgressState
processTimeout() - Method in class com.thecoderscorner.menu.remote.states.ConnectionReadyState
processTimeout() - Method in class com.thecoderscorner.menu.remote.states.JoinMessageArrivedState
processTimeout() - Method in class com.thecoderscorner.menu.remote.states.SendPairingMessageState
processTimeout() - Method in class com.thecoderscorner.menu.remote.states.SerialAwaitFirstMsgState
processTimeout() - Method in class com.thecoderscorner.menu.remote.states.SocketAwaitJoinState
PROTOCOL_TAG_VAL - Static variable in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol
ProtocolUtil - Class in com.thecoderscorner.menu.remote.protocol: A few general helper method to get the version and platform information to and from messages.
ProtocolUtil() - Constructor for class com.thecoderscorner.menu.remote.protocol.ProtocolUtil

R

READ_MORE - com.thecoderscorner.menu.remote.StreamRemoteConnector.ReadMode
readCommandFromStream() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
readCommandFromStream() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
readCompleteMessage(ByteBuffer) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
readOnly - Variable in class com.thecoderscorner.menu.domain.MenuItem
registerConnectionChangeListener(ConnectionChangeListener) - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: Register for information about connection state
registerConnectionChangeListener(ConnectionChangeListener) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector: Register for connection change events, when there is a change in connectivity status on the underlying transport.
registerConnectorListener(RemoteConnectorListener) - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: register a listener that will receive any messages sent by the menu library
registerConnectorListener(RemoteConnectorListener) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector: Register for connector messages, when new messages are received from this stream.
REMOTE_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
RemoteConnector - Interface in com.thecoderscorner.menu.remote: This is the base interface implemented by all remote connectors, it provides the means to both send and receive menu commands.
RemoteConnectorContext - Interface in com.thecoderscorner.menu.remote.states
RemoteConnectorListener - Interface in com.thecoderscorner.menu.remote: This is the low level, communication listener interface that you implement in order to know when commands have been received from the remote device.
RemoteConnectorState - Interface in com.thecoderscorner.menu.remote.states
RemoteControllerListener - Interface in com.thecoderscorner.menu.remote: This interface is implemented when you wish to receive update events from a RemoteMenuController.
RemoteInformation - Class in com.thecoderscorner.menu.remote: Represents the remote connection details, such as name and version.
RemoteInformation(String, int, int, ApiPlatform) - Constructor for class com.thecoderscorner.menu.remote.RemoteInformation
RemoteMenuController - Class in com.thecoderscorner.menu.remote: This class manages a single remote connection to an Arduino.
RemoteMenuController(RemoteConnector, MenuTree) - Constructor for class com.thecoderscorner.menu.remote.RemoteMenuController
removeMenuItem(MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Remove the menu item using this menu item as a prototype (Uses the ID for comparison)
removeMenuItem(SubMenuItem, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Remove the menu item for the provided menu item in the provided sub menu.
replaceMenuById(MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Replace a menu item with the given ID.
replaceMenuById(SubMenuItem, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree: Replace the menu item that has a given parent with the one provided.
ROOT - Static variable in class com.thecoderscorner.menu.domain.state.MenuTree: This is the root menu item, the top level item on the display basically
Rs232ControllerBuilder - Class in com.thecoderscorner.menu.remote.rs232: Creates an instance of a RS232 based controller to a given port, and connects it with the selected menu.
Rs232ControllerBuilder() - Constructor for class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder
Rs232RemoteConnector - Class in com.thecoderscorner.menu.remote.rs232: This is the R232 connector that can talk to a tcMenu library application running on an embedded Arduino.
Rs232RemoteConnector(LocalIdentifier, String, int, MenuCommandProtocol, ScheduledExecutorService, Clock, ConnectMode) - Constructor for class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
RUNTIME_LIST_BOOT - com.thecoderscorner.menu.remote.commands.MenuCommandType
RuntimeListMenuItem - Class in com.thecoderscorner.menu.domain
RuntimeListMenuItem() - Constructor for class com.thecoderscorner.menu.domain.RuntimeListMenuItem
RuntimeListMenuItem(String, int, int, String, boolean, boolean, boolean, int) - Constructor for class com.thecoderscorner.menu.domain.RuntimeListMenuItem
RuntimeListMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs a FloatMenuItem using the standard builder pattern.
RuntimeListMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder

S

SEND_AUTH - com.thecoderscorner.menu.remote.AuthStatus
sendAbsoluteUpdate(MenuItem, Object) - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: Send an asbolute change for the given item
sendAcknowledgement(AckStatus) - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
sendAcknowledgement(AckStatus) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
sendCommand(MenuCommand) - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: Use to send commands directly.
sendDeltaUpdate(MenuItem, int) - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: Send a delta change for the given menuitem
sendDialogAction(MenuButtonType) - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: Send a dialog update
sendHeartbeat(int, MenuHeartbeatCommand.HeartbeatMode) - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
sendHeartbeat(int, MenuHeartbeatCommand.HeartbeatMode) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
sendInternal(ByteBuffer) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
sendInternal(ByteBuffer) - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
sendInternal(ByteBuffer) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector: performs a send of all bytes in the output buffer until the output buffer is empty
sendJoin() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
sendJoin() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
sendMenuCommand(MenuCommand) - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: Sends a command to the menu library running on the embedded hardware.
sendMenuCommand(MenuCommand) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector: Sends a command to the remote with the protocol and usual headers.
sendPairing() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
sendPairing() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
SendPairingMessageState - Class in com.thecoderscorner.menu.remote.states
SendPairingMessageState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.SendPairingMessageState
SerialAwaitFirstMsgState - Class in com.thecoderscorner.menu.remote.states
SerialAwaitFirstMsgState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.SerialAwaitFirstMsgState
setRemoteParty(RemoteInformation) - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext
setRemoteParty(RemoteInformation) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector
setResult(T) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor: Stores the result within a visit call, normally used with visitWithResult
SHOW - com.thecoderscorner.menu.remote.commands.DialogMode
SocketAwaitJoinState - Class in com.thecoderscorner.menu.remote.states
SocketAwaitJoinState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.SocketAwaitJoinState
SocketBasedConnector - Class in com.thecoderscorner.menu.remote.socket: A remote connector that will communicate using a client socket.
SocketBasedConnector(LocalIdentifier, ScheduledExecutorService, Clock, MenuCommandProtocol, String, int, ConnectMode) - Constructor for class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
SocketControllerBuilder - Class in com.thecoderscorner.menu.remote.socket: Creates an instance of a socket based controller to a given port, and connects it with the selected menu.
SocketControllerBuilder() - Constructor for class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder
start() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: Starts the communication channel, so it will attempt to connect with the configured device
start() - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: starts the remote connection such that it will attempt to establish connectivity
start() - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
start() - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
START - com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType
START - com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode
START_OF_MSG - Static variable in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol
stateMachineMappings - Variable in class com.thecoderscorner.menu.remote.StreamRemoteConnector
stop() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: Stops the library and attempts to also stop any threads and other resources associated.
stop() - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: attempt to stop the underlying connector
stop() - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
stop() - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector
StreamNotConnectedState - Class in com.thecoderscorner.menu.remote.states
StreamNotConnectedState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.StreamNotConnectedState
StreamRemoteConnector - Class in com.thecoderscorner.menu.remote: Stream remote connector is the base class for all stream implementations, such as Socket and RS232.
StreamRemoteConnector(LocalIdentifier, MenuCommandProtocol, ScheduledExecutorService, Clock) - Constructor for class com.thecoderscorner.menu.remote.StreamRemoteConnector
StreamRemoteConnector.ReadMode - Enum in com.thecoderscorner.menu.remote
StringListMenuState - Class in com.thecoderscorner.menu.domain.state: An implementation of menu state for lists of string.
StringListMenuState(MenuItem<List<String>>, boolean, boolean, String...) - Constructor for class com.thecoderscorner.menu.domain.state.StringListMenuState
StringListMenuState(MenuItem<List<String>>, boolean, boolean, List<String>) - Constructor for class com.thecoderscorner.menu.domain.state.StringListMenuState
StringMenuState - Class in com.thecoderscorner.menu.domain.state: An implementation of menu state for Strings.
StringMenuState(MenuItem<String>, boolean, boolean, String) - Constructor for class com.thecoderscorner.menu.domain.state.StringMenuState
SUBMENU_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
SubMenuItem - Class in com.thecoderscorner.menu.domain: SubMenuItem represents a menu item that has children.
SubMenuItem() - Constructor for class com.thecoderscorner.menu.domain.SubMenuItem
SubMenuItem(String, int, int, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.SubMenuItem
SubMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs a SubMenuItemBuilder using the standard builder pattern.
SubMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.SubMenuItemBuilder
SUCCESS - com.thecoderscorner.menu.remote.commands.AckStatus: The operation was successful

T

TagValMenuCommandProtocol - Class in com.thecoderscorner.menu.remote.protocol: A protocol implementation that uses tag value pair notation with a few special text items in order to create messages that can be transmitted.
TagValMenuCommandProtocol() - Constructor for class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol
TagValMenuFields - Interface in com.thecoderscorner.menu.remote.protocol: Field names are used to represent the possible field names that can be sent to a remote menu.
TagValTextParser - Class in com.thecoderscorner.menu.remote.protocol: This is the parser implementation that understands tag value format and can convert the tags back into a series of tags and values suitable for the protocol to decode messages.
TagValTextParser(ByteBuffer) - Constructor for class com.thecoderscorner.menu.remote.protocol.TagValTextParser: Creates an instance that contains all the tags and values in a map, that can then be used to extract the message.
TcProtocolException - Exception in com.thecoderscorner.menu.remote.protocol: An exception that indicates a problem during protocol conversion
TcProtocolException(String) - Constructor for exception com.thecoderscorner.menu.remote.protocol.TcProtocolException
TcProtocolException(String, Throwable) - Constructor for exception com.thecoderscorner.menu.remote.protocol.TcProtocolException
TEXT_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
TIME_12H - com.thecoderscorner.menu.domain.EditItemType
TIME_24_HUNDREDS - com.thecoderscorner.menu.domain.EditItemType
TIME_24H - com.thecoderscorner.menu.domain.EditItemType
toChannel(ByteBuffer, MenuCommand) - Method in interface com.thecoderscorner.menu.remote.MenuCommandProtocol: Puts the command specified into the byte buffer, it is assumed that the callee will flip the channel once complete.
toChannel(ByteBuffer, MenuCommand) - Method in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProtocol
toString() - Method in class com.thecoderscorner.menu.domain.MenuItem
toString() - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
toString() - Method in class com.thecoderscorner.menu.remote.commands.MenuAcknowledgementCommand
toString() - Method in class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand
toString() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
toString() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand
toString() - Method in class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand
toString() - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
toString() - Method in class com.thecoderscorner.menu.remote.commands.MenuPairingCommand
toString() - Method in class com.thecoderscorner.menu.remote.protocol.CorrelationId: Gets the value of the ID as a hex string
toString() - Method in class com.thecoderscorner.menu.remote.protocol.TagValTextParser
toString() - Method in class com.thecoderscorner.menu.remote.RemoteInformation
treeFullyPopulated() - Method in interface com.thecoderscorner.menu.remote.RemoteControllerListener: Indicates that the tree is now fully populated, and therefore all menus that exist on the Arduino also exist locally in the MenuTree.
TRUE_FALSE - com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming

U

UNKNOWN_ERROR - com.thecoderscorner.menu.remote.commands.AckStatus: There was an error that is not categorised.

V

VALUE_RANGE_WARNING - com.thecoderscorner.menu.remote.commands.AckStatus: This is a warning that the value was out of range
valueOf(String) - Static method in enum com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.domain.EditItemType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.domain.state.MenuTree.MoveType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.AuthStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.commands.AckStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.commands.DialogMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.commands.MenuButtonType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.commands.MenuCommandType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.ConnectMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.protocol.ApiPlatform: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.thecoderscorner.menu.remote.StreamRemoteConnector.ReadMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.domain.EditItemType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.domain.state.MenuTree.MoveType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.AuthStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.commands.AckStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.commands.DialogMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.commands.MenuButtonType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.commands.MenuCommandType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.ConnectMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.protocol.ApiPlatform: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.thecoderscorner.menu.remote.StreamRemoteConnector.ReadMode: Returns an array containing the constants of this enum type, in the order they are declared.
visible - Variable in class com.thecoderscorner.menu.domain.MenuItem
visit(ActionMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(ActionMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: This will be called during visit for an action item
visit(AnalogMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(AnalogMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: This will be called during visit for an analog item
visit(BooleanMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(BooleanMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: This will be called during visit for a boolean item
visit(EditableLargeNumberMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(EditableLargeNumberMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: This will be called during visit for a large number item
visit(EditableTextMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(EditableTextMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: This will be called during visit for a text item
visit(EnumMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(EnumMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: This will be called during visit for an enumeration item
visit(FloatMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(FloatMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: This will be called during visit for an floating point item
visit(RuntimeListMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(RuntimeListMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: this will be called during visit for a list item
visit(SubMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(SubMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor: This will be called during visit for sub menu
visitWithResult(MenuItem, AbstractMenuItemVisitor<T>) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper: Visits a menu item calling the appropriate function for the type and collects the result that is set by calling your visitor's `setResult` method.

W

withAddress(String) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Mandatory, the address on which this socket is to bind to receive and send datagrams.
withClock(Clock) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Optional, defaults to system clock but can be overriden
withClock(Clock) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Optional, defaults to system clock but can be overriden
withDecimalPlaces(int) - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItemBuilder
withDecimalPlaces(int) - Method in class com.thecoderscorner.menu.domain.FloatMenuItemBuilder
withDivisor(int) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
withEditItemType(EditItemType) - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItemBuilder
withEepromAddr(int) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
withEnumList(List<String>) - Method in class com.thecoderscorner.menu.domain.EnumMenuItemBuilder
withExecutor(ScheduledExecutorService) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Optional, defaults to creating a suitable executor for single connectivity
withExecutor(ScheduledExecutorService) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Optional, defaults to creating a suitable executor for single connectivity
withExisting(ActionMenuItem) - Method in class com.thecoderscorner.menu.domain.ActionMenuItemBuilder
withExisting(AnalogMenuItem) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
withExisting(BooleanMenuItem) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
withExisting(EditableLargeNumberMenuItem) - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItemBuilder
withExisting(EditableTextMenuItem) - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItemBuilder
withExisting(EnumMenuItem) - Method in class com.thecoderscorner.menu.domain.EnumMenuItemBuilder
withExisting(FloatMenuItem) - Method in class com.thecoderscorner.menu.domain.FloatMenuItemBuilder
withExisting(RuntimeListMenuItem) - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder
withExisting(SubMenuItem) - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
withFunctionName(String) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
withId(int) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
withInitialRows(int) - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder
withLength(int) - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItemBuilder
withLocalName(String) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Optional, Set the name of this connection, defaults to NoName
withLocalName(String) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Mandatory, Set the name of this connection
withLocalOnly(boolean) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
withMaxValue(int) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
withMenuTree(MenuTree) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Mandatory, the menuTree instance to store the menu items retrieved from the remote side.
withMenuTree(MenuTree) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Mandatory, the menuTree instance to store the menu items retrieved from the remote side.
withName(String) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
withNaming(BooleanMenuItem.BooleanNaming) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
withOffset(int) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
withPort(int) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Mandatory, the port locally on which to bind for multicast packets.
withProtocol(MenuCommandProtocol) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Optional, defaults to the standard protocol.
withProtocol(MenuCommandProtocol) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Optional, defaults to the standard protocol.
withReadOnly(boolean) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
withRs232(String, int) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Mandatory, specifies the port name and baud rate for rs232.
withSecured(boolean) - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
withTotalDigits(int) - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItemBuilder
withUnit(String) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
withUUID(UUID) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Mandatory, the UUID for this instance of the application
withUUID(UUID) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder: Mandatory, Set the UUID of this instance of the client
withVisible(boolean) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder

Y

YES_NO - com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming

A B C D E F G H I J K L M N O P R S T U V W Y
All Classes All Packages