org.a11y.brlapi

Class Program

java.lang.Object

org.a11y.brlapi.Component

org.a11y.brlapi.ProgramComponent

org.a11y.brlapi.Program

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

ApiToolCommand, Client, VersionProgram

public abstract class Program
extends ProgramComponent
implements java.lang.Runnable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Program.Option

Field Summary

Fields

Modifier and Type	Field and Description
static char	USAGE_OPTIONAL_BEGIN
static char	USAGE_OPTIONAL_END
static java.lang.String	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 and Description
protected	Program(java.lang.String... arguments)

Method Summary

Modifier and Type	Method and Description
protected void	addOption(java.lang.String name, Program.Option.Handler handler, java.lang.String... operands)
protected void	addOptionalParameters(java.lang.String... parameters)
protected void	addRepeatingParameter(java.lang.String parameter)
protected void	addRequiredParameters(java.lang.String... parameters)
protected void	extendUsageSummary(java.lang.StringBuilder usage)
java.lang.String	getProgramName()
java.lang.String	getPurpose()
java.lang.String	getUsageSummary()
boolean	isClient()
protected void	onProgramException(ProgramException exception)
protected void	processParameters(java.lang.String[] parameters)
void	run()
protected abstract void	runProgram()
Program	setProgramName(java.lang.String name)
protected void	writeProgramMessage(java.lang.String format, java.lang.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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USAGE_OPTIONAL_BEGIN

public static final char USAGE_OPTIONAL_BEGIN

See Also:

Constant Field Values

USAGE_OPTIONAL_END

public static final char USAGE_OPTIONAL_END

See Also:

Constant Field Values

USAGE_REPEATING_INDICATOR

public static final java.lang.String USAGE_REPEATING_INDICATOR

See Also:

Constant Field Values

Constructor Detail

Program

protected Program(java.lang.String... arguments)

Method Detail

runProgram

protected abstract void runProgram()
                            throws ProgramException

Throws:

ProgramException

isClient

public final boolean isClient()

getProgramName

public final java.lang.String getProgramName()

setProgramName

public final Program setProgramName(java.lang.String name)

writeProgramMessage

protected final void writeProgramMessage(java.lang.String format,
                                         java.lang.Object... arguments)

addOption

protected final void addOption(java.lang.String name,
                               Program.Option.Handler handler,
                               java.lang.String... operands)

addRequiredParameters

protected final void addRequiredParameters(java.lang.String... parameters)

addOptionalParameters

protected final void addOptionalParameters(java.lang.String... parameters)

addRepeatingParameter

protected final void addRepeatingParameter(java.lang.String parameter)

getPurpose

public java.lang.String getPurpose()

extendUsageSummary

protected void extendUsageSummary(java.lang.StringBuilder usage)

getUsageSummary

public final java.lang.String getUsageSummary()

processParameters

protected void processParameters(java.lang.String[] parameters)
                          throws SyntaxException

Throws:

SyntaxException

onProgramException

protected void onProgramException(ProgramException exception)

run

public final void run()

Specified by:

run in interface java.lang.Runnable