Module com.github.rvesse.airline
Package com.github.rvesse.airline.help
Interface GlobalUsageGenerator<T>
- All Known Implementing Classes:
AbstractGlobalUsageGenerator
,AbstractPrintedGlobalUsageGenerator
,BashCompletionGenerator
,CliGlobalUsageGenerator
,CliGlobalUsageSummaryGenerator
,ManGlobalUsageGenerator
,ManMultiPageGlobalUsageGenerator
,MarkdownGlobalUsageGenerator
,MarkdownMultiPageGlobalUsageGenerator
public interface GlobalUsageGenerator<T>
Interface implemented by classes that can generate usage documentation for a
command line interface
-
Method Summary
Modifier and TypeMethodDescriptionvoid
usage
(GlobalMetadata<T> global) Generate the help and output it on standard outvoid
usage
(GlobalMetadata<T> global, OutputStream output) Generate the help and output it to the stream
-
Method Details
-
usage
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
Generate the help and output it to the stream- Parameters:
global
- Global metadataoutput
- Stream to output to- Throws:
IOException
- Thrown if there is a problem generating usage output
-