com.github.rvesse.airline.help.cli

Class CliUsageHelper

java.lang.Object

com.github.rvesse.airline.help.common.AbstractUsageGenerator

com.github.rvesse.airline.help.cli.CliUsageHelper

public class CliUsageHelper
extends AbstractUsageGenerator

Field Summary

Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor and Description
CliUsageHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)

Method Summary

Modifier and Type	Method and Description
static int	calculateMaxRows(HelpHint hint)
<T> void	outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
protected void	outputArgumentsRestriction(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an option
void	outputHelpSection(UsagePrinter out, HelpSection section) Outputs a help section
protected void	outputHint(UsagePrinter out, HelpHint hint, boolean newPara)
protected void	outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint) Outputs documentation about a restriction on an option
void	outputOptions(UsagePrinter out, List<OptionMetadata> options)

Methods inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator

getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage

Methods inherited from class java.lang.Object

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

Constructor Detail

CliUsageHelper

public CliUsageHelper(Comparator<? super OptionMetadata> optionComparator,
                      boolean includeHidden)

Method Detail

outputOptions

public void outputOptions(UsagePrinter out,
                          List<OptionMetadata> options)
                   throws IOException

Throws:

IOException

outputOptionRestriction

protected void outputOptionRestriction(UsagePrinter out,
                                       OptionMetadata option,
                                       OptionRestriction restriction,
                                       HelpHint hint)
                                throws IOException

Outputs documentation about a restriction on an option

Parameters:

out - Usage printer

option - Option meta-data

restriction - Restriction

hint - Help hint

Throws:

IOException

outputHint

protected void outputHint(UsagePrinter out,
                          HelpHint hint,
                          boolean newPara)
                   throws IOException

Throws:

IOException

calculateMaxRows

public static int calculateMaxRows(HelpHint hint)

outputArguments

public <T> void outputArguments(UsagePrinter out,
                                ArgumentsMetadata arguments,
                                ParserMetadata<T> parserConfig)
                         throws IOException

Throws:

IOException

outputArgumentsRestriction

protected void outputArgumentsRestriction(UsagePrinter descriptionPrinter,
                                          ArgumentsMetadata arguments,
                                          ArgumentsRestriction restriction,
                                          HelpHint hint)
                                   throws IOException

Outputs documentation about a restriction on an option

Parameters:

descriptionPrinter - Description printer

arguments - Arguments meta-data

restriction - Restriction

hint - Help hint

Throws:

IOException

outputHelpSection

public void outputHelpSection(UsagePrinter out,
                              HelpSection section)
                       throws IOException

Outputs a help section

Parameters:

out - Usage printer

section - Help section

Throws:

IOException