Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config.internal

Class UsageBuilder

java.lang.Object

org.tquadrat.foundation.config.internal.UsageBuilder

@ClassVersion(sourceVersion="$Id: UsageBuilder.java 1120 2024-03-16 09:48:00Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.1")
public class UsageBuilder
extends Object

Builds the usage message that will be printed to the console (or wherever) in case help is requested on the command line, or an invalid option or argument is provided on it.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: UsageBuilder.java 1120 2024-03-16 09:48:00Z tquadrat $

Since:

0.0.1

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.internal.UsageBuilder"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Optional<ResourceBundle>	m_CallerResourceBundle	The resource bundle that is used to translate the descriptions of options and arguments.
static final int	MAX_LINE_LENGTH	The maximum line length: 80.
static final String	TXT_Arguments	The Text 'Arguments'.
static final String	TXT_Options	The text 'Options'.
static final String	TXT_Usage	The text 'Usage: ' that introduces the usage text.

Constructor Summary

Constructors

Constructor	Description
UsageBuilder(Optional<ResourceBundle> callerResourceBundle)	Creates a new UsageBuilder instance.
UsageBuilder(ResourceBundle callerResourceBundle)	Creates a new UsageBuilder instance.

Method Summary

Modifier and Type	Method	Description
private void	addArguments(StringBuilder buffer, Map<String,? extends CLIArgumentDefinition> arguments)	Adds the arguments to the output.
private void	addOptions(StringBuilder buffer, Map<String,? extends CLIOptionDefinition> options)	Adds the options to the output.
final String	build(CharSequence command, Collection<? extends CLIDefinition> definitions)	Builds the usage text.
private final String	composeCommandLine(CharSequence command, Map<String,? extends CLIOptionDefinition> options, Map<String,? extends CLIArgumentDefinition> arguments)	Composes the sample command line.
private static final void	padLines(List<String> leftLines, int widthLeft, Collection<? super String> rightLines, int widthRight)	Ensures that the left and the right part have the same number of entries and that the lines have the same length.
final String	resolveMessage(Optional<ResourceBundle> bundle, CLIDefinition definition)	Returns the message from the given CLIDefinition

Methods inherited from class java.lang.Object

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

Field Details

MAX_LINE_LENGTH

public static final int MAX_LINE_LENGTH

The maximum line length: 80.

See Also:

• Constant Field Values

TXT_Arguments

public static final String TXT_Arguments

The Text 'Arguments'.

TXT_Options

public static final String TXT_Options

The text 'Options'.

TXT_Usage

public static final String TXT_Usage

The text 'Usage: ' that introduces the usage text.

m_CallerResourceBundle

private final Optional<ResourceBundle> m_CallerResourceBundle

The resource bundle that is used to translate the descriptions of options and arguments.

Constructor Details

UsageBuilder

public UsageBuilder(ResourceBundle callerResourceBundle)

Creates a new UsageBuilder instance.

Parameters:

callerResourceBundle - The resource bundle that is used to translate the descriptions of options and arguments.

UsageBuilder

public UsageBuilder(Optional<ResourceBundle> callerResourceBundle)

Creates a new UsageBuilder instance.

Parameters:

callerResourceBundle - The resource bundle that is used to translate the descriptions of options and arguments.

Method Details

addArguments

private void addArguments(StringBuilder buffer,
 Map<String,? extends CLIArgumentDefinition> arguments)

Adds the arguments to the output.

Parameters:

buffer - The buffer for the result.

arguments - The arguments.

addOptions

private void addOptions(StringBuilder buffer,
 Map<String,? extends CLIOptionDefinition> options)

Adds the options to the output.

Parameters:

buffer - The buffer for the result.

options - The options.

build

public final String build(CharSequence command,
 Collection<? extends CLIDefinition> definitions)

Builds the usage text.

Parameters:

command - The command string.

definitions - The CLI definitions.

Returns:

The usage text.

composeCommandLine

private final String composeCommandLine(CharSequence command,
 Map<String,? extends CLIOptionDefinition> options,
 Map<String,? extends CLIArgumentDefinition> arguments)

Composes the sample command line.

Parameters:

command - The command.

options - The options.

arguments - The arguments.

Returns:

The command line.

padLines

private static final void padLines(List<String> leftLines,
 int widthLeft,
 Collection<? super String> rightLines,
 int widthRight)

Ensures that the left and the right part have the same number of entries and that the lines have the same length.

Parameters:

leftLines - The lines on the left side.

widthLeft - The length for the lines on the left side.

rightLines - The lines on the right side.

widthRight - The length for the lines on the right side.

resolveMessage

public final String resolveMessage(Optional<ResourceBundle> bundle,
 CLIDefinition definition)

Returns the message from the given CLIDefinition

Parameters:

bundle - The resource bundle.

definition - The CLIDefinition.

Returns:

The resolved message.