A B C G I O P W
All Classes All Packages

A

addExampleUsage(String, Operand<?>...) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method adding an application's ExampleUsage element.

addExampleUsage(ExampleUsage) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method adding an application's ExampleUsage element.

B

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.CliHelper

Creates builder to build CliHelper.

C

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 ArgsSyntax elements such as HelpFlag, VerboseFlag, QuietFlag, InitFlag, SysInfoFlag, DebugFlag or ConfigOption (and the like).

CliHelper(String[], ArgsSyntax, Collection<ExampleUsage>, String, String, String, String, String, String, Font, char[], boolean, RuntimeLogger) - 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.

G

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).

O

org.refcodes.archetype - module org.refcodes.archetype

org.refcodes.archetype - package org.refcodes.archetype

P

printSysInfo() - Method in class org.refcodes.archetype.CliHelper

Prints system information helpful for debugging cases.

W

withArgs(String[]) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's command line arguments.

withArgsSyntax(ArgsSyntax) - 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.CliHelper.Builder

Builder method providing the application's banner font.

withBannerPalette(char[]) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's banner ASCII palette.

withBannerPalette(AsciiColorPalette) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's banner ASCII palette.

withCopyright(String) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's copyright.

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.CliHelper.Builder

Builder method providing the application's description property.

withExampleUsages(Collection<ExampleUsage>) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's ExampleUsage elements.

withExampleUsages(ExampleUsage[]) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's ExampleUsage elements.

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.CliHelper.Builder

Builder method providing the application's RuntimeLogger.

withName(String) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's name property.

withTitle(String) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's description property.

withVerboseFallback(boolean) - Method in class org.refcodes.archetype.CliHelper.Builder

Builder method providing the application's verbose fallback property.

A B C G I O P W
All Classes All Packages