Module com.github.rvesse.airline

Package com.github.rvesse.airline.help.cli

Class CliGlobalUsageSummaryGenerator<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.CliGlobalUsageSummaryGenerator<T>

All Implemented Interfaces:

GlobalUsageGenerator<T>

public class CliGlobalUsageSummaryGenerator<T>
extends AbstractPrintedGlobalUsageGenerator<T>

Field Summary

Fields

Modifier and Type	Field	Description
private final CliUsageHelper	helper

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

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
CliGlobalUsageSummaryGenerator()
CliGlobalUsageSummaryGenerator(boolean includeHidden)
CliGlobalUsageSummaryGenerator(int columnSize)
CliGlobalUsageSummaryGenerator(int columnSize, boolean includeHidden)
CliGlobalUsageSummaryGenerator(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	Description
protected CliUsageHelper	createHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected void	outputCommandList(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section listing the common commands and groups
protected void	outputFooter(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section detailing how to get more help
protected void	outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section with a brief synopsis of usage
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

Field Details

helper

private final CliUsageHelper helper

Constructor Details

CliGlobalUsageSummaryGenerator

public CliGlobalUsageSummaryGenerator()

CliGlobalUsageSummaryGenerator

public CliGlobalUsageSummaryGenerator(boolean includeHidden)

CliGlobalUsageSummaryGenerator

public CliGlobalUsageSummaryGenerator(int columnSize)

CliGlobalUsageSummaryGenerator

public CliGlobalUsageSummaryGenerator(int columnSize,
 boolean includeHidden)

CliGlobalUsageSummaryGenerator

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

Method Details

createHelper

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

usage

public 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

outputFooter

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

Outputs a documentation section detailing how to get more help

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException

outputCommandList

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

Outputs a documentation section listing the common commands and groups

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException

outputSynopsis

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

Outputs a documentation section with a brief synopsis of usage

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException