Top Description Constructors Methods
com.beust.jcommander

public Class UnixStyleUsageFormatter

extends DefaultUsageFormatter
Class Inheritance
Imports
java.util.EnumSet, .List
A unix-style usage formatter. This works by overriding and modifying the output of appendAllParametersDetails(StringBuilder, int, String, List) which is inherited from DefaultUsageFormatter.

Constructor Summary

AccessConstructor and Description
public
UnixStyleUsageFormatter(JCommander commander)

Method Summary

Modifier and TypeMethod and Description
public void
appendAllParametersDetails(StringBuilder
the builder to append to
out, int
the amount of indentation to apply
indentCount, String
the indentation
indent, List<ParameterDescription>
the parameters to append to the builder
sortedParameters)

Overrides com.beust.jcommander.DefaultUsageFormatter.appendAllParametersDetails.

Appends the details of all parameters in the given order to the argument string builder, indenting every line with indentCount-many indent.
Inherited from com.beust.jcommander.DefaultUsageFormatter:
appendCommandsappendMainLinegetCommandDescriptiongetI18nStringsusageusageusageusageusagewrapDescriptionwrapDescription

Constructor Detail

UnixStyleUsageFormatterback to summary
public UnixStyleUsageFormatter(JCommander commander)

Method Detail

appendAllParametersDetailsback to summary
public void appendAllParametersDetails(StringBuilder out, int indentCount, String indent, List<ParameterDescription> sortedParameters)

Overrides com.beust.jcommander.DefaultUsageFormatter.appendAllParametersDetails.

Appends the details of all parameters in the given order to the argument string builder, indenting every line with indentCount-many indent.

Parameters
out:StringBuilder

the builder to append to

indentCount:int

the amount of indentation to apply

indent:String

the indentation

sortedParameters:List<ParameterDescription>

the parameters to append to the builder