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
public class AbstractUsageGenerator extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Comparator<? super CommandMetadata>
commandComparator
static int
DEFAULT_COLUMNS
private java.util.Comparator<? super HelpHint>
hintComparator
private boolean
includeHidden
private java.util.Comparator<? super OptionMetadata>
optionComparator
-
Constructor Summary
Constructors Constructor Description AbstractUsageGenerator()
AbstractUsageGenerator(java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.Comparator<? super CommandMetadata>
getCommandComparator()
protected java.util.Comparator<? super OptionMetadata>
getOptionComparator()
protected java.lang.String
htmlize(java.lang.String value)
HTMLizes a string i.e.protected boolean
includeHidden()
Gets whether hidden commands and options should be included in the outputprotected java.util.List<HelpHint>
sortArgumentsRestrictions(java.util.List<ArgumentsRestriction> restrictions)
protected java.util.List<CommandMetadata>
sortCommands(java.util.List<CommandMetadata> commands)
Sorts the commands assuming a non-null comparator was provided at instantiation timeprotected java.util.List<HelpHint>
sortOptionRestrictions(java.util.List<OptionRestriction> restrictions)
protected java.util.List<OptionMetadata>
sortOptions(java.util.List<OptionMetadata> options)
Sorts the options assuming a non-null comparator was provided at instantiation timeprotected java.lang.String
toDefaultCommand(java.lang.String command)
Converts a command into the default command representation for the usage documentationprotected java.lang.String
toDescription(ArgumentsMetadata arguments)
protected java.lang.String
toDescription(OptionMetadata option)
protected java.util.List<java.lang.String>
toSynopsisUsage(java.util.List<OptionMetadata> options)
Converts the options into their synopsis representation for the usage documentationprotected java.lang.String
toUsage(ArgumentsMetadata arguments)
protected java.lang.String
toUsage(OptionMetadata option)
-
-
-
Field Detail
-
DEFAULT_COLUMNS
public static final int DEFAULT_COLUMNS
- See Also:
- Constant Field Values
-
hintComparator
private final java.util.Comparator<? super HelpHint> hintComparator
-
optionComparator
private final java.util.Comparator<? super OptionMetadata> optionComparator
-
commandComparator
private final java.util.Comparator<? super CommandMetadata> commandComparator
-
includeHidden
private final boolean includeHidden
-
-
Constructor Detail
-
AbstractUsageGenerator
public AbstractUsageGenerator()
-
AbstractUsageGenerator
public AbstractUsageGenerator(java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
-
-
Method Detail
-
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
protected final java.util.Comparator<? super OptionMetadata> getOptionComparator()
-
getCommandComparator
protected final java.util.Comparator<? super CommandMetadata> getCommandComparator()
-
sortOptions
protected java.util.List<OptionMetadata> sortOptions(java.util.List<OptionMetadata> options)
Sorts the options assuming a non-null comparator was provided at instantiation time- Parameters:
options
- Options- Returns:
- Sorted options
-
sortOptionRestrictions
protected java.util.List<HelpHint> sortOptionRestrictions(java.util.List<OptionRestriction> restrictions)
-
sortArgumentsRestrictions
protected java.util.List<HelpHint> sortArgumentsRestrictions(java.util.List<ArgumentsRestriction> restrictions)
-
sortCommands
protected java.util.List<CommandMetadata> sortCommands(java.util.List<CommandMetadata> commands)
Sorts the commands assuming a non-null comparator was provided at instantiation time- Parameters:
commands
- Commands- Returns:
- Sorted commands
-
htmlize
protected final java.lang.String htmlize(java.lang.String value)
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
protected java.lang.String toDefaultCommand(java.lang.String command)
Converts a command into the default command representation for the usage documentation- Parameters:
command
- Default command name- Returns:
- Command representation
-
toSynopsisUsage
protected java.util.List<java.lang.String> toSynopsisUsage(java.util.List<OptionMetadata> options)
Converts the options into their synopsis representation for the usage documentation- Parameters:
options
- Options- Returns:
- Option synopses
-
toUsage
protected java.lang.String toUsage(ArgumentsMetadata arguments)
-
toUsage
protected java.lang.String toUsage(OptionMetadata option)
-
toDescription
protected java.lang.String toDescription(ArgumentsMetadata arguments)
-
toDescription
protected java.lang.String toDescription(OptionMetadata option)
-
-