A B C D E F G I L N O P Q R S T U V W 

A

AbstractProgram - Class in org.imca_cat.prgm
A skeletal computer program.
AbstractProgram() - Constructor for class org.imca_cat.prgm.AbstractProgram
Constructs an instance with an Object critical section lock, an error stream that is a PrintWriter on the system standard error stream without buffering, without automatic flushing, and using the default character encoding, and an empty options set.
AbstractProgram(Object) - Constructor for class org.imca_cat.prgm.AbstractProgram
Constructs an instance with the specified critical section lock, an error stream that is a PrintWriter on the system standard error stream without buffering, without automatic flushing, and using the default character encoding, and an empty options set.
AbstractProgram(Object, PrintWriter, Set<AbstractProgram.Option>) - Constructor for class org.imca_cat.prgm.AbstractProgram
Constructs an instance with the specified critical section lock, error stream, and options set.
AbstractProgram.Option - Enum in org.imca_cat.prgm
Options controlling the behavior of an AbstractProgram.
autoFlushStderr(boolean) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets whether the standard error stream should be automatically flushed.
autoFlushStderr(boolean) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets whether the standard error stream should be automatically flushed.
autoFlushStdout(boolean) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets whether the standard output stream should be automatically flushed.
autoFlushStdout(boolean) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets whether the standard output stream should be automatically flushed.

B

build() - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Creates a new UI from this builder.
build() - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
 
Builder() - Constructor for class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Constructs an instance.
Builder(DefaultConfigurableSensibleUi.Builder) - Constructor for class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Constructs an instance with the same values as the specified builder.

C

ConfigurableSensibleUi - Interface in org.imca_cat.prgm
A SensibleUi that can be configured.
ConfigurableSensibleUi.Builder - Interface in org.imca_cat.prgm
A builder for creating ConfigurableSensibleUi instances.
console(ProgramConsole) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the console used for prompting the user.
console(ProgramConsole) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the console used for prompting the user.
CONSOLE - org.imca_cat.prgm.StandardIo
The console.
ConsoleProgramConsole - Class in org.imca_cat.prgm
An adapter that adapts a Console to a ProgramConsole.
ConsoleProgramConsole(Console) - Constructor for class org.imca_cat.prgm.ConsoleProgramConsole
Constructs an instance with the specified console.
create() - Static method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Creates a new instance with Builder defaults.

D

debug(boolean) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the debug level flag.
debug(boolean) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the debug level flag.
debug(String, Object...) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Writes the message, prefixed with the debug prefix, to the underlying stream if the debug level flag is set.
debug(String, Object...) - Method in interface org.imca_cat.prgm.SensibleUi
Writes the message at the debug level.
debugPrefix(String) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the prefix for debug messages.
debugPrefix(String) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the prefix for debug messages.
debugTo(StandardIo) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Selects which of this builder's output streams debug messages should be written to.
debugTo(StandardIo) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Selects which of this builder's output streams debug messages should be written to.
DefaultConfigurableSensibleUi - Class in org.imca_cat.prgm
A configurable text user interface.
DefaultConfigurableSensibleUi.Builder - Class in org.imca_cat.prgm
A builder for creating DefaultConfigurableSensibleUi instances.

E

enableVmHeadlessMode() - Static method in class org.imca_cat.prgm.Programs
Enables the VM's headless mode (i.e., the mode that does not require a display, keyboard, nor mouse).
error(String, Object...) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Writes the message, prefixed with the error prefix, to the standard error stream.
error(String, Object...) - Method in interface org.imca_cat.prgm.SensibleUi
Writes the message at the error level.
ERROR - org.imca_cat.prgm.StandardIo
The standard error stream.
errorOffset() - Method in exception org.imca_cat.prgm.PromptChoicesSyntaxException
Returns the zero-based character position of the syntax error.
errorPrefix(String) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the prefix for error messages.
errorPrefix(String) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the prefix for error messages.
EXIT_FAILURE - Static variable in interface org.imca_cat.prgm.Program
Exit status 1 indicating failure.
EXIT_SUCCESS - Static variable in interface org.imca_cat.prgm.Program
Exit status 0 indicating success.
exitStatus() - Method in exception org.imca_cat.prgm.ProgramDieException
Returns the exit status of the program.
exitStatus(Throwable) - Method in class org.imca_cat.prgm.AbstractProgram
Returns an exit status for the specified exception.
exitStatus(Throwable) - Method in interface org.imca_cat.prgm.Program
Returns an exit status for the specified exception.

F

flush() - Method in class org.imca_cat.prgm.AbstractProgram
Flushes any buffered output to underlying standard I/O destinations.
flush() - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
flush() - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Causes any buffered output on the standard output stream, standard error stream, and console to be written out.
flush() - Method in interface org.imca_cat.prgm.Program
Flushes any buffered output to underlying standard I/O destinations.
flush() - Method in interface org.imca_cat.prgm.ProgramConsole
Ensures that any buffered output is written out.
flush() - Method in class org.imca_cat.prgm.SensibleProgram
Flushes any buffered output to underlying standard I/O destinations.
flush() - Method in interface org.imca_cat.prgm.SensibleUi
Causes any buffered output on the standard output stream, standard error stream, and any implementation-dependent output destination (e.g., a ProgramConsole) to be written out.
format(String, Object...) - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
format(String, Object...) - Method in interface org.imca_cat.prgm.ProgramConsole
Prints the message.

G

getLocalizedMessage() - Method in exception org.imca_cat.prgm.ProgramDieException
Returns the localized reason message as specified at instance creation time, falling back to the non-localized reason message if there is no localized reason message.

I

INPUT - org.imca_cat.prgm.StandardIo
The standard input stream.
io() - Method in exception org.imca_cat.prgm.StandardIoException
Returns the type of I/O on which the error occurred.

L

locale(Locale) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the locale to use for locale-sensitive operations.
locale(Locale) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the locale to use for locale-sensitive operations.
LOCALIZED - org.imca_cat.prgm.AbstractProgram.Option
Prefer localized messages.
lock() - Method in class org.imca_cat.prgm.AbstractProgram
Returns the object on which this program's critical sections synchronize.

N

note(String, Object...) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Writes the message, prefixed with the note prefix, to the underlying stream if the verbose level flag is set.
note(String, Object...) - Method in interface org.imca_cat.prgm.SensibleUi
Writes the message at the note level.
notePrefix(String) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the prefix for note messages.
notePrefix(String) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the prefix for note messages.
noteTo(StandardIo) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Selects which of this builder's output streams note messages should be written to.
noteTo(StandardIo) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Selects which of this builder's output streams note messages should be written to.

O

org.imca_cat.prgm - package org.imca_cat.prgm
Contains all the Prgm classes.
OUTPUT - org.imca_cat.prgm.StandardIo
The standard output stream.

P

printError(Throwable) - Method in class org.imca_cat.prgm.AbstractProgram
Prints an error for the specified exception.
printError(Throwable) - Method in interface org.imca_cat.prgm.Program
Prints an error for the specified exception.
printError(Throwable) - Method in class org.imca_cat.prgm.SensibleProgram
Prints an error for the specified exception.
printf(String, Object...) - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
printf(String, Object...) - Method in interface org.imca_cat.prgm.ProgramConsole
Prints the message.
printStackTrace(boolean) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets whether exception stack traces should be printed.
printStackTrace(boolean) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets whether exception stack traces should be printed.
Program - Interface in org.imca_cat.prgm
A computer program.
ProgramConsole - Interface in org.imca_cat.prgm
A computer program console.
ProgramDieException - Exception in org.imca_cat.prgm
Indicates a Program has terminated.
ProgramDieException(int) - Constructor for exception org.imca_cat.prgm.ProgramDieException
Constructs an instance with the specified exit status.
ProgramDieException(String, int) - Constructor for exception org.imca_cat.prgm.ProgramDieException
Constructs an instance with the specified reason message and exit status.
ProgramDieException(String, String, int) - Constructor for exception org.imca_cat.prgm.ProgramDieException
Constructs an instance with the specified reason message, localized reason message, and exit status.
programName(String) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the name of the program.
programName(String) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the name of the program.
Programs - Class in org.imca_cat.prgm
A class providing static utility methods related to programs.
prompt(String, String) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Prompts the user with the specified prompt message and default response.
prompt(String, String) - Method in interface org.imca_cat.prgm.SensibleUi
Prompts the user with the specified prompt message and default response.
promptChoice(String, int, String) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Prompts the user with the specified prompt message, default response, and choices.
promptChoice(String, int, String) - Method in interface org.imca_cat.prgm.SensibleUi
Prompts the user with the specified prompt message, default response, and choices.
PromptChoicesSyntaxException - Exception in org.imca_cat.prgm
Indicates a syntax error in a UI prompt-choices string.
PromptChoicesSyntaxException(int) - Constructor for exception org.imca_cat.prgm.PromptChoicesSyntaxException
Constructs an instance with the specified error offset.
PromptChoicesSyntaxException(int, Throwable) - Constructor for exception org.imca_cat.prgm.PromptChoicesSyntaxException
Constructs an instance with the specified error offset and cause.
PromptChoicesSyntaxException(String, int) - Constructor for exception org.imca_cat.prgm.PromptChoicesSyntaxException
Constructs an instance with the specified detail message and error offset.
PromptChoicesSyntaxException(String, int, Throwable) - Constructor for exception org.imca_cat.prgm.PromptChoicesSyntaxException
Constructs an instance with the specified detail message, error offset, and cause.
promptPassword(String, char[]) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Prompts the user for a password with echoing turned off and with the specified prompt message and default password.
promptPassword(String, char[]) - Method in interface org.imca_cat.prgm.SensibleUi
Prompts the user for a password with echoing turned off and with the specified prompt message and default password.

Q

quiet(boolean) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the quiet level flag.
quiet(boolean) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the quiet level flag.

R

reader() - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
reader() - Method in interface org.imca_cat.prgm.ProgramConsole
Returns the underlying reader of this console.
readLine() - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
readLine() - Method in interface org.imca_cat.prgm.ProgramConsole
Reads a line of input.
readLine(String, Object...) - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
readLine(String, Object...) - Method in interface org.imca_cat.prgm.ProgramConsole
Prints a prompt, and reads a line of input.
readPassword() - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
readPassword() - Method in interface org.imca_cat.prgm.ProgramConsole
Reads a password with echoing turned off.
readPassword(String, Object...) - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
readPassword(String, Object...) - Method in interface org.imca_cat.prgm.ProgramConsole
Prints a prompt, and reads a password with echoing turned off.
run() - Method in interface org.imca_cat.prgm.Program
Runs this program.
runAndExitVm() - Method in class org.imca_cat.prgm.AbstractProgram
Runs this program and exits the VM with the exit status of this program.
runAndExitVm(Program) - Static method in class org.imca_cat.prgm.Programs
Runs the specified program and exits the VM with the exit status of the program.

S

SensibleProgram<T extends SensibleUi> - Class in org.imca_cat.prgm
A skeletal computer program that behaves in a sensible way.
SensibleProgram(Object, T) - Constructor for class org.imca_cat.prgm.SensibleProgram
Constructs an instance with the specified critical section lock and UI.
SensibleProgram(T) - Constructor for class org.imca_cat.prgm.SensibleProgram
Constructs an instance with an Object critical section lock and the specified UI.
SensibleUi - Interface in org.imca_cat.prgm
A text user interface for a SensibleProgram.
StandardIo - Enum in org.imca_cat.prgm
The standard I/O types of a Program.
StandardIoException - Exception in org.imca_cat.prgm
Indicates an error during a standard I/O operation.
StandardIoException(StandardIo) - Constructor for exception org.imca_cat.prgm.StandardIoException
Constructs an instance with the specified type of I/O.
StandardIoException(StandardIo, Throwable) - Constructor for exception org.imca_cat.prgm.StandardIoException
Constructs an instance with the specified type of I/O and cause.
status(String, Object...) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Writes the message, prefixed with the status prefix, to the underlying stream if the quiet level flag is not set.
status(String, Object...) - Method in interface org.imca_cat.prgm.SensibleUi
Writes the message at the status level.
statusPrefix(String) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the prefix for status messages.
statusPrefix(String) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the prefix for status messages.
statusTo(StandardIo) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Selects which of this builder's output streams status messages should be written to.
statusTo(StandardIo) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Selects which of this builder's output streams status messages should be written to.
stderr(Appendable) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the standard error stream.
stderr(Appendable) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the standard error stream.
stdout(Appendable) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the standard output stream.
stdout(Appendable) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the standard output stream.
systemInstance() - Static method in class org.imca_cat.prgm.ConsoleProgramConsole
Returns the system ConsoleProgramConsole instance for the system Console.

T

toBuilder() - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi
Converts this UI into a builder.
toBuilder() - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
 

U

ui() - Method in class org.imca_cat.prgm.SensibleProgram
Returns the user interface of this program.
ui(T) - Method in class org.imca_cat.prgm.SensibleProgram
Sets the user interface of this program.
useLocalizedExceptionMessage(boolean) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets whether to use localized or non-localized exception messages when printing messages from exceptions.
useLocalizedExceptionMessage(boolean) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets whether to use localized or non-localized exception messages when printing messages from exceptions.

V

valueOf(String) - Static method in enum org.imca_cat.prgm.AbstractProgram.Option
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.imca_cat.prgm.StandardIo
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.imca_cat.prgm.AbstractProgram.Option
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.imca_cat.prgm.StandardIo
Returns an array containing the constants of this enum type, in the order they are declared.
verbose(boolean) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the verbose level flag.
verbose(boolean) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the verbose level flag.

W

warn(String, Object...) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Writes the message, prefixed with the warn prefix, to the standard error stream.
warn(String, Object...) - Method in interface org.imca_cat.prgm.SensibleUi
Writes the message at the warn level.
warnPrefix(String) - Method in interface org.imca_cat.prgm.ConfigurableSensibleUi.Builder
Sets the prefix for warn messages.
warnPrefix(String) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi.Builder
Sets the prefix for warn messages.
write(String, Object...) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Writes the message to the standard output stream.
write(String, Object...) - Method in interface org.imca_cat.prgm.SensibleUi
Writes the message to the standard output stream.
writer() - Method in class org.imca_cat.prgm.ConsoleProgramConsole
 
writer() - Method in interface org.imca_cat.prgm.ProgramConsole
Returns the underlying writer of this console.
writeStderr(String, Object...) - Method in class org.imca_cat.prgm.DefaultConfigurableSensibleUi
Writes the message to the standard error stream.
writeStderr(String, Object...) - Method in interface org.imca_cat.prgm.SensibleUi
Writes the message to the standard error stream.
A B C D E F G I L N O P Q R S T U V W 
Skip navigation links