Index

A B C D E F G H I J K L M N O P R S T U V W X Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

aBooleanMenuItemBuilder() - Static method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder

ABSOLUTE - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType

ABSOLUTE_LIST - Enum constant in enum class 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 MenuItemVisitor for more info.

accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItem

accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.CustomBuilderMenuItem

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.Rgb32MenuItem

accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItem

accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

accept(MenuItemVisitor) - Method in class com.thecoderscorner.menu.domain.SubMenuItem

ACCEPT - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

The accept button

ACKNOWLEDGEMENT - Static variable in interface 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 Class in com.thecoderscorner.menu.remote.commands

An enumeration that represents all the possible status / error return codes from the remote.

ACTION - Enum constant in enum class com.thecoderscorner.menu.remote.commands.DialogMode

perform the following action on the dialog

ACTION_BOOT_ITEM - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

ACTION_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

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, String, int, String, int, boolean, 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

aCustomBuilderItemBuilder() - Static method in class com.thecoderscorner.menu.domain.CustomBuilderMenuItemBuilder

addAuthentication(String, UUID, boolean) - Method in interface com.thecoderscorner.menu.auth.MenuAuthenticator

Attempt to add authentication for user and UUID, if it fails to be added false will be returned.

addAuthentication(String, UUID, boolean) - Method in class com.thecoderscorner.menu.auth.PreDefinedAuthenticator

addAuthentication(String, UUID, boolean) - Method in class com.thecoderscorner.menu.auth.PropertiesAuthenticator

Adds an authentication token to the store, it assumes that all appropriate permission from the user has been sought.

addConnectionManager(ServerConnectionManager) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Add a connection manager to the list of connection managers.

addCustomMessageProcessor(MessageField, BiConsumer<MenuManagerServer, MenuCommand>) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Allows user level additional message processors for custom messages.

addCustomMessageProcessor(MessageField, BiConsumer<RemoteMenuController, MenuCommand>) - Method in class com.thecoderscorner.menu.remote.RemoteMenuController

Allows user level additional message processors for custom messages.

addEnumValue(String) - Method in class com.thecoderscorner.menu.domain.EnumMenuItemBuilder

addHandlersToProtocol(ConfigurableProtocolConverter) - Method in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProcessors

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.

addMenuManagerListener(MenuManagerListener) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Add a listener that will receive menu item events, such as when items change, and also when scroll choice values are needed.

addOrUpdateItem(int, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

This will either add or update an existing item, depending on the ID is already present.

addRawInProcessor(MessageField, RawProtocolIncomingMsgConverter) - Method in class com.thecoderscorner.menu.remote.protocol.ConfigurableProtocolConverter

This method adds an additional binary message processor that can convert an incoming wire message into a command.

addRawOutProcessor(MessageField, ProtocolOutgoingMsgConverter<T, ByteBuffer>, Class<T>) - Method in class com.thecoderscorner.menu.remote.protocol.ConfigurableProtocolConverter

This method adds an addition binary message processor that can convert a MenuCommand into binary wire format, you must write 4 bytes containing the length first.

addTagValInProcessor(MessageField, TagValProtocolIncomingMsgConverter) - Method in class com.thecoderscorner.menu.remote.protocol.ConfigurableProtocolConverter

This method adds an additional tag value message processor that can convert an incoming wire message into a command.

addTagValOutProcessor(MessageField, ProtocolOutgoingMsgConverter<T, StringBuilder>, Class<T>) - Method in class com.thecoderscorner.menu.remote.protocol.ConfigurableProtocolConverter

This methods adds an additional tag value message processor that can convert a MenuCommand into the appropriate wire format for sending.

addTreeStructureChangeListener(MenuTreeStructureChangeListener) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Add a callback that will run when the tree has structurally changed.

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 - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

ANALOG_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

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, String, int, int, String, int, int, int, int, String, boolean, 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.

AnyMenuState - Interface in com.thecoderscorner.menu.domain.state

AnyMenuState represents any menu state of any type, it is a convenience that allows for non-generic access to a menu state of any type, where the type is not important.

AnyMenuState.StateStorageType - Enum Class in com.thecoderscorner.menu.domain.state

Represents the storage type for the state.

ApiPlatform - Enum Class in com.thecoderscorner.menu.remote.protocol

Provides a list of the support platforms as an enumeration.

appendElementWithNameValue(Element, String, Object) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Append a new element into the parent provided with the name given.

appendField(StringBuilder, String, Object) - Static method in class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProcessors

apply(B, T) - Method in interface com.thecoderscorner.menu.remote.protocol.ProtocolOutgoingMsgConverter

apply(TagValTextParser) - Method in interface com.thecoderscorner.menu.remote.protocol.TagValProtocolIncomingMsgConverter

apply(ByteBuffer, int) - Method in interface com.thecoderscorner.menu.remote.protocol.RawProtocolIncomingMsgConverter

applyIncrementalValueChange(MenuItem, int, MenuTree) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

Try and apply an incremental delta value update to a menu tree.

ARDUINO - Enum constant in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

ARDUINO32 - Enum constant in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

ARRAY_IN_EEPROM - Enum constant in enum class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem.ScrollChoiceMode

ARRAY_IN_RAM - Enum constant in enum class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem.ScrollChoiceMode

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

Attempt to pair with a remote optionally providing a listener that gets notified of status for updating a UI for example.

attemptPairing(Optional<Consumer<AuthStatus>>) - Method in class com.thecoderscorner.menu.remote.socket.SocketControllerBuilder

authenticate(String, UUID) - Method in interface com.thecoderscorner.menu.auth.MenuAuthenticator

Check if the user and UUID pair can connect to this board.

authenticate(String, UUID) - Method in class com.thecoderscorner.menu.auth.PreDefinedAuthenticator

authenticate(String, UUID) - Method in class com.thecoderscorner.menu.auth.PropertiesAuthenticator

AUTHENTICATED - Enum constant in enum class com.thecoderscorner.menu.mgr.ServerConnectionMode

A fully authenticated connection

AUTHENTICATED - Enum constant in enum class com.thecoderscorner.menu.remote.AuthStatus

AUTHENTICATION - Enum constant in enum class com.thecoderscorner.menu.domain.CustomBuilderMenuItem.CustomMenuType

AuthenticationToken(String, String) - Constructor for class com.thecoderscorner.menu.auth.PreDefinedAuthenticator.AuthenticationToken

AuthStatus - Enum Class in com.thecoderscorner.menu.remote

the authentication states that a RemoteMenuController can be in.

AWAITING_CONNECTION - Enum constant in enum class 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(M) - 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

BETA - Enum constant in enum class com.thecoderscorner.menu.persist.ReleaseType

BIG_DECIMAL - Enum constant in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

BigDecimalMenuState - Class in com.thecoderscorner.menu.domain.state

Used to store the decimal state of large number menu item in the menu tree.

BigDecimalMenuState(MenuItem, boolean, boolean, BigDecimal) - Constructor for class com.thecoderscorner.menu.domain.state.BigDecimalMenuState

Creates a state that can store a big decimal

BLACK - Static variable in class com.thecoderscorner.menu.domain.state.PortableColor

BOOLEAN - Enum constant in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

BOOLEAN_BOOT_ITEM - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

BOOLEAN_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

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, String, int, int, String, BooleanMenuItem.BooleanNaming, boolean, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.BooleanMenuItem

BooleanMenuItem.BooleanNaming - Enum Class 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) - Constructor for class com.thecoderscorner.menu.domain.state.BooleanMenuState

BOOT_RGB_COLOR - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

BOOT_SCROLL_CHOICE - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

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 - Static variable in interface 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 - Enum constant in enum class com.thecoderscorner.menu.remote.AuthStatus

build() - Method in interface com.thecoderscorner.menu.remote.ConnectorFactory

Build a remote connection from the factory and return a controller that can be used to manage the menu on a remote device.

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.

builderWithExisting(MenuItem) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

bundleIfPossible(String) - Method in class com.thecoderscorner.menu.domain.util.MenuItemFormatter

button1 - Variable in class com.thecoderscorner.menu.mgr.DialogManager

button2 - Variable in class com.thecoderscorner.menu.mgr.DialogManager

buttonWasPressed(MenuButtonType) - Method in class com.thecoderscorner.menu.mgr.DialogManager

This can be overridden if needed, it will be called whenever a button is pressed.

C

CAN_REMOVE - Enum constant in enum class com.thecoderscorner.menu.auth.MenuAuthenticator.ManagementCapabilities

Only removal is possible

CAN_REMOVE_ADD - Enum constant in enum class com.thecoderscorner.menu.auth.MenuAuthenticator.ManagementCapabilities

Both removal and addition is allowed

CANCEL - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

The cancel button

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.ConnectionHasFailedState

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

canSendMessageNow(MenuCommand) - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

canSendMessageNow(MenuCommand) - Method in class com.thecoderscorner.menu.remote.SharedStreamConnection

canSendMessageNow(MenuCommand) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

CHANGE_INT_FIELD - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

changeItem(MenuItem, AnyMenuState) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

Change the value that's associated with a menu item.

changeLocale(Locale) - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

changeLocale(Locale) - Method in class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

changeLocale(Locale) - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

changeLocale(Locale) - Method in class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

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

CHECKBOX - Enum constant in enum class com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming

checkIfThereIsAnHbEnd(MenuCommand) - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState

checkItemValueCanPersist(PersistedMenu) - Static method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

There are some menu types that should not have a default value, these generally don't have a value associated with them that can be easily saved, such as lists, action items, builder items and submenus.

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 - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

The close button

closeConnection() - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

close the current connection if it is open

closeConnection() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

cmdBuffer - Variable in class com.thecoderscorner.menu.remote.SharedStreamConnection

com.thecoderscorner.menu.auth - package com.thecoderscorner.menu.auth

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.mgr - package com.thecoderscorner.menu.mgr

com.thecoderscorner.menu.persist - package com.thecoderscorner.menu.persist

com.thecoderscorner.menu.remote - package com.thecoderscorner.menu.remote

com.thecoderscorner.menu.remote.commands - package com.thecoderscorner.menu.remote.commands

com.thecoderscorner.menu.remote.mgrclient - package com.thecoderscorner.menu.remote.mgrclient

com.thecoderscorner.menu.remote.protocol - package com.thecoderscorner.menu.remote.protocol

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

CommandProtocol - Enum Class in com.thecoderscorner.menu.remote.protocol

ConfigurableProtocolConverter - Class in com.thecoderscorner.menu.remote.protocol

An implementation of the menu command protocol interface that is configurable, by default it can create all the regular tag value message processors so that regular embedCONTROL messages can be parsed and written.

ConfigurableProtocolConverter(boolean) - Constructor for class com.thecoderscorner.menu.remote.protocol.ConfigurableProtocolConverter

CONNECTION_FAILED - Enum constant in enum class com.thecoderscorner.menu.remote.AuthStatus

CONNECTION_READY - Enum constant in enum class 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.

connectionCreated(ServerConnection) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Indicates that a connection has been created, implementing the NewServerConnectionListener.

connectionCreated(ServerConnection) - Method in interface com.thecoderscorner.menu.mgr.NewServerConnectionListener

ConnectionHasFailedState - Class in com.thecoderscorner.menu.remote.states

ConnectionHasFailedState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.ConnectionHasFailedState

connectionLog(System.Logger.Level, String) - Method in class com.thecoderscorner.menu.remote.SharedStreamConnection

connectionLog(System.Logger.Level, String, Throwable) - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

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 Class in com.thecoderscorner.menu.remote

Connection mode indicates what kind of client to server connection has been established

ConnectorFactory - Interface in com.thecoderscorner.menu.remote

A base connection factory for client side remote connectors that can build connections and try to pair with a device.

context - Variable in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState

copyTextToItems(String) - Method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

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

CurrentScrollPosition - Class in com.thecoderscorner.menu.domain.state

Represents a scroll position as used by ScrollChoiceMenuItems, it holds the position and the current string value.

CurrentScrollPosition(int, String) - Constructor for class com.thecoderscorner.menu.domain.state.CurrentScrollPosition

Create from the position and value

CurrentScrollPosition(String) - Constructor for class com.thecoderscorner.menu.domain.state.CurrentScrollPosition

Create from a textual representation in the form, position-value, EG 1-Pizza

CurrentScrollPositionMenuState - Class in com.thecoderscorner.menu.domain.state

An implementation of menu state for integer values.

CurrentScrollPositionMenuState(MenuItem, boolean, boolean, CurrentScrollPosition) - Constructor for class com.thecoderscorner.menu.domain.state.CurrentScrollPositionMenuState

CUSTOM_ITEM_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

CUSTOM_RENDERFN - Enum constant in enum class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem.ScrollChoiceMode

CustomBuilderMenuItem - Class in com.thecoderscorner.menu.domain

This is a custom menu item that can be created by the designer, but does not directly represent a different item in the API.

CustomBuilderMenuItem(String, String, int, int, String, boolean, boolean, boolean, CustomBuilderMenuItem.CustomMenuType) - Constructor for class com.thecoderscorner.menu.domain.CustomBuilderMenuItem

CustomBuilderMenuItem.CustomMenuType - Enum Class in com.thecoderscorner.menu.domain

CustomBuilderMenuItemBuilder - Class in com.thecoderscorner.menu.domain

Constructs a BooleanMenuItemBuilder using the standard builder pattern.

CustomBuilderMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.CustomBuilderMenuItemBuilder

D

dataReceived(ServerConnection, String) - Method in class com.thecoderscorner.menu.remote.protocol.ProtocolHelper

DEFAULT_LOCALE - Static variable in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

defaultInstance() - Static method in class com.thecoderscorner.menu.domain.util.MenuItemFormatter

delegate - Variable in class com.thecoderscorner.menu.mgr.DialogManager

DELTA - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType

DIALOG_UPDATE - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

dialogDidChange() - Method in class com.thecoderscorner.menu.mgr.DialogManager

this should be overridden to update the UI, it signifies that the dialog has changed

dialogDidChange() - Method in class com.thecoderscorner.menu.mgr.EmptyDialogManager

DialogManager - Class in com.thecoderscorner.menu.mgr

Dialog Manager provides the capability to work with dialogs, to present them, change the values of them and also to update them from a remote command arriving.

DialogManager() - Constructor for class com.thecoderscorner.menu.mgr.DialogManager

DialogMode - Enum Class in com.thecoderscorner.menu.remote.commands

The modes that a dialog can be in, and the transmission type for action too

DialogShowMode - Enum Class in com.thecoderscorner.menu.mgr

Indicates how the dialog should be shown

dialogUpdate(MenuDialogCommand) - 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

DISCONNECTED - Enum constant in enum class com.thecoderscorner.menu.mgr.ServerConnectionMode

The connection with the remote has been lost

disconnectInterval - Variable in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState

DNET_API - Enum constant in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

doesBufferHaveEOM(ByteBuffer) - Static method in class com.thecoderscorner.menu.remote.SharedStreamConnection

doesMatch(String, UUID) - Method in class com.thecoderscorner.menu.auth.PreDefinedAuthenticator.AuthenticationToken

doesPasscodeMatch(String) - Method in interface com.thecoderscorner.menu.auth.MenuAuthenticator

Checks if the provided passcode matches with the security passcode and returns false if it does not match.

doesPasscodeMatch(String) - Method in class com.thecoderscorner.menu.auth.PreDefinedAuthenticator

doesPasscodeMatch(String) - Method in class com.thecoderscorner.menu.auth.PropertiesAuthenticator

E

EditableLargeNumberMenuItem - Class in com.thecoderscorner.menu.domain

A menu item that corresponds to the large number type on the device.

EditableLargeNumberMenuItem() - Constructor for class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem

EditableLargeNumberMenuItem(String, String, int, int, String, int, int, boolean, 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, 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 Class in com.thecoderscorner.menu.domain

Text menu items can represent several types of value and as such the edit type must be defined.

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

elementWithName(Element, String) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Gets an element with a given name or null

EMPTY - Static variable in class com.thecoderscorner.menu.domain.state.ListResponse

EMPTY_CORRELATION - Static variable in class com.thecoderscorner.menu.remote.protocol.CorrelationId

EmptyDialogManager - Class in com.thecoderscorner.menu.mgr

A no-operation implementation of menu item that meets the interface but does nothing.

EmptyDialogManager() - Constructor for class com.thecoderscorner.menu.mgr.EmptyDialogManager

END - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType

END - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode

enterState() - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState

enterState() - Method in class com.thecoderscorner.menu.remote.states.ConnectionHasFailedState

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 - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

ENUM_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

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, String, int, int, String, List<String>, boolean, 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.CustomBuilderMenuItem

equals(Object) - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem

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.Rgb32MenuItem

equals(Object) - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItem

equals(Object) - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

equals(Object) - Method in class com.thecoderscorner.menu.domain.state.CurrentScrollPosition

equals(Object) - Method in class com.thecoderscorner.menu.domain.state.MenuState

equals(Object) - Method in class com.thecoderscorner.menu.domain.state.PortableColor

equals(Object) - Method in class com.thecoderscorner.menu.domain.SubMenuItem

equals(Object) - Method in class com.thecoderscorner.menu.persist.VersionInfo

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

equals(Object) - Method in class com.thecoderscorner.menu.remote.protocol.MessageField

ERROR_VERSION - Static variable in class com.thecoderscorner.menu.persist.VersionInfo

ESTABLISHED_CONNECTION - Enum constant in enum class 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.ConnectionHasFailedState

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 - Enum constant in enum class com.thecoderscorner.menu.remote.AuthStatus

FIELD_TERMINATOR - Static variable in class com.thecoderscorner.menu.remote.protocol.TagValTextParser

findIndexOf(SubMenuItem, MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

findParent(MenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

Finds the submenu that the provided object belongs to.

FLOAT - Enum constant in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

FLOAT_BOOT_ITEM - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

FLOAT_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

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, String, int, String, int, int, boolean, 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, boolean, boolean, Float) - Constructor for class com.thecoderscorner.menu.domain.state.FloatMenuState

formatForDisplay(MenuItem, Object) - Method in class com.thecoderscorner.menu.domain.util.MenuItemFormatter

formatToWire(MenuItem, String) - Method in class com.thecoderscorner.menu.domain.util.MenuItemFormatter

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.ConfigurableProtocolConverter

fromId(int) - Static method in enum class com.thecoderscorner.menu.domain.EditItemType

fromId(String) - Static method in class com.thecoderscorner.menu.remote.protocol.MessageField

fromKeyToApiPlatform(int) - Static method in class com.thecoderscorner.menu.remote.protocol.ProtocolUtil

get the api platform given it's integer key value.

fromProtocolId(byte) - Static method in enum class com.thecoderscorner.menu.remote.protocol.CommandProtocol

fromString(String) - Static method in class com.thecoderscorner.menu.domain.state.ListResponse

Deserialize a ListResponse from a string if possible or return empty

fromString(String) - Static method in class com.thecoderscorner.menu.persist.VersionInfo

FULLY_AUTHENTICATED - Enum constant in enum class com.thecoderscorner.menu.remote.ConnectMode

A connection that is fully authenticated and can modify menus and bootstrap

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

getAllMenuItemsFrom(SubMenuItem) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

Gets every menu item held in this menu tree from a given starting point, the starting point is a sub menu, from that submenu, this method will recurse through the rest of the menu structure and provide a complete list.

getAllNames() - Method in interface com.thecoderscorner.menu.auth.MenuAuthenticator

Gets a list of all apps/users stored in the system

getAllNames() - Method in class com.thecoderscorner.menu.auth.PreDefinedAuthenticator

getAllNames() - Method in class com.thecoderscorner.menu.auth.PropertiesAuthenticator

getAllServerConnections() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

getAllSubMenus() - Method in class com.thecoderscorner.menu.domain.state.MenuTree

Returns all the submenus that are currently stored

getAlpha() - Method in class com.thecoderscorner.menu.domain.state.PortableColor

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.mgrclient.SocketServerConnection

getAtLeastBytes(ByteBuffer, int, StreamRemoteConnector.ReadMode) - Method in class com.thecoderscorner.menu.remote.SharedStreamConnection

Reads at least the number of bytes requested waiting if need be for more data.

getAtLeastBytes(ByteBuffer, int, StreamRemoteConnector.ReadMode) - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector

getAttributeOrDefault(Element, String, Object) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Gets the text of an attribute or a default value.

getAttrOrNull(Element, String) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Gets the text of attribute if it is available, or null

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.ConnectionHasFailedState

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

getAuthenticator() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

getBaseName() - Method in class com.thecoderscorner.menu.persist.SafeBundleLoader

getBlue() - Method in class com.thecoderscorner.menu.domain.state.PortableColor

getBootMsgForItem(MenuItem, SubMenuItem, MenuTree) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

Can be used during boot sequences to get a suitable boot item for a menu item

getBootType() - Method in class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand

getBuffer() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand

getBundleForLocale(Locale) - Method in class com.thecoderscorner.menu.persist.SafeBundleLoader

getButton1() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand

getButton2() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand

getButtonName() - Method in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

getButtonType(int) - Method in class com.thecoderscorner.menu.mgr.DialogManager

the button type for a given button number - 0 or 1

getChangeType() - Method in class com.thecoderscorner.menu.remote.commands.MenuChangeCommand

getChildElementsWithName(Element, String) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Find all child elements with a given name

getChoiceMode() - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

getClock() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext

getClock() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

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.MenuRgb32BootCommand

getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuRuntimeListBootCommand

getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuScrollChoiceBootCommand

getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuSubBootCommand

getCommandType() - Method in class com.thecoderscorner.menu.remote.commands.MenuTextBootCommand

getConnectionMode() - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

getConnectionMode() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

getConnectionName() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

getConnectionName() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector

Gets the name of this connector locally

getConnectionName() - Method in interface com.thecoderscorner.menu.remote.RemoteDevice

getConnectionName() - Method in class com.thecoderscorner.menu.remote.SharedStreamConnection

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

getCurrentLocale() - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

getCurrentLocale() - Method in class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

getCurrentLocale() - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

getCurrentLocale() - Method in class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

getCurrentStatus() - Method in class com.thecoderscorner.menu.mgr.MenuInMenu

Check the current status of the underlying connection

getCurrentValue() - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand

getDecimalPlaces() - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem

getDefaultFor(MenuItem) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

Gets the default item value for a menu item, such that the value could be used in call to set state.

getDefaultValue() - Method in class com.thecoderscorner.menu.persist.PersistedMenu

getDescription() - Method in enum class com.thecoderscorner.menu.remote.AuthStatus

getDescription() - Method in enum class com.thecoderscorner.menu.remote.commands.AckStatus

getDescription() - Method in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

getDialogManager() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

getDialogMode() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand

getDialogShowMode() - Method in class com.thecoderscorner.menu.mgr.DialogManager

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.

getEepromOffset() - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

getEnabledLocales() - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

getEnabledLocales() - Method in class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

getEnabledLocales() - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

getEnabledLocales() - Method in class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

getEnumEntries() - Method in class com.thecoderscorner.menu.domain.EnumMenuItem

getFromLocaleWithDefault(String, String) - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

getFunctionName() - Method in class com.thecoderscorner.menu.domain.MenuItem

Gets the function name for this item

getGreen() - Method in class com.thecoderscorner.menu.domain.state.PortableColor

getGson() - Method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

getHeader() - Method in class com.thecoderscorner.menu.remote.commands.MenuDialogCommand

getHearbeatInterval() - Method in class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand

getHeartbeatFrequency() - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

getHeartbeatFrequency() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

getHigh() - Method in class com.thecoderscorner.menu.remote.protocol.MessageField

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 interface com.thecoderscorner.menu.domain.state.AnyMenuState

getItem() - Method in class com.thecoderscorner.menu.domain.state.MenuState

Gets the menu item associated with this state.

getItem() - Method in class com.thecoderscorner.menu.persist.PersistedMenu

getItemName(MenuItem) - Method in class com.thecoderscorner.menu.domain.util.MenuItemFormatter

getItemType() - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItem

getItemWidth() - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

getJsonIntOrThrow(JsonObject, String) - Static method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

getJsonObjOrThrow(JsonObject, String) - Static method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

getJsonStrOrThrow(JsonObject, String) - Static method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

getKey() - Method in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

getLocalSpecificEntry(String) - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

getLocalSpecificEntry(String) - Method in class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

getLocalSpecificEntry(String) - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

getLocalSpecificEntry(String) - Method in class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

getLocation() - Method in class com.thecoderscorner.menu.persist.SafeBundleLoader

getLow() - Method in class com.thecoderscorner.menu.remote.protocol.MessageField

getMajorVersion() - Method in class com.thecoderscorner.menu.remote.RemoteInformation

the major version of the remote host

getManagedMenu() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

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) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

Gets the menu state that's associated with a given menu item.

getMenuType() - Method in class com.thecoderscorner.menu.domain.CustomBuilderMenuItem

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 class 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

getNumEntries() - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

getOffset() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem

The offset from 0 that is used when displaying the item, can be negative

getParentId() - Method in class com.thecoderscorner.menu.persist.PersistedMenu

getPathForLocale(Locale) - Method in class com.thecoderscorner.menu.persist.SafeBundleLoader

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

getPosition() - Method in class com.thecoderscorner.menu.domain.state.CurrentScrollPosition

getProtocolForCmd(MenuCommand) - Method in interface com.thecoderscorner.menu.remote.MenuCommandProtocol

Checks the message and sees which protocol it will be processed with.

getProtocolForCmd(MenuCommand) - Method in class com.thecoderscorner.menu.remote.protocol.ConfigurableProtocolConverter

getProtoNum() - Method in enum class com.thecoderscorner.menu.remote.protocol.CommandProtocol

getRed() - Method in class com.thecoderscorner.menu.domain.state.PortableColor

getRemoteParty() - Method in interface com.thecoderscorner.menu.remote.RemoteConnector

getRemoteParty() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

getResponseType() - Method in class com.thecoderscorner.menu.domain.state.ListResponse

getResult() - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor

Returns the result previously stored by set result.

getRow() - Method in class com.thecoderscorner.menu.domain.state.ListResponse

getSafeLoader() - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

getScheduledExecutor() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext

getScheduledExecutor() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

getServerConnections() - Method in interface com.thecoderscorner.menu.mgr.ServerConnectionManager

getServerConnections() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnectionManager

getServerName() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

getServerUuid() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

getStatusCode() - Method in enum class com.thecoderscorner.menu.remote.commands.AckStatus

getStep() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem

The step is the amount by which each increment should increase the value, it must be exactly divisible by the maximum value.

getStorageType() - Method in interface com.thecoderscorner.menu.domain.state.AnyMenuState

getStorageType() - Method in class com.thecoderscorner.menu.domain.state.MenuState

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

getSubMenuById(int) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

gets a submenu by its 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.CustomBuilderMenuItemBuilder

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

getType() - Method in class com.thecoderscorner.menu.persist.PersistedMenu

getTypeVal() - Method in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

getUnderlyingId() - Method in class com.thecoderscorner.menu.remote.protocol.CorrelationId

Gets the underlying ID.

getUnderlyingMap() - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

getUnderlyingMap() - Method in class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

getUnderlyingMap() - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

getUnderlyingMap() - Method in class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

getUnitName() - Method in class com.thecoderscorner.menu.domain.AnalogMenuItem

The unit name to appear directly after the value, for example a temperature item may be "oC" where as a volume control could be "dB"

getUserName() - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

get the username of this connection

getUserName() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

getUserName() - Method in interface com.thecoderscorner.menu.remote.RemoteDevice

getUserName() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

getUuid() - Method in class com.thecoderscorner.menu.remote.commands.MenuPairingCommand

getUuid() - Method in class com.thecoderscorner.menu.remote.LocalIdentifier

getUuid() - Method in class com.thecoderscorner.menu.remote.RemoteInformation

getValue() - Method in interface com.thecoderscorner.menu.domain.state.AnyMenuState

getValue() - Method in class com.thecoderscorner.menu.domain.state.CurrentScrollPosition

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.

getValueFor(MenuItem, MenuTree) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

This gets the value from the tree state, if it is not available calls getDefaultValue Same as getValueFor(item, tree, defVal) but this just calls getDefaultFor(..) to get the default.

getValueFor(MenuItem, MenuTree, T) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

Gets the value from the tree or the default provided

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.

getVariable() - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

getVariableName() - Method in class com.thecoderscorner.menu.domain.MenuItem

Gets the variable name that should be used during generation

getVersionFromProperties() - Static method in class com.thecoderscorner.menu.remote.protocol.ProtocolUtil

gets and caches the current version from the version properties file

getWithLocaleInitIfNeeded(String, String) - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

GREGORIAN_DATE - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents a gregorian date

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.CustomBuilderMenuItem

hashCode() - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem

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.Rgb32MenuItem

hashCode() - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItem

hashCode() - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

hashCode() - Method in class com.thecoderscorner.menu.domain.state.CurrentScrollPosition

hashCode() - Method in class com.thecoderscorner.menu.domain.state.MenuState

hashCode() - Method in class com.thecoderscorner.menu.domain.state.PortableColor

hashCode() - Method in class com.thecoderscorner.menu.domain.SubMenuItem

hashCode() - Method in class com.thecoderscorner.menu.persist.VersionInfo

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

hashCode() - Method in class com.thecoderscorner.menu.remote.protocol.MessageField

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 - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

HIDE - Enum constant in enum class com.thecoderscorner.menu.remote.commands.DialogMode

the dialog is to be hidden

hideDialog() - Method in class com.thecoderscorner.menu.mgr.DialogManager

Remove the dialog from display

I

id - Variable in class com.thecoderscorner.menu.domain.MenuItem

id() - Element in annotation interface com.thecoderscorner.menu.mgr.MenuCallback

id() - Element in annotation interface com.thecoderscorner.menu.mgr.ScrollChoiceValueRetriever

ID_NOT_FOUND - Enum constant in enum class com.thecoderscorner.menu.remote.commands.AckStatus

The requested ID was not found

initialiseStateForEachItem() - Method in class com.thecoderscorner.menu.domain.state.MenuTree

Initialise the state of each menu item to the default value, should be used during initialisation of a local menu application.

inputBuffer - Variable in class com.thecoderscorner.menu.remote.SharedStreamConnection

INTEGER - Enum constant in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

IntegerMenuState - Class in com.thecoderscorner.menu.domain.state

An implementation of menu state for integer values.

IntegerMenuState(MenuItem, boolean, boolean, Integer) - Constructor for class com.thecoderscorner.menu.domain.state.IntegerMenuState

integerOfElementByName(Element, String, int) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Gets the int value associated with the named child, or the default if it does not exist or can't be parsed.

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuActionBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuAnalogBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuBooleanBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuEnumBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuFloatBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuLargeNumBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuRgb32BootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuRuntimeListBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuScrollChoiceBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuSubBootCommand

internalNewMenuState(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.MenuTextBootCommand

INVALID - Enum constant in enum class com.thecoderscorner.menu.remote.protocol.CommandProtocol

INVALID_CREDENTIALS - Enum constant in enum class com.thecoderscorner.menu.remote.commands.AckStatus

The credentials provided were incorrect

INVOKE_ITEM - Enum constant in enum class com.thecoderscorner.menu.domain.state.ListResponse.ResponseType

IP_ADDRESS - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents an IP address

isActive() - Method in interface com.thecoderscorner.menu.domain.state.AnyMenuState

isActive() - Method in class com.thecoderscorner.menu.domain.state.MenuState

gets the active status

isAnyRemoteConnection() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Indicates if there is a remote connection on any of the server connection managers

isChanged() - Method in interface com.thecoderscorner.menu.domain.state.AnyMenuState

isChanged() - Method in class com.thecoderscorner.menu.domain.state.MenuState

gets the changed status

isDeviceConnected() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

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.SharedStreamConnection

isDeviceConnected() - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector

isDeviceConnected() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext

isDialogVisible() - Method in class com.thecoderscorner.menu.mgr.DialogManager

isError() - Method in enum class com.thecoderscorner.menu.remote.commands.AckStatus

isIncludeAlphaChannel() - Method in class com.thecoderscorner.menu.domain.Rgb32MenuItem

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

isLocalSupportEnabled() - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

isLocalSupportEnabled() - Method in class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

isLocalSupportEnabled() - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

isLocalSupportEnabled() - Method in class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

isNegativeAllowed() - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItem

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

isSameOrNewerThan(VersionInfo) - Method in class com.thecoderscorner.menu.persist.VersionInfo

isSecured() - Method in class com.thecoderscorner.menu.domain.SubMenuItem

isStaticDataInRAM() - Method in class com.thecoderscorner.menu.domain.MenuItem

Mainly used by the designer, this specifies if the info block for a menu item resides in RAM or FLASH

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

itemsToCopyText(MenuItem, MenuTree) - Method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

J

JAVA_API - Enum constant in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

JAVASCRIPT_CLIENT - Enum constant in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

JOIN - Static variable in interface 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

JsonMenuItemSerializer - Class in com.thecoderscorner.menu.persist

Creates a menu serializer instance that can convert menu structures to and from JSON format.

JsonMenuItemSerializer() - Constructor for class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

JsonMenuItemSerializer(Consumer<GsonBuilder>) - Constructor for class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

K

KEY_ACK_STATUS - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields

KEY_ALPHA_FIELD - 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_STEP_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_NEGATIVE_ALLOWED - 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

KEY_WIDTH_FIELD - Static variable in interface com.thecoderscorner.menu.remote.protocol.TagValMenuFields

L

LARGE_NUM_BOOT_ITEM - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

lastReceivedHeartbeat() - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

lastReceivedHeartbeat() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

lastReception - Variable in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState

lastTransmittedHeartbeat() - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

lastTransmittedHeartbeat() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

LIST_STATE_CHANGE - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType

ListResponse - Class in com.thecoderscorner.menu.domain.state

This represents an action that was performed on a list, and not really the state of the list.

ListResponse(int, ListResponse.ResponseType) - Constructor for class com.thecoderscorner.menu.domain.state.ListResponse

ListResponse.ResponseType - Enum Class in com.thecoderscorner.menu.domain.state

The types of response that are supported, current select - single click, invoke - double click.

listResult() - Element in annotation interface com.thecoderscorner.menu.mgr.MenuCallback

loadDocumentFromData(String) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Load an XML document from a string of data

loadDocumentFromPath(Path) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Load an XML document from a file system path

loadDocumentStream(InputStream) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Load an XML document from a stream

loadMenuStates() - Method in interface com.thecoderscorner.menu.persist.MenuStateSerialiser

load the menu states but do not apply them to the tree

loadMenuStates() - Method in class com.thecoderscorner.menu.persist.PropertiesMenuStateSerialiser

loadMenuStatesAndApply() - Method in interface com.thecoderscorner.menu.persist.MenuStateSerialiser

load back all states from the storage and apply them all to the tree, after this all items in the tree will contain the updated value.

loadMenuStatesAndApply() - Method in class com.thecoderscorner.menu.persist.PropertiesMenuStateSerialiser

loadResourceBundleAsMap(Locale) - Method in class com.thecoderscorner.menu.persist.SafeBundleLoader

LOCAL_DELEGATE_LOCKED - Enum constant in enum class com.thecoderscorner.menu.mgr.DialogShowMode

The dialog is both local to the delegate and locked so cannot be replaced with another

LOCAL_TO_DELEGATE - Enum constant in enum class com.thecoderscorner.menu.mgr.DialogShowMode

The dialog is local to the delegate function provided, no remote messages will send upon action

LocaleMappingHandler - Interface in com.thecoderscorner.menu.persist

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

lock - Variable in class com.thecoderscorner.menu.mgr.DialogManager

logByteBuffer(String, ByteBuffer) - Method in class com.thecoderscorner.menu.remote.SharedStreamConnection

Helper method that logs the entire message buffer when at debug logging level.

logger - Variable in class com.thecoderscorner.menu.remote.SharedStreamConnection

logger - Variable in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState

M

managementCapabilities() - Method in interface com.thecoderscorner.menu.auth.MenuAuthenticator

Indicates how this authenticator can be edited, some don't support any, some remove only.

managementCapabilities() - Method in class com.thecoderscorner.menu.auth.PreDefinedAuthenticator

managementCapabilities() - Method in class com.thecoderscorner.menu.auth.PropertiesAuthenticator

managerWillStart() - Method in interface com.thecoderscorner.menu.mgr.MenuManagerListener

Indicates that the manager (and therefore the application) is about to start.

managerWillStop() - Method in interface com.thecoderscorner.menu.mgr.MenuManagerListener

markDone() - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState

MAX_MSG_EXPECTED - Static variable in class com.thecoderscorner.menu.remote.SharedStreamConnection

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

MenuAuthenticator - Interface in com.thecoderscorner.menu.auth

The authenticator interface that supports the checking of name and UUID pairs.

MenuAuthenticator.ManagementCapabilities - Enum Class in com.thecoderscorner.menu.auth

Indicates the management operations that can be performed by a particular implementation of authenticator

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 Class in com.thecoderscorner.menu.remote.commands

MenuButtonType - Enum Class in com.thecoderscorner.menu.remote.commands

The button type for a dialog, dialogs generally have up to two buttons by default, each button can be one of the following types.

MenuCallback - Annotation Interface in com.thecoderscorner.menu.mgr

Marks a method as a menu callback, when a `MenuManagerListener` is added to a menu manager `MenuManagerServer` you can mark methods with this identifier if the method takes just two parameters, one for the ID and a boolean that indicates if the update is local or remote.

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 Class 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 - Interface in com.thecoderscorner.menu.remote.commands

Here all the inbuilt types of messages that can be sent to and from the server are listed out.

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 Class in com.thecoderscorner.menu.remote.commands

MenuInMenu - Class in com.thecoderscorner.menu.mgr

MenuInMenu embeds a menu within another menu by shifting the range of IDs within the remote items into another range.

MenuInMenu(RemoteConnector, MenuManagerServer, MenuItem, MenuInMenu.ReplicationMode, int, int) - Constructor for class com.thecoderscorner.menu.mgr.MenuInMenu

Creates a MenuInMenu instance that tracks changes in a remote menu and replicates it locally in real time.

MenuInMenu.ReplicationMode - Enum Class in com.thecoderscorner.menu.mgr

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.CustomBuilderMenuItemBuilder

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.MenuItemBuilder

menuItem() - Method in class com.thecoderscorner.menu.domain.Rgb32MenuItemBuilder

menuItem() - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder

menuItem() - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItemBuilder

menuItem() - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder

MenuItem - 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, String, int, int, String, boolean, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.MenuItem

MenuItemBuilder<T extends MenuItemBuilder,M extends MenuItem> - 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.

menuItemDidUpdate(Object, MenuItem) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Tell the manager that an update has already occurred, IE the menu tree state is already adjusted.

MenuItemFormatException - Exception Class in com.thecoderscorner.menu.domain.util

This exception indicates that a particular item could not be formatted

MenuItemFormatException(String) - Constructor for exception class com.thecoderscorner.menu.domain.util.MenuItemFormatException

MenuItemFormatException(String, Throwable) - Constructor for exception class com.thecoderscorner.menu.domain.util.MenuItemFormatException

MenuItemFormatter - Class in com.thecoderscorner.menu.domain.util

MenuItemFormatter(LocaleMappingHandler) - Constructor for class com.thecoderscorner.menu.domain.util.MenuItemFormatter

menuItemHasChanged(Object, MenuItem) - Method in interface com.thecoderscorner.menu.mgr.MenuManagerListener

Called whenever there is a change in any menu item, it will indicate if the change is local or remote.

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

MenuManagerListener - Interface in com.thecoderscorner.menu.mgr

MenuManager listeners get notification when any menu item has changed, this works by the `menuItemHasChanged` method being called for each change.

MenuManagerServer - Class in com.thecoderscorner.menu.mgr

The menu manager server component manages a menu tree locally, handling updates to both state and items, and also dealing with any remote connections.

MenuManagerServer(ScheduledExecutorService, MenuTree, String, UUID, MenuAuthenticator, Clock) - Constructor for class com.thecoderscorner.menu.mgr.MenuManagerServer

MenuPairingCommand - Class in com.thecoderscorner.menu.remote.commands

MenuPairingCommand(String, UUID) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuPairingCommand

MenuRgb32BootCommand - Class in com.thecoderscorner.menu.remote.commands

MenuRgb32BootCommand(int, Rgb32MenuItem, PortableColor) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuRgb32BootCommand

MenuRuntimeListBootCommand - Class in com.thecoderscorner.menu.remote.commands

MenuRuntimeListBootCommand(int, RuntimeListMenuItem, List<String>) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuRuntimeListBootCommand

MenuScrollChoiceBootCommand - Class in com.thecoderscorner.menu.remote.commands

MenuScrollChoiceBootCommand(int, ScrollChoiceMenuItem, CurrentScrollPosition) - Constructor for class com.thecoderscorner.menu.remote.commands.MenuScrollChoiceBootCommand

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(AnyMenuState.StateStorageType, MenuItem, boolean, boolean, T) - Constructor for class com.thecoderscorner.menu.domain.state.MenuState

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

MenuStateSerialiser - Interface in com.thecoderscorner.menu.persist

An instance of Menu State serializer is used between runs of a local java application to load and save the state of any menu item that has the EEPROM field set to anything other than -1.

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 local session.

MenuTree() - Constructor for class com.thecoderscorner.menu.domain.state.MenuTree

Create a basic tree that is initially empty

MenuTree.MoveType - Enum Class 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.

MenuTreeStructureChangeListener - Interface in com.thecoderscorner.menu.mgr

Indicates that there has been a structural change in the list, for example addition or removal of a menu item in the tree.

message - Variable in class com.thecoderscorner.menu.mgr.DialogManager

MessageField - Class in com.thecoderscorner.menu.remote.protocol

MessageField(char, char) - Constructor for class com.thecoderscorner.menu.remote.protocol.MessageField

mode - Variable in class com.thecoderscorner.menu.mgr.DialogManager

MOVE_DOWN - Enum constant in enum class com.thecoderscorner.menu.domain.state.MenuTree.MoveType

MOVE_UP - Enum constant in enum class com.thecoderscorner.menu.domain.state.MenuTree.MoveType

moveItem(MenuItem, MenuItem, boolean) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

Moves the item within the menu structure, the new location is either the submenu it should be moved to, or the item it should appear after.

MSGTYPES_CANNOT_OVERRIDE - Static variable in class com.thecoderscorner.menu.mgr.MenuManagerServer

N

name - Variable in class com.thecoderscorner.menu.domain.MenuItem

NamedDaemonThreadFactory - Class in com.thecoderscorner.menu.remote

this thread factory provides better naming for threads

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

newDocumentRoot(String) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Creates a new document that has a root element with the name given

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.

newListResponseChangeCommand(CorrelationId, int, ListResponse) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory

Creates a new change command that represents a list item either being selected or invoked

newListResponseChangeCommand(CorrelationId, MenuItem, ListResponse) - Static method in class com.thecoderscorner.menu.remote.commands.CommandFactory

Creates a new change command that represents a list item either being selected or invoked

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(AnyMenuState) - Method in class com.thecoderscorner.menu.remote.commands.BootItemMenuCommand

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.

newMenuTreeWithItems(String) - Method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

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

NewServerConnectionListener - Interface in com.thecoderscorner.menu.mgr

when you implement this interface and pass that instance to start on a ServerConnectionManager then you'll receive an event for each new connection created.

newThread(Runnable) - Method in class com.thecoderscorner.menu.remote.NamedDaemonThreadFactory

NoLocaleEnabledLocalHandler - Class in com.thecoderscorner.menu.persist

NoLocaleEnabledLocalHandler() - Constructor for class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

NONE - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

No button

NOOP_IMPLEMENTATION - Static variable in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

NoOperationInitialState - Class in com.thecoderscorner.menu.remote.states

NoOperationInitialState(RemoteConnectorContext) - Constructor for class com.thecoderscorner.menu.remote.states.NoOperationInitialState

NORMAL - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode

NOT_CONNECTED - Static variable in class com.thecoderscorner.menu.remote.RemoteInformation

NOT_EDITABLE - Enum constant in enum class com.thecoderscorner.menu.auth.MenuAuthenticator.ManagementCapabilities

No editing or management is possible

NOT_STARTED - Enum constant in enum class 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 - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

The OK button

ON_OFF - Enum constant in enum class 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 - Enum constant in enum class com.thecoderscorner.menu.remote.StreamRemoteConnector.ReadMode

P

PAIRING - Enum constant in enum class com.thecoderscorner.menu.mgr.ServerConnectionMode

A connection that can be used only for pairing and nothing else

PAIRING_CONNECTION - Enum constant in enum class com.thecoderscorner.menu.remote.ConnectMode

A connection that can only be used to pair with the device

PAIRING_REQUEST - Static variable in interface 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

This class provides a helper method to pair with a device.

PairingHelper(RemoteConnector, ScheduledExecutorService, Optional<Consumer<AuthStatus>>) - Constructor for class com.thecoderscorner.menu.remote.protocol.PairingHelper

PATCH - Enum constant in enum class com.thecoderscorner.menu.persist.ReleaseType

performConnection() - Method in class com.thecoderscorner.menu.remote.socket.SocketBasedConnector

performConnection() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext

PersistedMenu - Class in com.thecoderscorner.menu.persist

Represents a persisted menu item, it has additional information needed to reconstitute the item at the right point in the tree, namely the parentId, and also the type of menu item.

PersistedMenu() - Constructor for class com.thecoderscorner.menu.persist.PersistedMenu

PersistedMenu(MenuItem, MenuItem) - Constructor for class com.thecoderscorner.menu.persist.PersistedMenu

PLAIN_TEXT - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field has no validation, it is plain text

populateListInOrder(SubMenuItem, MenuTree, boolean) - Method in class com.thecoderscorner.menu.persist.JsonMenuItemSerializer

PORTABLE_COLOR - Enum constant in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

PortableColor - Class in com.thecoderscorner.menu.domain.state

A portable color that represents a color in the RGBA space with single byte values for each entry (between 0..255).

PortableColor(int, int, int) - Constructor for class com.thecoderscorner.menu.domain.state.PortableColor

Create a color from RGB with alpha set to full (255), each value from 0 to 255

PortableColor(int, int, int, int) - Constructor for class com.thecoderscorner.menu.domain.state.PortableColor

Create a color from RGBA using values from 0 to 255

PortableColor(String) - Constructor for class com.thecoderscorner.menu.domain.state.PortableColor

Create a color object from a web color code such as #FFFFFF

PortableColorMenuState - Class in com.thecoderscorner.menu.domain.state

An implementation of menu state for integer values.

PortableColorMenuState(MenuItem, boolean, boolean, PortableColor) - Constructor for class com.thecoderscorner.menu.domain.state.PortableColorMenuState

PreDefinedAuthenticator - Class in com.thecoderscorner.menu.auth

Implements the authentication interface using a pre-defined upfront set of name and UUID pairs that must be provided upfront.

PreDefinedAuthenticator(boolean) - Constructor for class com.thecoderscorner.menu.auth.PreDefinedAuthenticator

PreDefinedAuthenticator(String, List<PreDefinedAuthenticator.AuthenticationToken>) - Constructor for class com.thecoderscorner.menu.auth.PreDefinedAuthenticator

PreDefinedAuthenticator.AuthenticationToken - Class in com.thecoderscorner.menu.auth

PREVIOUS - Enum constant in enum class com.thecoderscorner.menu.persist.ReleaseType

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

PropertiesAuthenticator - Class in com.thecoderscorner.menu.auth

Stores authentication to a properties file and then validates against the stored values.

PropertiesAuthenticator(String) - Constructor for class com.thecoderscorner.menu.auth.PropertiesAuthenticator

PropertiesAuthenticator(String, DialogManager) - Constructor for class com.thecoderscorner.menu.auth.PropertiesAuthenticator

PropertiesLocaleEnabledHandler - Class in com.thecoderscorner.menu.persist

PropertiesLocaleEnabledHandler(SafeBundleLoader) - Constructor for class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

PropertiesMenuStateSerialiser - Class in com.thecoderscorner.menu.persist

An implementation of menu state serialization that stores data in a properties file at a given location.

PropertiesMenuStateSerialiser(MenuTree, Path) - Constructor for class com.thecoderscorner.menu.persist.PropertiesMenuStateSerialiser

PROTO_END_OF_MSG - Static variable in interface com.thecoderscorner.menu.remote.MenuCommandProtocol

PROTO_START_OF_MSG - Static variable in interface com.thecoderscorner.menu.remote.MenuCommandProtocol

protoBufferToText(MenuCommand) - Method in class com.thecoderscorner.menu.remote.protocol.ProtocolHelper

protocol - Variable in class com.thecoderscorner.menu.remote.SharedStreamConnection

ProtocolHelper - Class in com.thecoderscorner.menu.remote.protocol

ProtocolHelper(MenuCommandProtocol) - Constructor for class com.thecoderscorner.menu.remote.protocol.ProtocolHelper

ProtocolOutgoingMsgConverter<T extends MenuCommand,B> - Interface in com.thecoderscorner.menu.remote.protocol

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

putIntoDefaultIfNeeded(String, String) - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

R

RAW_BIN_PROTOCOL - Enum constant in enum class com.thecoderscorner.menu.remote.protocol.CommandProtocol

RawProtocolIncomingMsgConverter - Interface in com.thecoderscorner.menu.remote.protocol

READ_MORE - Enum constant in enum class com.thecoderscorner.menu.remote.StreamRemoteConnector.ReadMode

readCommandFromStream() - Method in class com.thecoderscorner.menu.remote.SharedStreamConnection

readCommandFromStream() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext

readCompleteMessage(ByteBuffer) - Method in class com.thecoderscorner.menu.remote.SharedStreamConnection

readOnly - Variable in class com.thecoderscorner.menu.domain.MenuItem

recurseTreeIteratingOnItems(SubMenuItem, BiConsumer<MenuItem, SubMenuItem>) - Method in class com.thecoderscorner.menu.domain.state.MenuTree

Recurse the whole menu tree calling the consumer for each item in turn.

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.

registerConnectionListener(BiConsumer<ServerConnection, Boolean>) - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

Register the connection listener to this connection that will receive udpates on connection changes.

registerConnectionListener(BiConsumer<ServerConnection, Boolean>) - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

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.

registerMessageHandler(BiConsumer<ServerConnection, MenuCommand>) - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

Register the message handler that will receive all messages from the connection

registerMessageHandler(BiConsumer<ServerConnection, MenuCommand>) - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

REGULAR - Enum constant in enum class com.thecoderscorner.menu.mgr.DialogShowMode

Show the dialog in a regular way

ReleaseType - Enum Class in com.thecoderscorner.menu.persist

Describes the quality of a release, such as Stable, Beta or an old build.

REMOTE_BOOT_ITEM - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

REMOTE_IOT_MONITOR - Enum constant in enum class com.thecoderscorner.menu.domain.CustomBuilderMenuItem.CustomMenuType

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.

RemoteDevice - Interface in com.thecoderscorner.menu.remote

This describes a remote connection at its most basic level, just the user that is connected and the name of the connection, no other operations are supported at this level, but it provides a means of dealing with any type of remote connection, be it acting as a server or acting as a client.

RemoteInformation - Class in com.thecoderscorner.menu.remote

Represents the remote connection details, such as name and version.

RemoteInformation(String, UUID, 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

removeAuthentication(String) - Method in interface com.thecoderscorner.menu.auth.MenuAuthenticator

Remove the authentication for the given user

removeAuthentication(String) - Method in class com.thecoderscorner.menu.auth.PreDefinedAuthenticator

removeAuthentication(String) - Method in class com.thecoderscorner.menu.auth.PropertiesAuthenticator

removeListener(RemoteControllerListener) - Method in 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.

REPLICATE_ADD_STATUS_ITEM - Enum constant in enum class com.thecoderscorner.menu.mgr.MenuInMenu.ReplicationMode

REPLICATE_NOTIFY - Enum constant in enum class com.thecoderscorner.menu.mgr.MenuInMenu.ReplicationMode

REPLICATE_SILENTLY - Enum constant in enum class com.thecoderscorner.menu.mgr.MenuInMenu.ReplicationMode

ResourceBundleMappingHandler - Class in com.thecoderscorner.menu.persist

ResourceBundleMappingHandler(ResourceBundle) - Constructor for class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

RGB32_COLOR_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

Rgb32MenuItem - Class in com.thecoderscorner.menu.domain

A menu item that represents a colour in the RGB domain with optional Alpha channel.

Rgb32MenuItem() - Constructor for class com.thecoderscorner.menu.domain.Rgb32MenuItem

Rgb32MenuItem(String, String, int, int, String, boolean, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.Rgb32MenuItem

Rgb32MenuItemBuilder - Class in com.thecoderscorner.menu.domain

Constructs an Rgb32MenuItem using the builder pattern, it is a menu item that represents a PortableColor object.

Rgb32MenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.Rgb32MenuItemBuilder

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

runLoop() - Method in class com.thecoderscorner.menu.remote.states.BaseMessageProcessingState

runLoop() - Method in class com.thecoderscorner.menu.remote.states.ConnectionHasFailedState

runLoop() - Method in class com.thecoderscorner.menu.remote.states.NoOperationInitialState

runLoop() - Method in class com.thecoderscorner.menu.remote.states.PairingAuthFailedState

runLoop() - Method in class com.thecoderscorner.menu.remote.states.PairingAuthSuccessState

runLoop() - Method in interface com.thecoderscorner.menu.remote.states.RemoteConnectorState

called when a state is the current state, the state can read messages and attempt connections in this loop.

runLoop() - Method in class com.thecoderscorner.menu.remote.states.StreamNotConnectedState

RUNTIME_LARGE_NUM_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

RUNTIME_LIST_BOOT - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

RUNTIME_LIST_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

RuntimeListMenuItem - Class in com.thecoderscorner.menu.domain

RuntimeListMenuItem() - Constructor for class com.thecoderscorner.menu.domain.RuntimeListMenuItem

RuntimeListMenuItem(String, 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 RuntimeListMenuItem using the standard builder pattern.

RuntimeListMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder

S

SafeBundleLoader - Class in com.thecoderscorner.menu.persist

SafeBundleLoader(Path, String) - Constructor for class com.thecoderscorner.menu.persist.SafeBundleLoader

saveChanges() - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

saveChanges() - Method in class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

saveChanges() - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

saveChanges() - Method in class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

saveChangesKeepingFormatting(Locale, Map<String, String>) - Method in class com.thecoderscorner.menu.persist.SafeBundleLoader

saveMenuStates() - Method in interface com.thecoderscorner.menu.persist.MenuStateSerialiser

Save the latest state of the tree into storage.

saveMenuStates() - Method in class com.thecoderscorner.menu.persist.PropertiesMenuStateSerialiser

SCROLL_CHOICE_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

SCROLL_POSITION - Enum constant in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

ScrollChoiceMenuItem - Class in com.thecoderscorner.menu.domain

Represents a more configurable and more extensible version of enum that should be used when the number of choices is larger, the choices are in eeprom, or you need more control at runtime of the choices.

ScrollChoiceMenuItem() - Constructor for class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

ScrollChoiceMenuItem(String, String, int, int, String, int, int, int, ScrollChoiceMenuItem.ScrollChoiceMode, String, boolean, boolean, boolean) - Constructor for class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem

ScrollChoiceMenuItem.ScrollChoiceMode - Enum Class in com.thecoderscorner.menu.domain

ScrollChoiceMenuItemBuilder - Class in com.thecoderscorner.menu.domain

Builds an extensible version of enum that should be used when the number of choices is larger, the choices are in eeprom, or you need more control at runtime of the choices using the builder pattern.

ScrollChoiceMenuItemBuilder() - Constructor for class com.thecoderscorner.menu.domain.ScrollChoiceMenuItemBuilder

ScrollChoiceValueRetriever - Annotation Interface in com.thecoderscorner.menu.mgr

Marks a method as being responsible for providing the value of a particular value in a scroll choice.

SELECT_ITEM - Enum constant in enum class com.thecoderscorner.menu.domain.state.ListResponse.ResponseType

SEND_AUTH - Enum constant in enum class 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.mgr.MenuManagerServer

Send a command to all remotes that are connected.

sendCommand(MenuCommand) - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

Send a command to the remote

sendCommand(MenuCommand) - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

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.mgrclient.SocketServerConnection

sendInternal(ByteBuffer) - Method in class com.thecoderscorner.menu.remote.SharedStreamConnection

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.SharedStreamConnection

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

ServerConnection - Interface in com.thecoderscorner.menu.mgr

Each connection from a remote is represented by a class implementing this interface.

ServerConnectionManager - Interface in com.thecoderscorner.menu.mgr

A server connection manager is responsible for connections to the menu manager, it will completely manage all the connections, creating new ones as they come in, and removing old ones as they are closed out.

ServerConnectionMode - Enum Class in com.thecoderscorner.menu.mgr

setConnectionMode(ServerConnectionMode) - Method in interface com.thecoderscorner.menu.mgr.ServerConnection

Set the connection mode for this connection, usually called by the menu manager to indicate state

setConnectionMode(ServerConnectionMode) - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

setDefaultLocalHandler(LocaleMappingHandler) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemFormatter

setDefaultValue(String) - Method in class com.thecoderscorner.menu.persist.PersistedMenu

setDialogManager(DialogManager) - Method in class com.thecoderscorner.menu.auth.PropertiesAuthenticator

setDialogManager(DialogManager) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

replace the dialog manager with another implementation.

setItem(MenuItem) - Method in class com.thecoderscorner.menu.persist.PersistedMenu

setLocalSpecificEntry(String, String) - Method in interface com.thecoderscorner.menu.persist.LocaleMappingHandler

setLocalSpecificEntry(String, String) - Method in class com.thecoderscorner.menu.persist.NoLocaleEnabledLocalHandler

setLocalSpecificEntry(String, String) - Method in class com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler

setLocalSpecificEntry(String, String) - Method in class com.thecoderscorner.menu.persist.ResourceBundleMappingHandler

setMenuState(MenuItem, Object, MenuTree) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

Set the state in the tree for an item with a new value, setting it changed if it genuinely has.

setMessageHandler(BiConsumer<ServerConnection, MenuCommand>) - Method in class com.thecoderscorner.menu.remote.protocol.ProtocolHelper

setParentId(int) - Method in class com.thecoderscorner.menu.persist.PersistedMenu

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

setTextValue(Object) - Method in class com.thecoderscorner.menu.domain.state.CurrentScrollPosition

Allows the value to be changed just after creation, this is for local UIs where the setting happens just after creation of the state.

setType(String) - Method in class com.thecoderscorner.menu.persist.PersistedMenu

SharedStreamConnection - Class in com.thecoderscorner.menu.remote

SharedStreamConnection(MenuCommandProtocol) - Constructor for class com.thecoderscorner.menu.remote.SharedStreamConnection

SHOW - Enum constant in enum class com.thecoderscorner.menu.remote.commands.DialogMode

the dialog is to be shown

showDialogWithButtons(MenuButtonType, MenuButtonType) - Method in class com.thecoderscorner.menu.mgr.DialogManager

Actually shows the dialog with the buttons provided

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

SocketServerConnection - Class in com.thecoderscorner.menu.remote.mgrclient

SocketServerConnection(Socket, MenuCommandProtocol, Clock) - Constructor for class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

SocketServerConnectionManager - Class in com.thecoderscorner.menu.remote.mgrclient

SocketServerConnectionManager(MenuCommandProtocol, ScheduledExecutorService, int, Clock) - Constructor for class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnectionManager

STABLE - Enum constant in enum class com.thecoderscorner.menu.persist.ReleaseType

start() - Method in class com.thecoderscorner.menu.mgr.MenuInMenu

Starts the remote and registers listeners

start() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Start the manager and all associated server connection managers

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.socket.SocketBasedConnector

start(NewServerConnectionListener) - Method in interface com.thecoderscorner.menu.mgr.ServerConnectionManager

Start the manager up so it starts to accept connections, the listener will be called for each new connection.

start(NewServerConnectionListener) - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnectionManager

START - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType

START - Enum constant in enum class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode

startThreadProc() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

stateForMenuItem(MenuItem, Object, boolean, boolean) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

Create a menu state for a given item with a value update.

stateForMenuItem(AnyMenuState, MenuItem, Object) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

Get a new state object based on an existing state with a new value keeping all exising other values

stateForMenuItem(AnyMenuState, MenuItem, Object, boolean) - Static method in class com.thecoderscorner.menu.domain.util.MenuItemHelper

Get the state for an existing state with a new value, changing the changed state

stateMachineMappings - Variable in class com.thecoderscorner.menu.remote.StreamRemoteConnector

staticDataInRAM - Variable in class com.thecoderscorner.menu.domain.MenuItem

stop() - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Stop the manager all associated resources

stop() - Method in interface com.thecoderscorner.menu.mgr.ServerConnectionManager

Stop the manager

stop() - Method in class com.thecoderscorner.menu.remote.mgrclient.SocketServerConnectionManager

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.socket.SocketBasedConnector

stopThreadProc() - Method in class com.thecoderscorner.menu.remote.StreamRemoteConnector

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 Class in com.thecoderscorner.menu.remote

STRING - Enum constant in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

STRING_LIST - Enum constant in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

StringListMenuState - Class in com.thecoderscorner.menu.domain.state

An implementation of menu state for lists of string.

StringListMenuState(MenuItem, boolean, boolean, String...) - Constructor for class com.thecoderscorner.menu.domain.state.StringListMenuState

StringListMenuState(MenuItem, 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, boolean, boolean, String) - Constructor for class com.thecoderscorner.menu.domain.state.StringMenuState

SUB_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

SUBMENU_BOOT_ITEM - Static variable in interface 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, String, int, int, boolean, 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 - Enum constant in enum class com.thecoderscorner.menu.remote.commands.AckStatus

The operation was successful

T

TAG_VAL_PROTOCOL - Enum constant in enum class com.thecoderscorner.menu.remote.protocol.CommandProtocol

TagValMenuCommandProcessors - Class in com.thecoderscorner.menu.remote.protocol

A series of protocol handlers for most of the common tag value messages.

TagValMenuCommandProcessors() - Constructor for class com.thecoderscorner.menu.remote.protocol.TagValMenuCommandProcessors

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.

TagValProtocolIncomingMsgConverter - Interface in com.thecoderscorner.menu.remote.protocol

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.

TCMENU_COPY_PREFIX - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

TcProtocolException - Exception Class in com.thecoderscorner.menu.remote.protocol

An exception that indicates a problem during protocol conversion

TcProtocolException(String) - Constructor for exception class com.thecoderscorner.menu.remote.protocol.TcProtocolException

TcProtocolException(String, Throwable) - Constructor for exception class com.thecoderscorner.menu.remote.protocol.TcProtocolException

TEXT_BOOT_ITEM - Static variable in interface com.thecoderscorner.menu.remote.commands.MenuCommandType

TEXT_PERSIST_TYPE - Static variable in class com.thecoderscorner.menu.persist.PersistedMenu

textOfElementByName(Element, String) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Get the text of an element with the name child.

TIME_12H - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents a time in 12H format with seconds

TIME_12H_HHMM - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents a 12H time in minutes

TIME_24_HUNDREDS - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents a time in 24H format down to hundreds of a second

TIME_24H - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents a time in 24H format with seconds

TIME_24H_HHMM - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents a 24H time in minutes

TIME_DURATION_HUNDREDS - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents a time duration in hundreds

TIME_DURATION_SECONDS - Enum constant in enum class com.thecoderscorner.menu.domain.EditItemType

This field represents a time duration in seconds

title - Variable in class com.thecoderscorner.menu.mgr.DialogManager

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.ConfigurableProtocolConverter

toId() - Method in class com.thecoderscorner.menu.remote.protocol.MessageField

toPrintableText(MenuButtonType) - Method in class com.thecoderscorner.menu.mgr.DialogManager

toString() - Method in class com.thecoderscorner.menu.domain.MenuItem

toString() - Method in class com.thecoderscorner.menu.domain.state.CurrentScrollPosition

toString() - Method in class com.thecoderscorner.menu.domain.state.ListResponse

toString() - Method in class com.thecoderscorner.menu.domain.state.PortableColor

toString() - Method in class com.thecoderscorner.menu.persist.VersionInfo

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.mgrclient.SocketServerConnection

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.MessageField

toString() - Method in class com.thecoderscorner.menu.remote.protocol.TagValTextParser

toString() - Method in class com.thecoderscorner.menu.remote.RemoteInformation

transformElements(Element, String, String, Function<Element, T>) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Transforms all elements that match `childName` under either `root` if eleName is null, or under root/eleName if eleName is provided.

transformElements(Element, String, Function<Element, T>) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Transforms all elements that match `childName` under `root`, there is another overload that provides indirection.

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.

treeStructurallyChanged(MenuItem) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Tell the manager that the tree has structurally changed and that any interested parties need notification.

treeStructureChanged(MenuItem) - Method in interface com.thecoderscorner.menu.mgr.MenuTreeStructureChangeListener

The tree has structurally changed.

TRUE_FALSE - Enum constant in enum class com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming

U

UNAUTHENTICATED - Enum constant in enum class com.thecoderscorner.menu.mgr.ServerConnectionMode

A connection that is not yet authenticated

UNKNOWN_ERROR - Enum constant in enum class com.thecoderscorner.menu.remote.commands.AckStatus

There was an error that is not categorised.

updateMenuItem(Object, MenuItem, Object) - Method in class com.thecoderscorner.menu.mgr.MenuManagerServer

Update the value for the given menu item.

updateStateFromCommand(MenuCommand) - Method in class com.thecoderscorner.menu.mgr.DialogManager

Update the dialog from an incoming remote command, checking first if the command is a dialog event, and then updating all the fields and calling dialogDidChange.

V

VALUE_RANGE_WARNING - Enum constant in enum class com.thecoderscorner.menu.remote.commands.AckStatus

This is a warning that the value was out of range

valueOf(String) - Static method in enum class com.thecoderscorner.menu.auth.MenuAuthenticator.ManagementCapabilities

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.domain.CustomBuilderMenuItem.CustomMenuType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.domain.EditItemType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem.ScrollChoiceMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.domain.state.ListResponse.ResponseType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.domain.state.MenuTree.MoveType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.mgr.DialogShowMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.mgr.MenuInMenu.ReplicationMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.mgr.ServerConnectionMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.persist.ReleaseType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.AuthStatus

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.commands.AckStatus

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.commands.DialogMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.ConnectMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.protocol.CommandProtocol

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.thecoderscorner.menu.remote.StreamRemoteConnector.ReadMode

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.thecoderscorner.menu.auth.MenuAuthenticator.ManagementCapabilities

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.domain.BooleanMenuItem.BooleanNaming

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.domain.CustomBuilderMenuItem.CustomMenuType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.domain.EditItemType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.domain.ScrollChoiceMenuItem.ScrollChoiceMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.domain.state.AnyMenuState.StateStorageType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.domain.state.ListResponse.ResponseType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.domain.state.MenuTree.MoveType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.mgr.DialogShowMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.mgr.MenuInMenu.ReplicationMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.mgr.ServerConnectionMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.persist.ReleaseType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.AuthStatus

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.commands.AckStatus

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.commands.DialogMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.commands.MenuBootstrapCommand.BootType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.commands.MenuButtonType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.commands.MenuChangeCommand.ChangeType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.commands.MenuHeartbeatCommand.HeartbeatMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.ConnectMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.protocol.ApiPlatform

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.protocol.CommandProtocol

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.thecoderscorner.menu.remote.StreamRemoteConnector.ReadMode

Returns an array containing the constants of this enum class, in the order they are declared.

variableName - Variable in class com.thecoderscorner.menu.domain.MenuItem

VersionInfo - Class in com.thecoderscorner.menu.persist

This class represents a version number in standard form, such as 1.2.3, it can parse from text and determine which is the newer of two versions.

VersionInfo(String) - Constructor for class com.thecoderscorner.menu.persist.VersionInfo

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(CustomBuilderMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor

visit(CustomBuilderMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor

This will be called during visit for a custom menu 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(Rgb32MenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor

visit(Rgb32MenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor

This will be called during visit for RGB items

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(ScrollChoiceMenuItem) - Method in class com.thecoderscorner.menu.domain.util.AbstractMenuItemVisitor

visit(ScrollChoiceMenuItem) - Method in interface com.thecoderscorner.menu.domain.util.MenuItemVisitor

This will be called during visit for scroll choice items

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.

withAlpha(boolean) - Method in class com.thecoderscorner.menu.domain.Rgb32MenuItemBuilder

withChoiceMode(ScrollChoiceMenuItem.ScrollChoiceMode) - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItemBuilder

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

withDelegate(DialogShowMode, Function<MenuButtonType, Boolean>) - Method in class com.thecoderscorner.menu.mgr.DialogManager

Using builder syntax you can show dialog using the with commands this sets the delegate and mode

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

withEepromOffset(int) - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItemBuilder

withEnumList(List<String>) - Method in class com.thecoderscorner.menu.domain.EnumMenuItemBuilder

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(CustomBuilderMenuItem) - Method in class com.thecoderscorner.menu.domain.CustomBuilderMenuItemBuilder

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(Rgb32MenuItem) - Method in class com.thecoderscorner.menu.domain.Rgb32MenuItemBuilder

withExisting(RuntimeListMenuItem) - Method in class com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder

withExisting(ScrollChoiceMenuItem) - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItemBuilder

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

withItemWidth(int) - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItemBuilder

withLength(int) - Method in class com.thecoderscorner.menu.domain.EditableTextMenuItemBuilder

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.socket.SocketControllerBuilder

Mandatory, the menuTree instance to store the menu items retrieved from the remote side.

withMenuType(CustomBuilderMenuItem.CustomMenuType) - Method in class com.thecoderscorner.menu.domain.CustomBuilderMenuItemBuilder

withMessage(String, boolean) - Method in class com.thecoderscorner.menu.mgr.DialogManager

Using builder syntax you can show dialog using the with commands this sets the message

withName(String) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder

withNaming(BooleanMenuItem.BooleanNaming) - Method in class com.thecoderscorner.menu.domain.BooleanMenuItemBuilder

withNegativeAllowed(boolean) - Method in class com.thecoderscorner.menu.domain.EditableLargeNumberMenuItemBuilder

withNumEntries(int) - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItemBuilder

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.socket.SocketControllerBuilder

Optional, defaults to the standard protocol.

withReadOnly(boolean) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder

withSecured(boolean) - Method in class com.thecoderscorner.menu.domain.SubMenuItemBuilder

withStaticDataInRAM(boolean) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder

withStep(int) - Method in class com.thecoderscorner.menu.domain.AnalogMenuItemBuilder

withTitle(String, boolean) - Method in class com.thecoderscorner.menu.mgr.DialogManager

Using builder syntax you can show dialog using the with commands, this sets the title

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.socket.SocketControllerBuilder

Mandatory, Set the UUID of this instance of the client

withVariable(String) - Method in class com.thecoderscorner.menu.domain.ScrollChoiceMenuItemBuilder

withVariableName(String) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder

withVisible(boolean) - Method in class com.thecoderscorner.menu.domain.MenuItemBuilder

writeXml(Document, OutputStream) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Writes an XML document without reformatting it, this is good if you are working with a DOM that was previously loaded from a stream, where it may be already formatted.

writeXml(Document, OutputStream, boolean) - Static method in class com.thecoderscorner.menu.persist.XMLDOMHelper

Writes an XML document to a stream

X

XMLDOMHelper - Class in com.thecoderscorner.menu.persist

A series of static helper method that make dealing with XML easier, this is because many areas of tcMenu deal with XML documents, and these functions are generally useful.

XMLDOMHelper() - Constructor for class com.thecoderscorner.menu.persist.XMLDOMHelper

Y

YES_NO - Enum constant in enum class 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 X Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form