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 Object

Field Summary

Fields

Modifier and Type	Field	Description
private final Comparator<? super CommandMetadata>	commandComparator
static final int	DEFAULT_COLUMNS
private final Comparator<? super HelpHint>	hintComparator
private final boolean	includeHidden
private final Comparator<? super OptionMetadata>	optionComparator

Constructor Summary

Constructors

Constructor	Description
AbstractUsageGenerator()
AbstractUsageGenerator(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)

Method Summary

Modifier and Type	Method	Description
protected final Comparator<? super CommandMetadata>	getCommandComparator()
protected final Comparator<? super OptionMetadata>	getOptionComparator()
protected final String	htmlize(String value)	HTMLizes a string i.e.
protected boolean	includeHidden()	Gets whether hidden commands and options should be included in the output
protected List<HelpHint>	sortArgumentsRestrictions(List<ArgumentsRestriction> restrictions)
protected List<CommandMetadata>	sortCommands(List<CommandMetadata> commands)	Sorts the commands assuming a non-null comparator was provided at instantiation time
protected List<HelpHint>	sortOptionRestrictions(List<OptionRestriction> restrictions)
protected List<OptionMetadata>	sortOptions(List<OptionMetadata> options)	Sorts the options assuming a non-null comparator was provided at instantiation time
protected String	toDefaultCommand(String command)	Converts a command into the default command representation for the usage documentation
protected String	toDescription(ArgumentsMetadata arguments)
protected String	toDescription(OptionMetadata option)
protected List<String>	toSynopsisUsage(List<OptionMetadata> options)	Converts the options into their synopsis representation for the usage documentation
protected String	toUsage(ArgumentsMetadata arguments)
protected String	toUsage(OptionMetadata option)

Methods inherited from class Object

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

Field Details

DEFAULT_COLUMNS

public static final int DEFAULT_COLUMNS

See Also:

• Constant Field Values

hintComparator

private final Comparator<? super HelpHint> hintComparator

optionComparator

private final Comparator<? super OptionMetadata> optionComparator

commandComparator

private final Comparator<? super CommandMetadata> 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

protected final Comparator<? super OptionMetadata> getOptionComparator()

getCommandComparator

protected final Comparator<? super CommandMetadata> getCommandComparator()

sortOptions

protected List<OptionMetadata> sortOptions(List<OptionMetadata> options)

Sorts the options assuming a non-null comparator was provided at instantiation time

Parameters:

options - Options

Returns:

Sorted options

sortOptionRestrictions

protected List<HelpHint> sortOptionRestrictions(List<OptionRestriction> restrictions)

sortArgumentsRestrictions

protected List<HelpHint> sortArgumentsRestrictions(List<ArgumentsRestriction> restrictions)

sortCommands

protected List<CommandMetadata> sortCommands(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 String htmlize(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 String toDefaultCommand(String command)

Converts a command into the default command representation for the usage documentation

Parameters:

command - Default command name

Returns:

Command representation

toSynopsisUsage

protected List<String> toSynopsisUsage(List<OptionMetadata> options)

Converts the options into their synopsis representation for the usage documentation

Parameters:

options - Options

Returns:

Option synopses

toUsage

protected String toUsage(ArgumentsMetadata arguments)

toUsage

protected String toUsage(OptionMetadata option)

toDescription

protected String toDescription(ArgumentsMetadata arguments)

toDescription

protected String toDescription(OptionMetadata option)