com.github.rvesse.airline.help.cli

Class CliGlobalUsageGenerator<T>

java.lang.Object

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

com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator<T>

com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator<T>

com.github.rvesse.airline.help.cli.CliGlobalUsageGenerator<T>

All Implemented Interfaces:

GlobalUsageGenerator<T>

public class CliGlobalUsageGenerator<T>
extends AbstractPrintedGlobalUsageGenerator<T>

Field Summary

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

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor and Description
CliGlobalUsageGenerator()
CliGlobalUsageGenerator(boolean includeHidden)
CliGlobalUsageGenerator(int columns)
CliGlobalUsageGenerator(int columns, boolean includeHidden)
CliGlobalUsageGenerator(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)

Method Summary

Modifier and Type	Method and Description
protected CliUsageHelper	createHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected void	outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command) Outputs the description for a command
protected void	outputCommandList(UsagePrinter out, GlobalMetadata<T> global) Outputs a documentation section listing the commands
protected void	outputDescription(UsagePrinter out, GlobalMetadata<T> global) Outputs a documentation section with a description of the CLI
protected void	outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, List<CommandGroupMetadata> groups)
protected void	outputSynopsis(UsagePrinter out, GlobalMetadata<T> global) Outputs a documentation section with a synopsis of CLI usage
protected void	outputUserAliases(UsagePrinter out, GlobalMetadata<T> global, UserAliasesSource<T> userAliases)
protected void	usage(GlobalMetadata<T> global, UsagePrinter out) Generate the help and output is using the provided UsagePrinter

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

createUsagePrinter, usage

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

findHelpSections, sortCommandGroups, 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

CliGlobalUsageGenerator

public CliGlobalUsageGenerator()

CliGlobalUsageGenerator

public CliGlobalUsageGenerator(boolean includeHidden)

CliGlobalUsageGenerator

public CliGlobalUsageGenerator(int columns)

CliGlobalUsageGenerator

public CliGlobalUsageGenerator(int columns,
                               boolean includeHidden)

CliGlobalUsageGenerator

public CliGlobalUsageGenerator(int columnSize,
                               Comparator<? super HelpHint> hintComparator,
                               Comparator<? super OptionMetadata> optionComparator,
                               Comparator<? super CommandMetadata> commandComparator,
                               Comparator<? super CommandGroupMetadata> commandGroupComparator,
                               boolean includeHidden)

Method Detail

createHelper

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

usage

protected void usage(GlobalMetadata<T> global,
                     UsagePrinter out)
              throws IOException

Description copied from class: AbstractPrintedGlobalUsageGenerator

Generate the help and output is using the provided UsagePrinter

Specified by:

usage in class AbstractPrintedGlobalUsageGenerator<T>

Parameters:

global - Global Metadata

out - Usage printer to output with

Throws:

IOException - Thrown if there is a problem generating usage output

outputCommandList

protected void outputCommandList(UsagePrinter out,
                                 GlobalMetadata<T> global)
                          throws IOException

Outputs a documentation section listing the commands

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputGroupCommandsList

protected void outputGroupCommandsList(UsagePrinter out,
                                       GlobalMetadata<T> global,
                                       List<CommandGroupMetadata> groups)
                                throws IOException

Throws:

IOException

outputSynopsis

protected void outputSynopsis(UsagePrinter out,
                              GlobalMetadata<T> global)
                       throws IOException

Outputs a documentation section with a synopsis of CLI usage

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputDescription

protected void outputDescription(UsagePrinter out,
                                 GlobalMetadata<T> global)
                          throws IOException

Outputs a documentation section with a description of the CLI

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputCommandDescription

protected void outputCommandDescription(UsagePrinter out,
                                        CommandGroupMetadata group,
                                        CommandMetadata command)
                                 throws IOException

Outputs the description for a command

Parameters:

out - Usage printer

group - Group meta-data

command - Command meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputUserAliases

protected void outputUserAliases(UsagePrinter out,
                                 GlobalMetadata<T> global,
                                 UserAliasesSource<T> userAliases)
                          throws IOException

Throws:

IOException