Package com.github.hypfvieh.cli.parser.formatter

Klasse DefaultHelpFormatter

java.lang.Object

com.github.hypfvieh.cli.parser.formatter.DefaultHelpFormatter

Alle implementierten Schnittstellen:

IUsageFormatter

public class DefaultHelpFormatter
extends Object
implements IUsageFormatter

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DefaultHelpFormatter()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	format(List<CmdArgOption<?>> _options, String _longOptPrefix, String _shortOptPrefix, String _mainClassName)	Formats the given options as proper help-text.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

DefaultHelpFormatter

public DefaultHelpFormatter()

Methodendetails

format

public String format(List<CmdArgOption<?>> _options,
 String _longOptPrefix,
 String _shortOptPrefix,
 String _mainClassName)

Formats the given options as proper help-text.
Given _mainClassName is not used and can be null.

Angegeben von:

format in Schnittstelle IUsageFormatter

Parameter:

_options - registered options, maybe empty - never null

_longOptPrefix - prefix for long options

_shortOptPrefix - prefix for short options

_mainClassName - main class name, maybe null

Gibt zurück:

formatted String