Module com.github.rvesse.airline
Package com.github.rvesse.airline.help
Interface CommandGroupUsageGenerator<T>
-
- All Known Implementing Classes:
AbstractCommandGroupUsageGenerator
,AbstractPrintedCommandGroupUsageGenerator
,CliCommandGroupUsageGenerator
public interface CommandGroupUsageGenerator<T>
Interface implemented by classes that can generate usage documentation for a command group
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups)
Generate the help and output it on standard outvoid
usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, java.io.OutputStream output)
Generate the help and output it to the stream
-
-
-
Method Detail
-
usage
void usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups) throws java.io.IOException
Generate the help and output it on standard out- Parameters:
global
- Global Metadatagroups
- Group path to the command- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
usage
void usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, java.io.OutputStream output) throws java.io.IOException
Generate the help and output it to the stream- Parameters:
global
- Global metadatagroups
- Group path to the commandoutput
- Stream to output to- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
-