Module com.github.rvesse.airline.help.bash

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

Class BashCompletionGenerator<T>

java.lang.Object

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

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

com.github.rvesse.airline.help.cli.bash.BashCompletionGenerator<T>

All Implemented Interfaces:

GlobalUsageGenerator<T>

public class BashCompletionGenerator<T>
extends AbstractGlobalUsageGenerator<T>

Field Summary

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

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
BashCompletionGenerator()
BashCompletionGenerator(boolean includeHidden, boolean enableDebugging)	Creates a new completion generator

Method Summary

Modifier and Type	Method	Description
protected BashCompletion	getCompletionData(ArgumentsMetadata arguments)	Gets the completion info for arguments
protected BashCompletion	getCompletionData(OptionMetadata option)	Gets the completion info for an option
protected BashCompletion	getCompletionData(Collection<Accessor> accessors)
void	usage(GlobalMetadata<T> global, OutputStream output)	Generate the help and output it to the stream

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 Details

BashCompletionGenerator

public BashCompletionGenerator()

BashCompletionGenerator

public BashCompletionGenerator(boolean includeHidden,
 boolean enableDebugging)

Creates a new completion generator

Parameters:

enableDebugging - Whether to enable debugging, when true the generated script will do set -o xtrace in its functions and set +o xtrace at the end of its functions

Method Details

usage

public void usage(GlobalMetadata<T> global,
 OutputStream output)
           throws IOException

Description copied from interface: GlobalUsageGenerator

Generate the help and output it to the stream

Parameters:

global - Global metadata

output - Stream to output to

Throws:

IOException - Thrown if there is a problem generating usage output

getCompletionData

protected BashCompletion getCompletionData(OptionMetadata option)

Gets the completion info for an option

Parameters:

option - Option

Returns:

Completion data, null if none specified

getCompletionData

protected BashCompletion getCompletionData(ArgumentsMetadata arguments)

Gets the completion info for arguments

Parameters:

arguments - Arguments

Returns:

Completion data, null if none specified

getCompletionData

protected BashCompletion getCompletionData(Collection<Accessor> accessors)