Module org.refcodes.archetype

Package org.refcodes.archetype

Class AppHelper.Builder

java.lang.Object

org.refcodes.archetype.CliHelper.Builder

org.refcodes.archetype.AppHelper.Builder

Enclosing class:

AppHelper

public static final class AppHelper.Builder
extends CliHelper.Builder

Builder to build CliHelper.

Field Summary

Fields inherited from class org.refcodes.archetype.CliHelper.Builder

appName, args, argsSyntax, bannerFont, bannerFontPalette, configLocator, copyrightNote, defaultConfig, description, exampleUsages, licenseNote, logger, longOptionPrefix, passwordPrompt, resourceLocator, shortOptionPrefix, shutDownHook, syntaxNotation, title, verboseFallback

Method Summary

Modifier and Type	Method	Description
AppHelper.Builder	addExampleUsage(String aDescription, org.refcodes.cli.Operand<?>... aOperands)	Builder method adding an application's Example element.
AppHelper.Builder	addExampleUsage(org.refcodes.cli.Example aExamples)	Builder method adding an application's Example element.
AppHelper	build()	Creates a new CliHelper using the configured properties.
AppHelper.Builder	withArgs(String[] aArgs)	Builder method providing the application's command line arguments.
AppHelper.Builder	withArgs(List<String> aArgs)	Builder method providing the application's command line arguments.
AppHelper.Builder	withArgsSyntax(org.refcodes.cli.Constituent aArgsSyntax)	Builder method providing the application's command line syntax.
AppHelper.Builder	withBannerFont(org.refcodes.textual.Font aBannerFont)	Builder method providing the application's banner font.
AppHelper.Builder	withBannerFontPalette(char[] aBannerFontPalette)	Builder method providing the application's banner ASCII palette.
AppHelper.Builder	withBannerFontPalette(org.refcodes.data.AsciiColorPalette aBannerFontPalette)	Builder method providing the application's banner ASCII palette.
AppHelper.Builder	withConfigLocator(org.refcodes.runtime.ConfigLocator aConfigLocator)	Builder method providing the ConfigLocator when doing a lookup of the configuration file.
AppHelper.Builder	withCopyrightNote(String aCopyrightNote)	Builder method providing the application's copyright.
AppHelper.Builder	withDefaultConfig(String aDefaultConfig)	Builder method providing the application's configuration file path.
AppHelper.Builder	withDescription(String aDescription)	Builder method providing the application's description property.
AppHelper.Builder	withExamples(Collection<org.refcodes.cli.Example> aExamples)	Builder method providing the application's Example elements.
AppHelper.Builder	withExamples(org.refcodes.cli.Example[] aExamples)	Builder method providing the application's Example elements.
AppHelper.Builder	withLicenseNote(String aLicenseNote)	Builder method providing the application's license.
AppHelper.Builder	withLogger(org.refcodes.logger.RuntimeLogger aLogger)	Builder method providing the application's RuntimeLogger.
AppHelper.Builder	withName(String aAppName)	Builder method providing the application's name property.
AppHelper.Builder	withPasswordPrompt(String aPasswordPrompt)	Builder method providing the application's default password prompt.
AppHelper.Builder	withResourceLocator(Class<?> aResourceLocator)	Builder method providing the Class when doing a lookup of a (module specific) resource.
AppHelper.Builder	withShutDownHook(Consumer<Integer> aShutDownHook)	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).
AppHelper.Builder	withSyntaxNotation(org.refcodes.cli.SyntaxNotation aSyntaxNotation)	Builder method setting the SyntaxNotation.
AppHelper.Builder	withTitle(String aTitle)	Builder method providing the application's description property.
AppHelper.Builder	withVerboseFallback(boolean aVerboseFallback)	Builder method providing the application's verbose fallback property.

Methods inherited from class org.refcodes.archetype.CliHelper.Builder

withArgs, withArgs, withArgs, withArgs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

addExampleUsage

public AppHelper.Builder addExampleUsage(org.refcodes.cli.Example aExamples)

Builder method adding an application's Example element.

Overrides:

addExampleUsage in class CliHelper.Builder

Parameters:

aExamples - The application's Example element to be added.

Returns:

This AppHelper.Builder as of the builder pattern.

addExampleUsage

public AppHelper.Builder addExampleUsage(String aDescription,
 org.refcodes.cli.Operand<?>... aOperands)

Builder method adding an application's Example element.

Overrides:

addExampleUsage in class CliHelper.Builder

Parameters:

aDescription - The example's description.

aOperands - The command line arguments required by the example.

Returns:

This AppHelper.Builder as of the builder pattern.

withName

public AppHelper.Builder withName(String aAppName)

Builder method providing the application's name property.

Overrides:

withName in class CliHelper.Builder

Parameters:

aAppName - The application's name.

Returns:

This AppHelper.Builder as of the builder pattern.

withPasswordPrompt

public AppHelper.Builder withPasswordPrompt(String aPasswordPrompt)

Builder method providing the application's default password prompt.

Overrides:

withPasswordPrompt in class CliHelper.Builder

Parameters:

aPasswordPrompt - The application's default password prompt.

Returns:

This AppHelper.Builder as of the builder pattern.

withConfigLocator

public AppHelper.Builder withConfigLocator(org.refcodes.runtime.ConfigLocator aConfigLocator)

Builder method providing the ConfigLocator when doing a lookup of the configuration file.

Overrides:

withConfigLocator in class CliHelper.Builder

Parameters:

aConfigLocator - The application's ConfigLocator.

Returns:

This AppHelper.Builder as of the builder pattern.

withResourceLocator

public AppHelper.Builder withResourceLocator(Class<?> aResourceLocator)

Builder method providing the Class when doing a lookup of a (module specific) resource.

Overrides:

withResourceLocator in class CliHelper.Builder

Parameters:

aResourceLocator - The application's Class which to use when loading resources (of the according module) by invoking Class.getResourceAsStream(String).

Returns:

This AppHelper.Builder as of the builder pattern.

withSyntaxNotation

public AppHelper.Builder withSyntaxNotation(org.refcodes.cli.SyntaxNotation aSyntaxNotation)

Builder method setting the SyntaxNotation.

Overrides:

withSyntaxNotation in class CliHelper.Builder

Parameters:

aSyntaxNotation - The SyntaxNotation to use.

Returns:

This AppHelper.Builder as of the builder pattern.

withArgs

public AppHelper.Builder withArgs(String[] aArgs)

Builder method providing the application's command line arguments.

Overrides:

withArgs in class CliHelper.Builder

Parameters:

aArgs - The application's command line arguments.

Returns:

This AppHelper.Builder as of the builder pattern.

withArgs

public AppHelper.Builder withArgs(List<String> aArgs)

Builder method providing the application's command line arguments.

Overrides:

withArgs in class CliHelper.Builder

Parameters:

aArgs - The application's command line arguments.

Returns:

This AppHelper.Builder as of the builder pattern.

withArgsSyntax

public AppHelper.Builder withArgsSyntax(org.refcodes.cli.Constituent aArgsSyntax)

Builder method providing the application's command line syntax.

Overrides:

withArgsSyntax in class CliHelper.Builder

Parameters:

aArgsSyntax - The application's command line syntax.

Returns:

This AppHelper.Builder as of the builder pattern.

withBannerFont

public AppHelper.Builder withBannerFont(org.refcodes.textual.Font aBannerFont)

Builder method providing the application's banner font.

Overrides:

withBannerFont in class CliHelper.Builder

Parameters:

aBannerFont - The application's banner font.

Returns:

This AppHelper.Builder as of the builder pattern.

withBannerFontPalette

public AppHelper.Builder withBannerFontPalette(org.refcodes.data.AsciiColorPalette aBannerFontPalette)

Builder method providing the application's banner ASCII palette.

Overrides:

withBannerFontPalette in class CliHelper.Builder

Parameters:

aBannerFontPalette - The application's banner ASCII palette.

Returns:

This AppHelper.Builder as of the builder pattern.

withBannerFontPalette

public AppHelper.Builder withBannerFontPalette(char[] aBannerFontPalette)

Builder method providing the application's banner ASCII palette.

Overrides:

withBannerFontPalette in class CliHelper.Builder

Parameters:

aBannerFontPalette - The application's banner ASCII palette.

Returns:

This AppHelper.Builder as of the builder pattern.

withDefaultConfig

public AppHelper.Builder withDefaultConfig(String aDefaultConfig)

Builder method providing the application's configuration file path.

Overrides:

withDefaultConfig in class CliHelper.Builder

Parameters:

aDefaultConfig - The application's configuration file path.

Returns:

This AppHelper.Builder as of the builder pattern.

withCopyrightNote

public AppHelper.Builder withCopyrightNote(String aCopyrightNote)

Builder method providing the application's copyright.

Overrides:

withCopyrightNote in class CliHelper.Builder

Parameters:

aCopyrightNote - The application's copyright.

Returns:

This AppHelper.Builder as of the builder pattern.

withDescription

public AppHelper.Builder withDescription(String aDescription)

Builder method providing the application's description property.

Overrides:

withDescription in class CliHelper.Builder

Parameters:

aDescription - The application's description.

Returns:

This AppHelper.Builder as of the builder pattern.

withExamples

public AppHelper.Builder withExamples(Collection<org.refcodes.cli.Example> aExamples)

Builder method providing the application's Example elements.

Overrides:

withExamples in class CliHelper.Builder

Parameters:

aExamples - The application's Example elements to use.

Returns:

This AppHelper.Builder as of the builder pattern.

withExamples

public AppHelper.Builder withExamples(org.refcodes.cli.Example[] aExamples)

Builder method providing the application's Example elements.

Overrides:

withExamples in class CliHelper.Builder

Parameters:

aExamples - The application's Example.

Returns:

This AppHelper.Builder as of the builder pattern.

withLicenseNote

public AppHelper.Builder withLicenseNote(String aLicenseNote)

Builder method providing the application's license.

Overrides:

withLicenseNote in class CliHelper.Builder

Parameters:

aLicenseNote - The application's license.

Returns:

This AppHelper.Builder as of the builder pattern.

withLogger

public AppHelper.Builder withLogger(org.refcodes.logger.RuntimeLogger aLogger)

Builder method providing the application's RuntimeLogger.

Overrides:

withLogger in class CliHelper.Builder

Parameters:

aLogger - The application's RuntimeLogger.

Returns:

This AppHelper.Builder as of the builder pattern.

withShutDownHook

public AppHelper.Builder withShutDownHook(Consumer<Integer> aShutDownHook)

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

Overrides:

withShutDownHook in class CliHelper.Builder

Parameters:

aShutDownHook - The (optional) shutdown hook.

Returns:

This AppHelper.Builder as of the builder pattern.

withTitle

public AppHelper.Builder withTitle(String aTitle)

Builder method providing the application's description property.

Overrides:

withTitle in class CliHelper.Builder

Parameters:

aTitle - The application's title (used when printing the banner).

Returns:

This AppHelper.Builder as of the builder pattern.

withVerboseFallback

public AppHelper.Builder withVerboseFallback(boolean aVerboseFallback)

Builder method providing the application's verbose fallback property. In case no VerboseFlag neither QuietFlag parsers are present and no "verbose" neither "quiet" value are found in the properties, then this value is used as a fallback, either to be "more verbose" (true) or "more quiet" (false).

Overrides:

withVerboseFallback in class CliHelper.Builder

Parameters:

aVerboseFallback - The fallback verbose mode if the verbose mode cannot be determined otherwise.

Returns:

This AppHelper.Builder as of the builder pattern.

build

public AppHelper build()

Creates a new CliHelper using the configured properties.

Overrides:

build in class CliHelper.Builder

Returns:

The accordingly configured CliHelper.