Index (Commons Application

A C D E G I L M N P R S T V

A

ApplicationException - Exception in de.weltraumschaf.commons.application: Used to signal abnormal exceptional application states.
ApplicationException(ExitCode, String) - Constructor for exception de.weltraumschaf.commons.application.ApplicationException: Initializes the cause with null.
ApplicationException(ExitCode, String, Throwable) - Constructor for exception de.weltraumschaf.commons.application.ApplicationException: Dedicated constructor.
args - Variable in class de.weltraumschaf.commons.application.InvokableAdapter: Copy of the command line arguments.

C

callbacks - Variable in class de.weltraumschaf.commons.application.ShutDownHook: Set of callbacks.

D

de.weltraumschaf.commons.application - package de.weltraumschaf.commons.application: Library of classes used in several projects.
DEFAULT_ENCODING - Static variable in class de.weltraumschaf.commons.application.IOStreams: Default character encoding for out put print streams.
DEFAULT_LOGGER - Static variable in class de.weltraumschaf.commons.application.ShutDownHook: Default logger for this class.
defaultValue - Variable in enum de.weltraumschaf.commons.application.Version.PropertyNames: Default value.

E

error(String) - Method in interface de.weltraumschaf.commons.application.IO: Prints error.
error(String) - Method in class de.weltraumschaf.commons.application.IOStreams: Prints error.
errorln(String) - Method in interface de.weltraumschaf.commons.application.IO: Prints error line.
errorln(String) - Method in class de.weltraumschaf.commons.application.IOStreams: Prints error line.
execute() - Method in interface de.weltraumschaf.commons.application.Invokable: Template method for main application code.
exit(ExitCode) - Method in interface de.weltraumschaf.commons.application.Invokable: Exits the invokable.
exit(int) - Method in interface de.weltraumschaf.commons.application.Invokable: Exits the invokable.
exit(int) - Method in class de.weltraumschaf.commons.application.InvokableAdapter
exit(ExitCode) - Method in class de.weltraumschaf.commons.application.InvokableAdapter
exitCode - Variable in exception de.weltraumschaf.commons.application.ApplicationException: Exit code used to return to JVM.
exiter - Variable in class de.weltraumschaf.commons.application.InvokableAdapter: Abstraction for System.exit(int).

G

getArgs() - Method in class de.weltraumschaf.commons.application.InvokableAdapter: Get the command line arguments.
getDefaultValue() - Method in enum de.weltraumschaf.commons.application.Version.PropertyNames: Get the fallback value.
getExitCode() - Method in exception de.weltraumschaf.commons.application.ApplicationException: Get program exit code.
getIoStreams() - Method in interface de.weltraumschaf.commons.application.Invokable: Get stream object for I/O.
getIoStreams() - Method in class de.weltraumschaf.commons.application.InvokableAdapter
getStderr() - Method in interface de.weltraumschaf.commons.application.IO: Get standard errorln output stream.
getStderr() - Method in class de.weltraumschaf.commons.application.IOStreams: Get standard errorln output stream.
getStdin() - Method in interface de.weltraumschaf.commons.application.IO: Get standard input stream.
getStdin() - Method in class de.weltraumschaf.commons.application.IOStreams: Get standard input stream.
getStdout() - Method in interface de.weltraumschaf.commons.application.IO: Get standard output stream.
getStdout() - Method in class de.weltraumschaf.commons.application.IOStreams: Get standard output stream.
getVersion() - Method in class de.weltraumschaf.commons.application.Version: Get the version string.

I

init() - Method in interface de.weltraumschaf.commons.application.Invokable: Initializes the invokable.
init() - Method in class de.weltraumschaf.commons.application.InvokableAdapter: Adds shutdown hook to runtime.
Invokable - Interface in de.weltraumschaf.commons.application: An invokable is an application object invokable by command line interface.
InvokableAdapter - Class in de.weltraumschaf.commons.application: Abstract base implementation of an command line invokable.
InvokableAdapter(String[]) - Constructor for class de.weltraumschaf.commons.application.InvokableAdapter: Copies the command line arguments.
InvokableAdapter(String[], Runtime, ShutDownHook) - Constructor for class de.weltraumschaf.commons.application.InvokableAdapter: Dedicated constructor.
IO - Interface in de.weltraumschaf.commons.application: Implementations provide an aggregate object which contains STDIN, STDOUT and STDERR streams.
ioStreams - Variable in class de.weltraumschaf.commons.application.InvokableAdapter: I/O streams.
IOStreams - Class in de.weltraumschaf.commons.application: Immutable aggregate object which contains STDIN, STDOUT and STDERR streams.
IOStreams(InputStream, PrintStream, PrintStream) - Constructor for class de.weltraumschaf.commons.application.IOStreams: Initializes the streams.

L

load() - Method in class de.weltraumschaf.commons.application.Version: Opens the properties file and loads it.
loadImpl() - Method in class de.weltraumschaf.commons.application.Version: Encapsulates the file loading.
logger - Variable in class de.weltraumschaf.commons.application.ShutDownHook: Logger instance.

M

main(Invokable) - Static method in class de.weltraumschaf.commons.application.InvokableAdapter: Invokes invokable with default I/O.
main(Invokable, IO) - Static method in class de.weltraumschaf.commons.application.InvokableAdapter: Inject the I/O streams to the invokable and then calls Invokable.init() and then Invokable.execute().
main(Invokable, IO, boolean) - Static method in class de.weltraumschaf.commons.application.InvokableAdapter: Inject the I/O streams to the invokable and then calls Invokable.init() and then Invokable.execute().

N

name - Variable in enum de.weltraumschaf.commons.application.Version.PropertyNames: Property name.
newDefault() - Static method in class de.weltraumschaf.commons.application.IOStreams: Creates same as IOStreams.newDefault(java.lang.String) but with IOStreams.DEFAULT_ENCODING as encoding.
newDefault(String) - Static method in class de.weltraumschaf.commons.application.IOStreams: Creates a new streams object initialized with System.in, System.out, and System.err.

P

print(String) - Method in interface de.weltraumschaf.commons.application.IO: Prints string.
print(String) - Method in class de.weltraumschaf.commons.application.IOStreams: Prints string.
println(String) - Method in interface de.weltraumschaf.commons.application.IO: Prints string line.
println(String) - Method in class de.weltraumschaf.commons.application.IOStreams: Prints string line.
printStackTrace(Throwable) - Method in interface de.weltraumschaf.commons.application.IO: Prints exception stack trace.
printStackTrace(Throwable) - Method in class de.weltraumschaf.commons.application.IOStreams: Prints exception stack trace.
properties - Variable in class de.weltraumschaf.commons.application.Version: Properties.
propertiesLoaded - Variable in class de.weltraumschaf.commons.application.Version: Indicates whether the properties are already loaded or not.
propertyFileName - Variable in class de.weltraumschaf.commons.application.Version: Location of property file.

R

register(Runnable) - Method in class de.weltraumschaf.commons.application.ShutDownHook: Registers a callback.
register(Callable<Void>) - Method in class de.weltraumschaf.commons.application.ShutDownHook: Registers a callback.
registerShutdownHook(Runnable) - Method in class de.weltraumschaf.commons.application.InvokableAdapter: Register a callback as shut down hook.
registerShutdownHook(Callable<Void>) - Method in class de.weltraumschaf.commons.application.InvokableAdapter: Register a callback as shut down hook.
run() - Method in class de.weltraumschaf.commons.application.ShutDownHook: Iterates over all ShutDownHook.callbacks and run them.
runtime - Variable in class de.weltraumschaf.commons.application.InvokableAdapter: Runtime for registering callbacks.

S

setExiter(Exitable) - Method in interface de.weltraumschaf.commons.application.Invokable: Set an exiter to handle exit calls.
setExiter(Exitable) - Method in class de.weltraumschaf.commons.application.InvokableAdapter
setIoStreams(IO) - Method in interface de.weltraumschaf.commons.application.Invokable: Set stream object for I/O.
setIoStreams(IO) - Method in class de.weltraumschaf.commons.application.InvokableAdapter
shutDownHook - Variable in class de.weltraumschaf.commons.application.InvokableAdapter: Container for shutdown callbacks.
ShutDownHook - Class in de.weltraumschaf.commons.application: Holds callbacks to execute them in any order.
ShutDownHook() - Constructor for class de.weltraumschaf.commons.application.ShutDownHook: Initializes ShutDownHook.logger with ShutDownHook.DEFAULT_LOGGER.
ShutDownHook(Logger) - Constructor for class de.weltraumschaf.commons.application.ShutDownHook: Designated constructor.
stderr - Variable in class de.weltraumschaf.commons.application.IOStreams: Standard error stream.
stdin - Variable in class de.weltraumschaf.commons.application.IOStreams: Standard input stream.
stdout - Variable in class de.weltraumschaf.commons.application.IOStreams: Standard output stream.

T

toString() - Method in exception de.weltraumschaf.commons.application.ApplicationException
toString() - Method in enum de.weltraumschaf.commons.application.Version.PropertyNames: Returns the property name.
toString() - Method in class de.weltraumschaf.commons.application.Version: Returns the version string.

V

valueOf(String) - Static method in enum de.weltraumschaf.commons.application.Version.PropertyNames: Returns the enum constant of this type with the specified name.
values() - Static method in enum de.weltraumschaf.commons.application.Version.PropertyNames: Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in de.weltraumschaf.commons.application: Reads the current version from a property file.
Version(String) - Constructor for class de.weltraumschaf.commons.application.Version: Private constructor for singleton.
Version.PropertyNames - Enum in de.weltraumschaf.commons.application: Available properties in the file.
Version.PropertyNames(String, String) - Constructor for enum de.weltraumschaf.commons.application.Version.PropertyNames: Initializes the enum with the property name.

A C D E G I L M N P R S T V