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

Klasse DefaultUsageFormatter

java.lang.Object

com.github.hypfvieh.cli.parser.formatter.DefaultUsageFormatter

Alle implementierten Schnittstellen:

IUsageFormatter

public class DefaultUsageFormatter
extends Object
implements IUsageFormatter

Default usage formatter used when no other formatter was specified

Seit:

1.0.0 - 2022-05-05

Autor:

David M., Markus S.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DefaultUsageFormatter()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	format(List<CmdArgOption<?>> _options, String _longOptPrefix, String _shortOptPrefix, String _mainClassName)	Called to retrieve a formatted usage output.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

DefaultUsageFormatter

public DefaultUsageFormatter()

Methodendetails

format

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

Beschreibung aus Schnittstelle kopiert: IUsageFormatter

Called to retrieve a formatted usage output.

Output should be properly formatted including line-feeds etc.

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