Index (tcMenuJavaAPI 0.3 API)

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

A

aBooleanMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
ABSOLUTE - com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType
AbstractMenuItemVisitor<T> - Class in com.thecoderscorner.menu.domain.util
AbstractMenuItemVisitor() - Constructor for class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
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.EnumMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.MenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.SubMenuItem
accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.TextMenuItem
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
addOrUpdateItem(int, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
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) - 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
ApiPlatform - Enum in com.thecoderscorner.menu.remote.protocol: Provides a list of the support platforms as an enumeration.
ARDUINO_8 - com.thecoderscorner.menu.remote.protocol.ApiPlatform
asSubMenu(MenuItem) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper
aSubMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
aTextMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.TextMenuItemBuilder

B

baseFromExisting(MenuItem) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
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) - 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(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
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.

C

CHANGE_INT_FIELD - com.thecoderscorner.menu.remote.commands.MenuCommandType
changeItem(MenuItem<T>, MenuState<T>) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
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
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.rs232.Rs232RemoteConnector
com.thecoderscorner.menu - package com.thecoderscorner.menu
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
CommandFactory - Class in com.thecoderscorner.menu.remote.commands: Static helper methods that create various types of messages, prefer this method over creating instances directly
CommandFactory() - Constructor for class com.thecoderscorner.menu.remote.commands.CommandFactory
connectionChange(RemoteConnector, boolean) - 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.
connectionState(RemoteInformation, boolean) - Method in interface com.thecoderscorner.menu.remote.RemoteControllerListener: Indicates a change in connectivity
createFromExistingWithId(MenuItem, int) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

D

DELTA - com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType

E

eepromAddress - Variable in class com.thecoderscorner.menu.domain.MenuItem
eepromSizeForItem(MenuItem) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper
END - com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType
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>) - 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.AnalogMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItem
equals(Object) - Method in class com.thecoderscorner.menu.domain.EnumMenuItem
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.domain.TextMenuItem

F

findParent(MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
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
fromKeyToApiPlatform(int) - Static method in class com.thecoderscorner.menu.remote.protocol.ProtocolUtil: get the api platform given it's integer key value.
functionName - Variable in class com.thecoderscorner.menu.domain.MenuItem

G

getAllSubMenus() - Method in class com.thecoderscorner.menu.domain.state.MenuTree
getApiVersion() - Method in class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
getBootType() - Method in class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand
getChangeType() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
getCode() - Method in enum com.thecoderscorner.menu.remote.commands.MenuCommandType
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.MenuEnumBootCommand
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.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 (for example rs232-comport)
getConnectionName() - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
getConnector() - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: get the underlying connectivity, rarely needed
getCurrentValue() - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
getDescription() - Method in enum com.thecoderscorner.menu.remote.protocol.ApiPlatform
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
getId() - Method in class com.thecoderscorner.menu.domain.MenuItem: gets the ID for the menu item
getKey() - Method in enum com.thecoderscorner.menu.remote.protocol.ApiPlatform
getMajorVersion() - Method in class com.thecoderscorner.menu.remote.RemoteInformation: the major version of the remote host
getMaxValue() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem: The maximum value (0 based integer) that this item can represent
getMenuById(SubMenuItem, int) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
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
getMenuState(MenuItem<T>) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
getMinorVersion() - Method in class com.thecoderscorner.menu.remote.RemoteInformation: the minor version of the remote host
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.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.
getOffset() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem: The offset from 0 that is used when displaying the item, can be negative
getParentItemId() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand
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
getRemotePartyInfo() - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: get the name of the device that we've connected to.
getResult() - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
getSubMenuById(int) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
getSubMenuId() - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
getTextLength() - Method in class com.thecoderscorner.menu.domain.TextMenuItem: The maximum length allowable.
getThis() - Method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
getThis() - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
getThis() - Method in class com.thecoderscorner.menu.domain.TextMenuItemBuilder
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"
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.
getVersionFromProperties() - Static method in class com.thecoderscorner.menu.remote.protocol.ProtocolUtil: gets and caches the current version from the version properties file

H

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: SubMenuItems always have child items, so they always return true
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.EnumMenuItem
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.domain.TextMenuItem
HEARTBEAT - com.thecoderscorner.menu.remote.commands.MenuCommandType

I

id - Variable in class com.thecoderscorner.menu.domain.MenuItem
IntegerMenuState - Class in com.thecoderscorner.menu.domain.state: An implementation of menu state for integer values.
IntegerMenuState(boolean, boolean, Integer) - Constructor for class com.thecoderscorner.menu.domain.state.IntegerMenuState
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<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<V>) - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
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
isConnected() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector: Gets the underlying connection state for this connector.
isConnected() - Method in class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector
isTreeFullyPopulated() - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: Check if all the menu items from the remote device are available locally yet.

J

JAVA_API - com.thecoderscorner.menu.remote.protocol.ApiPlatform
JOIN - com.thecoderscorner.menu.remote.commands.MenuCommandType

K

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_CHANGE_TYPE - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields
KEY_CURRENT_VAL - 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_MSG_TYPE - 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_VER_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields

M

Main - Class in com.thecoderscorner.menu
Main() - Constructor for class com.thecoderscorner.menu.Main
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
MenuChangeCommand - Class in com.thecoderscorner.menu.remote.commands
MenuChangeCommand(int, int, MenuChangeCommand.ChangeType, int) - 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.
MenuEnumBootCommand - Class in com.thecoderscorner.menu.remote.commands
MenuEnumBootCommand(int, EnumMenuItem, int) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuEnumBootCommand
MenuHeartbeatCommand - Class in com.thecoderscorner.menu.remote.commands
MenuHeartbeatCommand() - Constructor for class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand
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.EnumMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
menuItem() - Method in class com.thecoderscorner.menu.domain.TextMenuItemBuilder
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) - 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
MenuItemHelper() - Constructor for class com.thecoderscorner.menu.domain.util.MenuItemHelper
MenuItemVisitor - Interface in com.thecoderscorner.menu.domain.util
MenuJoinCommand - Class in com.thecoderscorner.menu.remote.commands
MenuJoinCommand(String, ApiPlatform, int) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuJoinCommand
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(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, TextMenuItem, String) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuTextBootCommand
MenuTree - Class in com.thecoderscorner.menu.domain.state
MenuTree() - Constructor for class com.thecoderscorner.menu.domain.state.MenuTree
MenuTree.MoveType - Enum in com.thecoderscorner.menu.domain.state
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

N

name - Variable in class com.thecoderscorner.menu.domain.MenuItem
newAbsoluteMenuChangeCommand(int, int, int) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newAnalogBootCommand(int, AnalogMenuItem, int) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newBootstrapCommand(MenuBootstrapCommand.BootType) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newDeltaChangeCommand(int, int, int) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newHeartbeatCommand() - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newJoinCommand(String) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newMenuBooleanBootCommand(int, BooleanMenuItem, boolean) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newMenuEnumBootCommand(int, EnumMenuItem, int) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
newMenuState(MenuState<V>) - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand
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(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.TextMenuItem: Returns a new String current value that can be used as the current value in the Menutree
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
newMenuTextBootCommand(int, TextMenuItem, String) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory
NOT_CONNECTED - Static variable in class com.thecoderscorner.menu.remote.RemoteInformation

O

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.

P

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

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.rs232.Rs232RemoteConnector
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.rs232.Rs232RemoteConnector
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.
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.
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, ScheduledExecutorService, String, Clock, int) - Constructor for class com.thecoderscorner.menu.remote.RemoteMenuController
removeMenuItem(MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
removeMenuItem(SubMenuItem, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
replaceMenuById(MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
replaceMenuById(SubMenuItem, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree
ROOT - Static variable in class com.thecoderscorner.menu.domain.state.MenuTree
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(String, int, MenuCommandProtocol, ScheduledExecutorService) - Constructor for class com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector

S

sendCommand(MenuCommand) - Method in class com.thecoderscorner.menu.remote.RemoteMenuController: send a command to the Arduino, normally use the CommandFactory to generate the command
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.rs232.Rs232RemoteConnector
setResult(T) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
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 - com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType
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
StringMenuState - Class in com.thecoderscorner.menu.domain.state: An implementation of menu state for Strings.
StringMenuState(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) - 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

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.
TEXT_BOOT_ITEM - com.thecoderscorner.menu.remote.commands.MenuCommandType
TextMenuItem - Class in com.thecoderscorner.menu.domain: An implementation of menu item that can store text strings.
TextMenuItem() - Constructor for class com.thecoderscorner.menu.domain.TextMenuItem
TextMenuItem(String, int, int, String, int) - Constructor for class com.thecoderscorner.menu.domain.TextMenuItem
TextMenuItemBuilder - Class in com.thecoderscorner.menu.domain: Constructs a TextMenuItemBuilder using the standard builder pattern.
TextMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.TextMenuItemBuilder
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.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

V

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.state.MenuTree.MoveType: 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.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.protocol.ApiPlatform: 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.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.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.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.protocol.ApiPlatform: Returns an array containing the constants of this enum type, in the order they are declared.
visit(AnalogMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(AnalogMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor
visit(BooleanMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(BooleanMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor
visit(EnumMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(EnumMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor
visit(SubMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(SubMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor
visit(TextMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor
visit(TextMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor
visitWithResult(MenuItem, AbstractMenuItemVisitor<T>) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

W

withClock(Clock) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Optional, defaults to system clock but can be overriden
withDivisor(int) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
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
withExisting(AnalogMenuItem) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder
withExisting(BooleanMenuItem) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder
withExisting(EnumMenuItem) - Method in class com.thecoderscorner.menu.domain.EnumMenuItemBuilder
withExisting(SubMenuItem) - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder
withExisting(TextMenuItem) - Method in class com.thecoderscorner.menu.domain.TextMenuItemBuilder
withFunctionName(String) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
withHeartbeatFrequency(int) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Optional, defaults to 10 seconds between heartbeats.
withId(int) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder
withLength(int) - Method in class com.thecoderscorner.menu.domain.TextMenuItemBuilder
withLocalName(String) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Optional, Set the name of this connection, defaults to NoName
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.
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
withProtocol(MenuCommandProtocol) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Optional, defaults to the standard protocol.
withRs232(String, int) - Method in class com.thecoderscorner.menu.remote.rs232.Rs232ControllerBuilder: Mandatory, specifies the port name and baud rate for rs232.
withUnit(String) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder

Y

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

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