Package org.a11y.brlapi
Class Program
java.lang.Object
org.a11y.brlapi.Component
org.a11y.brlapi.ProgramComponent
org.a11y.brlapi.Program
- All Implemented Interfaces:
Runnable
- Direct Known Subclasses:
ApiToolCommand
,Client
,VersionProgram
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionprotected final void
addOption
(String name, Program.Option.Handler handler, String... operands) protected final void
addOptionalParameters
(String... parameters) protected final void
addRepeatingParameter
(String parameter) protected final void
addRequiredParameters
(String... parameters) protected void
extendUsageSummary
(StringBuilder usage) final String
final String
final boolean
isClient()
protected void
onProgramException
(ProgramException exception) protected void
processParameters
(String[] parameters) final void
run()
protected abstract void
final Program
setProgramName
(String name) protected final void
writeProgramMessage
(String format, Object... arguments) Methods inherited from class org.a11y.brlapi.ProgramComponent
isClient, isClient
Methods inherited from class org.a11y.brlapi.Component
getObjectName, getObjectName, printf, toOperandName, toUnicodeBraille, toUnicodeBraille
-
Field Details
-
USAGE_OPTIONAL_BEGIN
public static final char USAGE_OPTIONAL_BEGIN- See Also:
-
USAGE_OPTIONAL_END
public static final char USAGE_OPTIONAL_END- See Also:
-
USAGE_REPEATING_INDICATOR
- See Also:
-
-
Constructor Details
-
Program
-
-
Method Details
-
runProgram
- Throws:
ProgramException
-
isClient
public final boolean isClient() -
getProgramName
-
setProgramName
-
writeProgramMessage
-
addOption
-
addRequiredParameters
-
addOptionalParameters
-
addRepeatingParameter
-
getPurpose
-
extendUsageSummary
-
getUsageSummary
-
processParameters
- Throws:
SyntaxException
-
onProgramException
-
run
public final void run()
-