Module com.github.rvesse.airline
Class AbstractUsageGenerator
java.lang.Object
com.github.rvesse.airline.help.common.AbstractUsageGenerator
- Direct Known Subclasses:
AbstractCommandGroupUsageGenerator
,AbstractCommandUsageGenerator
,AbstractGlobalUsageGenerator
,CliUsageHelper
,ManUsageHelper
,MarkdownUsageHelper
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Comparator
<? super CommandMetadata> static final int
private final Comparator
<? super HelpHint> private final boolean
private final Comparator
<? super OptionMetadata> -
Constructor Summary
ConstructorsConstructorDescriptionAbstractUsageGenerator
(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden) -
Method Summary
Modifier and TypeMethodDescriptionprotected final Comparator
<? super CommandMetadata> protected final Comparator
<? super OptionMetadata> protected final String
HTMLizes a string i.e.protected boolean
Gets whether hidden commands and options should be included in the outputsortArgumentsRestrictions
(List<ArgumentsRestriction> restrictions) protected List
<CommandMetadata> sortCommands
(List<CommandMetadata> commands) Sorts the commands assuming a non-null comparator was provided at instantiation timesortOptionRestrictions
(List<OptionRestriction> restrictions) protected List
<OptionMetadata> sortOptions
(List<OptionMetadata> options) Sorts the options assuming a non-null comparator was provided at instantiation timeprotected String
toDefaultCommand
(String command) Converts a command into the default command representation for the usage documentationprotected String
toDescription
(ArgumentsMetadata arguments) protected String
toDescription
(OptionMetadata option) toSynopsisUsage
(List<OptionMetadata> options) Converts the options into their synopsis representation for the usage documentationprotected String
toUsage
(ArgumentsMetadata arguments) protected String
toUsage
(OptionMetadata option)
-
Field Details
-
DEFAULT_COLUMNS
public static final int DEFAULT_COLUMNS- See Also:
-
hintComparator
-
optionComparator
-
commandComparator
-
includeHidden
private final boolean includeHidden
-
-
Constructor Details
-
AbstractUsageGenerator
public AbstractUsageGenerator() -
AbstractUsageGenerator
public AbstractUsageGenerator(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
-
-
Method Details
-
includeHidden
protected boolean includeHidden()Gets whether hidden commands and options should be included in the output- Returns:
- True if hidden commands/options should be included
-
getOptionComparator
-
getCommandComparator
-
sortOptions
Sorts the options assuming a non-null comparator was provided at instantiation time- Parameters:
options
- Options- Returns:
- Sorted options
-
sortOptionRestrictions
-
sortArgumentsRestrictions
-
sortCommands
Sorts the commands assuming a non-null comparator was provided at instantiation time- Parameters:
commands
- Commands- Returns:
- Sorted commands
-
htmlize
HTMLizes a string i.e. escapes HTML special characters into HTML entities and new lines into HTML line breaks- Parameters:
value
- String to HTMLize- Returns:
- HTMLized string
-
toDefaultCommand
Converts a command into the default command representation for the usage documentation- Parameters:
command
- Default command name- Returns:
- Command representation
-
toSynopsisUsage
Converts the options into their synopsis representation for the usage documentation- Parameters:
options
- Options- Returns:
- Option synopses
-
toUsage
-
toUsage
-
toDescription
-
toDescription
-