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

Class DefaultHelpFormatter

java.lang.Object

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

All Implemented Interfaces:

IUsageFormatter

public class DefaultHelpFormatter
extends Object
implements IUsageFormatter

Constructor Summary

Constructors

Constructor	Description
DefaultHelpFormatter()

Method Summary

Modifier and Type	Method	Description
String	format(List<CmdArgOption<?>> _options, String _longOptPrefix, String _shortOptPrefix, String _mainClassName)	Formats the given options as proper help-text.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultHelpFormatter

public DefaultHelpFormatter()

Method Details

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.

Specified by:

format in interface IUsageFormatter

Parameters:

_options - registered options, maybe empty - never null

_longOptPrefix - prefix for long options

_shortOptPrefix - prefix for short options

_mainClassName - main class name, maybe null

Returns:

formatted String