A B C E G I N R S T U
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractApplication - Class in com.globalmentor.application
-
An abstract implementation of an application that by default is a console application.
- AbstractApplication() - Constructor for class com.globalmentor.application.AbstractApplication
-
No-arguments constructor.
- AbstractApplication(String[]) - Constructor for class com.globalmentor.application.AbstractApplication
-
Arguments constructor.
- AbstractMetadataProvider(Class<? extends Application>) - Constructor for class com.globalmentor.application.BaseCliApplication.AbstractMetadataProvider
-
Application class constructor.
- Application - Interface in com.globalmentor.application
-
A general application.
B
- BaseCliApplication - Class in com.globalmentor.application
-
Base implementation for facilitating creation of a CLI application.
- BaseCliApplication(String[]) - Constructor for class com.globalmentor.application.BaseCliApplication
-
Arguments constructor.
- BaseCliApplication.AbstractMetadataProvider - Class in com.globalmentor.application
-
Strategy for retrieving the application name and version from the configuration.
C
- canEnd() - Method in class com.globalmentor.application.AbstractApplication
-
Determines whether the application can end.
- canStart() - Method in class com.globalmentor.application.AbstractApplication
-
Checks requirements, permissions, and expirations before starting.
- com.globalmentor.application - package com.globalmentor.application
- CONFIG_KEY_NAME - Static variable in class com.globalmentor.application.BaseCliApplication
-
The configuration key containing the version of the program.
- CONFIG_KEY_VERSION - Static variable in class com.globalmentor.application.BaseCliApplication
-
The configuration key containing the version of the program.
E
- end() - Method in interface com.globalmentor.application.Application
-
Ends the application with a status of success.
- end(int) - Method in class com.globalmentor.application.AbstractApplication
-
Ends the application with the given status.
- end(int) - Method in interface com.globalmentor.application.Application
-
Ends the application with the given status.
- execute() - Method in class com.globalmentor.application.AbstractApplication
-
Main execution implementation.
- execute() - Method in class com.globalmentor.application.BaseCliApplication
-
Main execution implementation.
- exit(int) - Method in interface com.globalmentor.application.Application
-
Exits the application immediately with the given status without checking to see if exit should be performed.
- exit(int) - Method in class com.globalmentor.application.BaseCliApplication
-
Exits the application immediately with the given status without checking to see if exit should be performed.
- EXIT_CODE_CONTINUE - Static variable in interface com.globalmentor.application.Application
-
Pseudo exit code indicating that the application should not exit immediately, e.g.
- EXIT_CODE_OK - Static variable in interface com.globalmentor.application.Application
-
Exit code indicating a successful termination.
- EXIT_CODE_SOFTWARE - Static variable in interface com.globalmentor.application.Application
-
Exit code indicating execution failure.
- EXIT_CODE_USAGE - Static variable in interface com.globalmentor.application.Application
-
Exit code indicating incorrect command-line usage.
G
- getArgs() - Method in class com.globalmentor.application.AbstractApplication
- getArgs() - Method in interface com.globalmentor.application.Application
- getAuthenticator() - Method in class com.globalmentor.application.AbstractApplication
- getAuthenticator() - Method in interface com.globalmentor.application.Application
- getExpirationDate() - Method in class com.globalmentor.application.AbstractApplication
- getExpirationDate() - Method in interface com.globalmentor.application.Application
- getName() - Method in class com.globalmentor.application.BaseCliApplication
- getPreferences() - Method in class com.globalmentor.application.AbstractApplication
- getPreferences() - Method in interface com.globalmentor.application.Application
-
Returns the application user preferences.
- getVersion() - Method in interface com.globalmentor.application.Application
- getVersion() - Method in class com.globalmentor.application.BaseCliApplication.AbstractMetadataProvider
- getVersion() - Method in class com.globalmentor.application.BaseCliApplication
I
- initialize() - Method in class com.globalmentor.application.AbstractApplication
-
Initializes the application.
- initialize() - Method in interface com.globalmentor.application.Application
-
Initializes the application.
- initialize() - Method in class com.globalmentor.application.BaseCliApplication
-
Initializes the application.
- isDebug() - Method in interface com.globalmentor.application.Application
-
Returns whether debug mode is enabled.
- isDebug() - Method in class com.globalmentor.application.BaseCliApplication
N
- NO_ARGUMENTS - Static variable in interface com.globalmentor.application.Application
-
An array containing no arguments.
R
- reportError(String) - Method in class com.globalmentor.application.AbstractApplication
-
Reports the given error message to the user
- reportError(String) - Method in interface com.globalmentor.application.Application
-
Reports the given error message to the user
- reportError(String) - Method in class com.globalmentor.application.BaseCliApplication
-
Reports the given error message to the user
- reportError(String, Throwable) - Method in class com.globalmentor.application.AbstractApplication
-
Reports an error message to the user related to an exception.
- reportError(String, Throwable) - Method in interface com.globalmentor.application.Application
-
Reports an error message to the user related to an exception.
- reportError(String, Throwable) - Method in class com.globalmentor.application.BaseCliApplication
-
Reports an error message to the user related to an exception.
- reportError(Throwable) - Method in class com.globalmentor.application.AbstractApplication
-
Reports an error condition to the user.
- reportError(Throwable) - Method in interface com.globalmentor.application.Application
-
Reports an error condition to the user.
- reportError(Throwable) - Method in class com.globalmentor.application.BaseCliApplication
-
Reports an error condition to the user.
- run() - Method in class com.globalmentor.application.BaseCliApplication
S
- setAuthenticator(Authenticable) - Method in class com.globalmentor.application.AbstractApplication
-
Sets the authenticator object used to retrieve client authentication.
- setDebug(boolean) - Method in class com.globalmentor.application.BaseCliApplication
-
Enables or disables debug mode, which is disabled by default.
- setExpirationDate(LocalDate) - Method in class com.globalmentor.application.AbstractApplication
-
Sets the expiration date of the application.
- start() - Method in class com.globalmentor.application.AbstractApplication
-
Starts the application if it can be started.
- start() - Method in interface com.globalmentor.application.Application
-
Starts the application if it can be started.
- start(Application) - Static method in interface com.globalmentor.application.Application
-
Starts an application.
T
- toErrorMessage(Throwable) - Method in class com.globalmentor.application.AbstractApplication
-
Constructs a user-presentable error message based on an exception.
U
- updateLogLevel() - Method in class com.globalmentor.application.BaseCliApplication
-
Updates the log level based upon the current debug setting.
All Classes All Packages