com.github.rvesse.airline.help

Interface GlobalUsageGenerator<T>

All Known Implementing Classes:

AbstractGlobalUsageGenerator, AbstractPrintedGlobalUsageGenerator, CliGlobalUsageGenerator, CliGlobalUsageSummaryGenerator

public interface GlobalUsageGenerator<T>

Interface implemented by classes that can generate usage documentation for a command line interface

Method Summary

Modifier and Type	Method and Description
void	usage(GlobalMetadata<T> global) Generate the help and output it on standard out
void	usage(GlobalMetadata<T> global, OutputStream output) Generate the help and output it to the stream

Method Detail

usage

void usage(GlobalMetadata<T> global)
    throws IOException

Generate the help and output it on standard out

Parameters:

global - Global Metadata

Throws:

IOException - Thrown if there is a problem generating usage output

usage

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

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