Modifier and Type | Field and Description |
---|---|
static Comparator<HelpHint> |
UsageHelper.DEFAULT_HINT_COMPARATOR
Default comparator for help hints
|
Modifier and Type | Method and Description |
---|---|
static int |
CliUsageHelper.calculateMaxRows(HelpHint hint) |
protected void |
CliUsageHelper.outputArgumentsRestriction(UsagePrinter descriptionPrinter,
ArgumentsMetadata arguments,
ArgumentsRestriction restriction,
HelpHint hint)
Outputs documentation about a restriction on an option
|
protected void |
CliUsageHelper.outputHint(UsagePrinter out,
HelpHint hint,
boolean newPara) |
protected void |
CliUsageHelper.outputOptionRestriction(UsagePrinter out,
OptionMetadata option,
OptionRestriction restriction,
HelpHint hint)
Outputs documentation about a restriction on an option
|
Constructor and Description |
---|
CliCommandGroupUsageGenerator(int columns,
boolean hideGlobalOptions,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
CliGlobalUsageGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
CliGlobalUsageSummaryGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
protected List<HelpHint> |
AbstractUsageGenerator.sortArgumentsRestrictions(List<ArgumentsRestriction> restrictions) |
protected List<HelpHint> |
AbstractUsageGenerator.sortOptionRestrictions(List<OptionRestriction> restrictions) |
Constructor and Description |
---|
AbstractCommandGroupUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
AbstractCommandUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super Map.Entry<Integer,String>> exitCodeComparator,
boolean includeHidden) |
AbstractGlobalUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
AbstractPrintedCommandGroupUsageGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
AbstractPrintedGlobalUsageGenerator(int columns,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
AbstractUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
Modifier and Type | Interface and Description |
---|---|
interface |
HelpSection
Interface for classes that represents additional help sections
|
Modifier and Type | Class and Description |
---|---|
class |
BasicHint |
class |
BasicSection |
class |
DiscussionSection |
class |
ExamplesSection |
class |
ExitCodesSection |
class |
ProseSection |
class |
VersionSection |
Modifier and Type | Class and Description |
---|---|
class |
AbstractAllowedValuesRestriction |
class |
AllowedRawValuesRestriction |
class |
AllowedValuesRestriction |
class |
LengthRestriction
A restriction that requires string values
|
class |
NotBlankRestriction |
class |
NotEmptyRestriction |
class |
OccurrencesRestriction |
class |
PartialRestriction |
class |
PathRestriction
Implements restriction on options and arguments that expect to receive a path
to a file and/or directory
|
class |
PatternRestriction
A restriction which requires the raw values to match a given regular
expression
|
class |
PortRestriction |
class |
RangeRestriction
A restriction that requires the value (after type conversion) to be within a
given range
|
Modifier and Type | Class and Description |
---|---|
class |
MutuallyExclusiveRestriction |
class |
RequiredOnlyIfRestriction |
class |
RequireFromRestriction |
Copyright © 2012–2017. All rights reserved.