Index (org.refcodes:refcodes-archetype 3.1.0 API)

A B C D E G I L O P R S T V W _
All Classes and Interfaces|All Packages|Constant Field Values

A

addExampleUsage(String, Operand<?>...) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method adding an application's Example element.
addExampleUsage(String, Operand<?>...) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method adding an application's Example element.
addExampleUsage(Example) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method adding an application's Example element.
addExampleUsage(Example) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method adding an application's Example element.
AppHelper - Class in org.refcodes.archetype: The AppHelper is a stripped down CliHelper intended to be used by GUI applications which must(!)
AppHelper(String[], char, String, Condition, SyntaxNotation, Collection<Example>, String, ConfigLocator, Class<?>, String, String, String, String, String, String, Font, char[], boolean, RuntimeLogger, Consumer<Integer>) - Constructor for class org.refcodes.archetype.AppHelper: Creates a new AppHelper using the provided application's RuntimeLogger so that logs produced by the AppHelper are logged according to the application's RuntimeLogger configuration (depending on the RuntimeLogger.ini file).
AppHelper.Builder - Class in org.refcodes.archetype: Builder to build CliHelper.
appName - Variable in class org.refcodes.archetype.CliHelper.Builder
args - Variable in class org.refcodes.archetype.CliHelper.Builder
argsSyntax - Variable in class org.refcodes.archetype.CliHelper.Builder

B

bannerFont - Variable in class org.refcodes.archetype.CliHelper.Builder
bannerFontPalette - Variable in class org.refcodes.archetype.CliHelper.Builder
build() - Method in class org.refcodes.archetype.AppHelper.Builder: Creates a new CliHelper using the configured properties.
build() - Method in class org.refcodes.archetype.C2Helper.Builder: Creates a new C2Helper using the configured properties.
build() - Method in class org.refcodes.archetype.CliHelper.Builder: Creates a new CliHelper using the configured properties.
builder() - Static method in class org.refcodes.archetype.AppHelper: Creates builder to build AppHelper.
builder() - Static method in class org.refcodes.archetype.C2Helper: Creates builder to build C2Helper.
builder() - Static method in class org.refcodes.archetype.CliHelper: Creates builder to build CliHelper.
Builder() - Constructor for class org.refcodes.archetype.CliHelper.Builder: Instantiates a new builder.

C

C2Helper - Class in org.refcodes.archetype: The C2Helper provides means to manage launching and connecting to a C2 server.
C2Helper(String, Class<?>, boolean, boolean, RuntimeLogger) - Constructor for class org.refcodes.archetype.C2Helper: Instantiates a new C2 helper.
C2Helper.Builder - Class in org.refcodes.archetype: Builder to build C2Helper instances.
CliHelper - Class in org.refcodes.archetype: The CliHelper provides means to support CLI command line argument parsing.E.g. using the CliHelper you easily can create configuration files ("--init" or "--init path/to/your/config") from a template (found in "src/main/resources"), print a help text ("--help"), show system information ("--sysinfo") for support issues, regard being more verbose ("--verbose") or more quiet ("--quiet"), load a configuration from a specific location ("--config path/to/your/config"), all given that your command line syntax given uses the according predefined args syntax Constituent elements such as HelpFlag, VerboseFlag, QuietFlag, InitFlag, SysInfoFlag, DebugFlag or ConfigOption (and the like).
CliHelper(String[], char, String, Constituent, SyntaxNotation, Collection<Example>, String, ConfigLocator, Class<?>, String, String, String, String, String, String, Font, char[], boolean, RuntimeLogger, Consumer<Integer>) - Constructor for class org.refcodes.archetype.CliHelper: Creates a new CliHelper using the provided application's RuntimeLogger so that logs produced by the CliHelper are logged according to the application's RuntimeLogger configuration (depending on the RuntimeLogger.ini file).
CliHelper.Builder - Class in org.refcodes.archetype: Builder to build CliHelper.
configLocator - Variable in class org.refcodes.archetype.CliHelper.Builder
copyrightNote - Variable in class org.refcodes.archetype.CliHelper.Builder
createResourceFile(String, File) - Method in class org.refcodes.archetype.CliHelper: Copies a resource file (stored in the fat JAR) to the given destination on the file system or (if the destination is not provided) to a file with the name of the resource to the file system.
createResourceFile(String, String) - Method in class org.refcodes.archetype.CliHelper: Copies a resource file (stored in the fat JAR) to the given destination on the file system or (if the destination is not provided) to a file with the name of the resource to the file system.

D

DEFAULT_CONFIG_LOCATOR - Static variable in class org.refcodes.archetype.CliHelper
DEFAULT_PASSWORD_PROMPT - Static variable in class org.refcodes.archetype.CliHelper
DEFAULT_SYNTAX_NOTATION - Static variable in class org.refcodes.archetype.CliHelper
defaultConfig - Variable in class org.refcodes.archetype.CliHelper.Builder
deleteLockFile(boolean) - Method in class org.refcodes.archetype.C2Helper: Manually deletes the lockfile in case an orphaned lockfile is in the way.
description - Variable in class org.refcodes.archetype.CliHelper.Builder

E

exampleUsages - Variable in class org.refcodes.archetype.CliHelper.Builder
exit(int) - Method in class org.refcodes.archetype.CliHelper: Hook method for exiting the application.
exit(ExitCode) - Method in class org.refcodes.archetype.CliHelper: Convenience method for exiting the application.
exitOnException(Throwable) - Method in class org.refcodes.archetype.CliHelper: Exits upon a given exception by printing the exception according to any detected VerboseFlag as well as DebugFlag and the retrieved RuntimeProperties (see CliHelper.printException(Exception)) and then exiting with an exit code derived from the exception type.

G

getInstanceAlias() - Method in class org.refcodes.archetype.C2Helper: Returns the instance alias assigned to this C2Helper instance.
getLockFileName() - Method in class org.refcodes.archetype.C2Helper: Gets the lock file name.
getRuntimeProperties() - Method in class org.refcodes.archetype.CliHelper: Returns the RuntimeProperties as of the provided CLI configuration.

I

isVerbose() - Method in class org.refcodes.archetype.CliHelper: Determines the verbose mode by evaluating the VerboseFlag.ALIAS and the QuietFlag.ALIAS properties after having constructed the RuntimeProperties from the command line arguments and the configuration file (e.g. the "quiet" property is false or the "verbose" property is true).

L

licenseNote - Variable in class org.refcodes.archetype.CliHelper.Builder
logger - Variable in class org.refcodes.archetype.CliHelper.Builder
longOptionPrefix - Variable in class org.refcodes.archetype.CliHelper.Builder

O

org.refcodes.archetype - module org.refcodes.archetype
org.refcodes.archetype - package org.refcodes.archetype: This artifact provides base functionality such as the CliHelper as well as the C2Helper required by some of the refcodes-archetype-alt archetypes.

P

passwordPrompt - Variable in class org.refcodes.archetype.CliHelper.Builder
printBanner() - Method in class org.refcodes.archetype.AppHelper: Prints the application's banner to the console.
printBanner() - Method in class org.refcodes.archetype.CliHelper: Prints the application's banner to the console.
printException(Throwable) - Method in class org.refcodes.archetype.CliHelper: Prints the exception according to any detected VerboseFlag as well as DebugFlag and the retrieved RuntimeProperties.
printHelp() - Method in class org.refcodes.archetype.AppHelper: Prints the application's help to the console.
printHelp() - Method in class org.refcodes.archetype.CliHelper: Prints the application's help to the console.
printSysInfo() - Method in class org.refcodes.archetype.CliHelper: Prints system information helpful for debugging cases.

R

readLockFile(boolean) - Method in class org.refcodes.archetype.C2Helper: Reads the lockfile and returns its content as a Properties instance.
readPassword() - Method in class org.refcodes.archetype.CliHelper: Reads a password from the console using the configured (or the default) password prompt taking care of the verbose mode table's tail to be printed (in case necessary).
readPassword(String) - Method in class org.refcodes.archetype.CliHelper: Reads a password from the console taking care of the verbose mode table's tail to be printed (in case necessary).
resourceLocator - Variable in class org.refcodes.archetype.CliHelper.Builder

S

shortOptionPrefix - Variable in class org.refcodes.archetype.CliHelper.Builder
shutDownHook - Variable in class org.refcodes.archetype.CliHelper.Builder
syntaxNotation - Variable in class org.refcodes.archetype.CliHelper.Builder

T

title - Variable in class org.refcodes.archetype.CliHelper.Builder
toOptions(Option<?>) - Method in class org.refcodes.archetype.CliHelper

V

verboseFallback - Variable in class org.refcodes.archetype.CliHelper.Builder

W

withArgs(String[]) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's command line arguments.
withArgs(String[]) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's command line arguments.
withArgs(String[], Pattern) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withArgs(String[], ArgsFilter) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withArgs(List<String>) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's command line arguments.
withArgs(List<String>) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's command line arguments.
withArgs(List<String>, Pattern) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided Pattern.
withArgs(List<String>, ArgsFilter) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's command line arguments, filtering (excluding) the arguments matching the provided ArgsFilter.
withArgsSyntax(Constituent) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's command line syntax.
withArgsSyntax(Constituent) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's command line syntax.
withBannerFont(Font) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's banner font.
withBannerFont(Font) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's banner font.
withBannerFontPalette(char[]) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's banner ASCII palette.
withBannerFontPalette(char[]) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's banner ASCII palette.
withBannerFontPalette(AsciiColorPalette) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's banner ASCII palette.
withBannerFontPalette(AsciiColorPalette) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's banner ASCII palette.
withConfigLocator(ConfigLocator) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the ConfigLocator when doing a lookup of the configuration file.
withConfigLocator(ConfigLocator) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the ConfigLocator when doing a lookup of the configuration file.
withCopyrightNote(String) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's copyright.
withCopyrightNote(String) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's copyright.
withDefaultConfig(String) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's configuration file path.
withDefaultConfig(String) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's configuration file path.
withDescription(String) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's description property.
withDescription(String) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's description property.
withExamples(Collection<Example>) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's Example elements.
withExamples(Collection<Example>) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's Example elements.
withExamples(Example[]) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's Example elements.
withExamples(Example[]) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's Example elements.
withForce(boolean) - Method in class org.refcodes.archetype.C2Helper.Builder: Builder method setting the application's force mode.
withInstanceAlias(String) - Method in class org.refcodes.archetype.C2Helper.Builder: Builder method providing the application's instance alias.
withLicenseNote(String) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's license.
withLicenseNote(String) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's license.
withLogger(RuntimeLogger) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's RuntimeLogger.
withLogger(RuntimeLogger) - Method in class org.refcodes.archetype.C2Helper.Builder: Builder method providing the application's RuntimeLogger.
withLogger(RuntimeLogger) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's RuntimeLogger.
withName(String) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's name property.
withName(String) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's name property.
withPasswordPrompt(String) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's default password prompt.
withPasswordPrompt(String) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's default password prompt.
withResourceLocator(Class<?>) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the Class when doing a lookup of a (module specific) resource.
withResourceLocator(Class<?>) - Method in class org.refcodes.archetype.C2Helper.Builder: Builder method providing the Class when doing a lookup of a (module specific) resource.
withResourceLocator(Class<?>) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the Class when doing a lookup of a (module specific) resource.
withShutDownHook(Consumer<Integer>) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing an (optional) shutdown hook: When provided, then this hook is called instead of System.exit(int) (it is up to the shutdown hook to terminate the application in the end).
withShutDownHook(Consumer<Integer>) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing an (optional) shutdown hook: When provided, then this hook is called instead of System.exit(int) (it is up to the shutdown hook to terminate the application in the end).
withSyntaxNotation(SyntaxNotation) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method setting the SyntaxNotation.
withSyntaxNotation(SyntaxNotation) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method setting the SyntaxNotation.
withTitle(String) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's description property.
withTitle(String) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's description property.
withVerbose(boolean) - Method in class org.refcodes.archetype.C2Helper.Builder: Builder method setting the application's verbose mode.
withVerboseFallback(boolean) - Method in class org.refcodes.archetype.AppHelper.Builder: Builder method providing the application's verbose fallback property.
withVerboseFallback(boolean) - Method in class org.refcodes.archetype.CliHelper.Builder: Builder method providing the application's verbose fallback property.
writeLockFile(Properties, boolean) - Method in class org.refcodes.archetype.C2Helper: Writes the lockfile with the content of the provided Properties instance.

_

_properties - Variable in class org.refcodes.archetype.CliHelper

A B C D E G I L O P R S T V W _
All Classes and Interfaces|All Packages|Constant Field Values