public abstract class SwitchPressCommand extends AsciiSelfResponderCommandBase implements ICommandParameters
LibraryCommandId
Constructor and Description |
---|
SwitchPressCommand(java.lang.String commandName) |
Modifier and Type | Method and Description |
---|---|
protected void |
buildCommandLine(java.lang.StringBuilder line)
Builds the command line to send to the reader to execute the command
|
int |
getDuration() |
TriState |
getReadParameters()
Gets or sets a value indicating whether the command should include a list of supported parameters and their current values
|
TriState |
getResetParameters()
Gets or sets a value indicating whether the command should reset all its parameters to default values
|
TriState |
getTakeNoAction()
Gets or sets a value indicating whether the command primary action should not be performed
(e.g.
|
boolean |
implementsReadParameters()
Gets a value indicating whether the implementing command uses the ReadParameters property
|
boolean |
implementsResetParameters()
Gets a value indicating whether the implementing command uses the ResetParameters property
|
boolean |
implementsTakeNoAction()
Gets a value indicating whether the implementing command uses the TakeNoAction property
|
protected boolean |
responseDidReceiveParameter(java.lang.String parameter)
This method is called for each parameter in the parameters (PR:) list.
|
void |
setDuration(int duration) |
void |
setReadParameters(TriState value) |
void |
setResetParameters(TriState value) |
void |
setTakeNoAction(TriState value) |
getMaxSynchronousWaitTime, getSynchronousCommandResponder, setMaxSynchronousWaitTime, setSynchronousCommandResponder
captureNonLibraryResponses, processReceivedLine, setCaptureNonLibraryResponses
clearLastResponse, getCommandLine, getCommandName, getResponseLifecycleDelegate, getResponseStarted, isResponseFinished, parseParameters, processReceivedLine, responseDidFinish, responseDidStart, setCommandName, setResponseLifecycleDelegate, setResponseStarted, splitParameters
appendToMessages, appendToParameters, appendToResponse, getErrorCode, getMessages, getParameters, getResponse, isSuccessful, setErrorCode, setIsSuccessful, setResponse
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCommandLine, getCommandName
public final boolean implementsReadParameters()
implementsReadParameters
in interface ICommandParameters
public final boolean implementsResetParameters()
implementsResetParameters
in interface ICommandParameters
public final boolean implementsTakeNoAction()
implementsTakeNoAction
in interface ICommandParameters
public final TriState getReadParameters()
ICommandParameters
getReadParameters
in interface ICommandParameters
public final void setReadParameters(TriState value)
setReadParameters
in interface ICommandParameters
public final TriState getResetParameters()
ICommandParameters
getResetParameters
in interface ICommandParameters
public final void setResetParameters(TriState value)
setResetParameters
in interface ICommandParameters
public final TriState getTakeNoAction()
ICommandParameters
getTakeNoAction
in interface ICommandParameters
public final void setTakeNoAction(TriState value)
setTakeNoAction
in interface ICommandParameters
public final int getDuration()
public final void setDuration(int duration)
protected void buildCommandLine(java.lang.StringBuilder line)
buildCommandLine
in class AsciiSelfResponderCommandBase
line
- The command line to append to
When overriding this method call the base class to construct the command line as known to the base class and
then append the additional parameters to the end of the lineprotected boolean responseDidReceiveParameter(java.lang.String parameter)
responseDidReceiveParameter
in class AsciiCommandResponderBase
parameter
- A single parameter extracted from the PR: response, excluding the '-' and trimmed of leading and trailing whitespace