Package ml.options
Interface HelpPrinter
-
- All Known Implementing Classes:
DefaultHelpPrinter
public interface HelpPrinter
This interface is supposed to be implemented by all classes providing help printing capabilities.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCommandLine(OptionSet set, java.lang.String leadingText, boolean lineBreak)
Return a string with the command line syntax for this option setjava.lang.String
getHelpText(OptionSet set)
Return the help text describing the different options and data arguments
-
-
-
Method Detail
-
getCommandLine
java.lang.String getCommandLine(OptionSet set, java.lang.String leadingText, boolean lineBreak)
Return a string with the command line syntax for this option set- Parameters:
set
- TheOptionSet
to format the output forleadingText
- The text to precede the command linelineBreak
- A boolean indicating whether the command line for the option set should be printed with line breaks after each option or not- Returns:
- A string with the command line syntax for this option set
-
-