com.github.rvesse.airline.help.cli

Class CliCommandUsageGenerator

java.lang.Object

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

com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator

com.github.rvesse.airline.help.common.AbstractPrintedCommandUsageGenerator

com.github.rvesse.airline.help.cli.CliCommandUsageGenerator

All Implemented Interfaces:

CommandUsageGenerator

public class CliCommandUsageGenerator
extends AbstractPrintedCommandUsageGenerator

Field Summary

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

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor and Description
CliCommandUsageGenerator()
CliCommandUsageGenerator(boolean includeHidden)
CliCommandUsageGenerator(int columns)
CliCommandUsageGenerator(int columns, boolean includeHidden)
CliCommandUsageGenerator(int columns, Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)

Method Summary

Modifier and Type	Method and Description
protected CliUsageHelper	createHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected void	outputDescription(UsagePrinter out, String programName, String[] groupNames, String commandName, CommandMetadata command) Outputs a documentation section describing the command
protected <T> void	outputOptionsAndArguments(UsagePrinter out, CommandMetadata command, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) Outputs a documentation section detailing options and their usages
protected List<OptionMetadata>	outputSynopsis(UsagePrinter out, String programName, String[] groupNames, String commandName, CommandMetadata command) Outputs a documentation section with a synopsis of command usage
<T> void	usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out) Generate the help and output it using the provided UsagePrinter

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

createUsagePrinter, usage

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

findHelpSections, sortExitCodes, usage, usage

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

CliCommandUsageGenerator

public CliCommandUsageGenerator()

CliCommandUsageGenerator

public CliCommandUsageGenerator(boolean includeHidden)

CliCommandUsageGenerator

public CliCommandUsageGenerator(int columns)

CliCommandUsageGenerator

public CliCommandUsageGenerator(int columns,
                                boolean includeHidden)

CliCommandUsageGenerator

public CliCommandUsageGenerator(int columns,
                                Comparator<? super OptionMetadata> optionComparator,
                                boolean includeHidden)

Method Detail

createHelper

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

usage

public <T> void usage(String programName,
                      String[] groupNames,
                      String commandName,
                      CommandMetadata command,
                      ParserMetadata<T> parserConfig,
                      UsagePrinter out)
               throws IOException

Description copied from class: AbstractPrintedCommandUsageGenerator

Generate the help and output it using the provided UsagePrinter

Specified by:

usage in class AbstractPrintedCommandUsageGenerator

Type Parameters:

T - Command type

Parameters:

programName - Program Name

groupNames - Group Name(s)

commandName - Command Name

command - Command Metadata

parserConfig - Parser configuration

out - Usage printer to output with

Throws:

IOException - Thrown if there is a problem generating usage output

outputOptionsAndArguments

protected <T> void outputOptionsAndArguments(UsagePrinter out,
                                             CommandMetadata command,
                                             List<OptionMetadata> options,
                                             ArgumentsMetadata arguments,
                                             ParserMetadata<T> parserConfig)
                                      throws IOException

Outputs a documentation section detailing options and their usages

Type Parameters:

T - Command type

Parameters:

out - Usage printer

command - Command meta-data

options - Options meta-data

arguments - Arguments meta-data

parserConfig - Parser configuration

Throws:

IOException - Thrown if there is a problem generating usage output

outputSynopsis

protected List<OptionMetadata> outputSynopsis(UsagePrinter out,
                                              String programName,
                                              String[] groupNames,
                                              String commandName,
                                              CommandMetadata command)
                                       throws IOException

Outputs a documentation section with a synopsis of command usage

Parameters:

out - Usage printer

programName - Program name

groupNames - Group name(s)

commandName - Command name

command - Command meta-data

Returns:

Collection of all options (Global, Group and Command)

Throws:

IOException - Thrown if there is a problem generating usage output

outputDescription

protected void outputDescription(UsagePrinter out,
                                 String programName,
                                 String[] groupNames,
                                 String commandName,
                                 CommandMetadata command)
                          throws IOException

Outputs a documentation section describing the command

Parameters:

out - Usage printer

programName - Program name

groupNames - Group name(s)

commandName - Command name

command - Command meta-data

Throws:

IOException - Thrown if there is a problem generating usage output