Module com.github.rvesse.airline

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

Class CliCommandGroupUsageGenerator<T>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

CommandGroupUsageGenerator<T>

public class CliCommandGroupUsageGenerator<T>
extends AbstractPrintedCommandGroupUsageGenerator<T>

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	hideGlobalOptions

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

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
CliCommandGroupUsageGenerator()
CliCommandGroupUsageGenerator(boolean includeHidden)
CliCommandGroupUsageGenerator(int columns)
CliCommandGroupUsageGenerator(int columns, boolean includeHidden)
CliCommandGroupUsageGenerator(int columns, boolean hideGlobalOptions, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)

Method Summary

Modifier and Type	Method	Description
protected void	outputDescription(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a description of the group
protected void	outputOptions(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a documentation section detailing the available options and their usages
protected void	outputSynopsis(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a documentation section detailing a usage synopsis
protected void	usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out)	Generate the help and output is using the provided UsagePrinter

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

createUsagePrinter, usage

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

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 Detail

hideGlobalOptions

private final boolean hideGlobalOptions

Constructor Detail

CliCommandGroupUsageGenerator

public CliCommandGroupUsageGenerator()

CliCommandGroupUsageGenerator

public CliCommandGroupUsageGenerator(boolean includeHidden)

CliCommandGroupUsageGenerator

public CliCommandGroupUsageGenerator(int columns)

CliCommandGroupUsageGenerator

public CliCommandGroupUsageGenerator(int columns,
                                     boolean includeHidden)

CliCommandGroupUsageGenerator

public CliCommandGroupUsageGenerator(int columns,
                                     boolean hideGlobalOptions,
                                     java.util.Comparator<? super HelpHint> hintComparator,
                                     java.util.Comparator<? super OptionMetadata> optionComparator,
                                     java.util.Comparator<? super CommandMetadata> commandComparator,
                                     boolean includeHidden)

Method Detail

usage

protected void usage(GlobalMetadata<T> global,
                     CommandGroupMetadata[] groups,
                     UsagePrinter out)
              throws java.io.IOException

Description copied from class: AbstractPrintedCommandGroupUsageGenerator

Generate the help and output is using the provided UsagePrinter

Specified by:

usage in class AbstractPrintedCommandGroupUsageGenerator<T>

Parameters:

global - Global Metadata

groups - Groups Metadata

out - Usage printer to output with

Throws:

java.io.IOException - Thrown if there is a problem generating usage output

outputOptions

protected void outputOptions(UsagePrinter out,
                             GlobalMetadata<T> global,
                             CommandGroupMetadata[] groups)
                      throws java.io.IOException

Outputs a documentation section detailing the available options and their usages

Parameters:

out - Usage printer

global - Global meta-data

groups - Group(s) meta-data

Throws:

java.io.IOException - Thrown if there is a problem generating usage output

outputSynopsis

protected void outputSynopsis(UsagePrinter out,
                              GlobalMetadata<T> global,
                              CommandGroupMetadata[] groups)
                       throws java.io.IOException

Outputs a documentation section detailing a usage synopsis

Parameters:

out - Usage printer

global - Global meta-data

groups - Groups meta-data

Throws:

java.io.IOException - Thrown if there is a problem generating usage output

outputDescription

protected void outputDescription(UsagePrinter out,
                                 GlobalMetadata<T> global,
                                 CommandGroupMetadata[] groups)
                          throws java.io.IOException

Outputs a description of the group

Parameters:

out - Usage printer

global - Global meta-data

groups - Groups meta-data

Throws:

java.io.IOException - Thrown if there is a problem generating usage output