Package org.a11y.brlapi
Class Client
- java.lang.Object
-
- org.a11y.brlapi.Component
-
- org.a11y.brlapi.ProgramComponent
-
- org.a11y.brlapi.Program
-
- org.a11y.brlapi.Client
-
- All Implemented Interfaces:
java.lang.Runnable
- Direct Known Subclasses:
ApiErrorClient,BoundCommandsClient,ComputerBrailleClient,DriverKeysClient,EchoClient,GetDriverClient,GetModelClient,GetSizeClient,ListParametersClient,PauseClient,SetParameterClient
public abstract class Client extends Program
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static interfaceClient.ClientTaskprotected static interfaceClient.RawModeTaskprotected static interfaceClient.TtyModeTask-
Nested classes/interfaces inherited from class org.a11y.brlapi.Program
Program.Option
-
-
Field Summary
-
Fields inherited from class org.a11y.brlapi.Program
USAGE_OPTIONAL_BEGIN, USAGE_OPTIONAL_END, USAGE_REPEATING_INDICATOR
-
Fields inherited from class org.a11y.brlapi.ProgramComponent
EXIT_CODE_EXTERNAL, EXIT_CODE_INTERNAL, EXIT_CODE_SEMANTIC, EXIT_CODE_SUCCESS, EXIT_CODE_SYNTAX
-
Fields inherited from class org.a11y.brlapi.Component
BYTE_MASK, UNICODE_BRAILLE_ROW
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedClient(java.lang.String... arguments)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected voidextendUsageSummary(java.lang.StringBuilder usage)protected ParametergetParameter(Connection connection, java.lang.String name)booleanpause(Connection connection, int milliseconds)protected ClientrawMode(Connection connection, java.lang.String driver, Client.RawModeTask task)protected ClientrawMode(Connection connection, Client.RawModeTask task)protected abstract voidrunClient(Connection connection)protected voidrunProgram()ClientsetAuthenticationScheme(java.lang.String scheme)ClientsetServerHost(java.lang.String host)protected ClientttyMode(Connection connection, boolean keys, Client.TtyModeTask task, int... path)protected ClientttyMode(Connection connection, java.lang.String driver, Client.TtyModeTask task, int... path)-
Methods inherited from class org.a11y.brlapi.Program
addOption, addOptionalParameters, addRepeatingParameter, addRequiredParameters, getName, getUsageSummary, isClient, onProgramException, processParameters, run, writeProgramMessage
-
Methods inherited from class org.a11y.brlapi.ProgramComponent
getProgramName, isClient, isClient
-
Methods inherited from class org.a11y.brlapi.Component
printf, toOperandName, toUnicodeBraille, toUnicodeBraille
-
-
-
-
Method Detail
-
runClient
protected abstract void runClient(Connection connection) throws ProgramException
- Throws:
ProgramException
-
setServerHost
public final Client setServerHost(java.lang.String host) throws SyntaxException
- Throws:
SyntaxException
-
setAuthenticationScheme
public final Client setAuthenticationScheme(java.lang.String scheme) throws SyntaxException
- Throws:
SyntaxException
-
extendUsageSummary
protected void extendUsageSummary(java.lang.StringBuilder usage)
- Overrides:
extendUsageSummaryin classProgram
-
pause
public final boolean pause(Connection connection, int milliseconds)
-
runProgram
protected final void runProgram() throws ProgramException- Specified by:
runProgramin classProgram- Throws:
ProgramException
-
getParameter
protected final Parameter getParameter(Connection connection, java.lang.String name) throws SemanticException
- Throws:
SemanticException
-
ttyMode
protected final Client ttyMode(Connection connection, java.lang.String driver, Client.TtyModeTask task, int... path) throws ProgramException
- Throws:
ProgramException
-
ttyMode
protected final Client ttyMode(Connection connection, boolean keys, Client.TtyModeTask task, int... path) throws ProgramException
- Throws:
ProgramException
-
rawMode
protected final Client rawMode(Connection connection, java.lang.String driver, Client.RawModeTask task) throws ProgramException
- Throws:
ProgramException
-
rawMode
protected final Client rawMode(Connection connection, Client.RawModeTask task) throws ProgramException
- Throws:
ProgramException
-
-