Package org.jrd.backend.data.cli
Interface Help.HelpFormatter
-
- All Known Implementing Classes:
Help.CliHelpFormatter
,Help.ManPageFormatter
- Enclosing class:
- Help
private static interface Help.HelpFormatter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.lang.String
indent(int depth)
java.lang.String
launcher(boolean verbose)
default java.lang.String[]
launchOptions()
java.lang.String
optionize(java.lang.String[] options)
Joins options together with a pipe and surrounds them in parentheses.void
printMainOptionsSubheading()
void
printName()
void
printNotes()
void
printNotesHeading()
default void
printOptions()
void
printOptions(java.util.Map<java.lang.String,java.lang.String> map)
void
printOptionsHeading()
void
printSavingOptionsSubheading()
void
printTitle()
default void
printUsage()
Prints eachlaunch option
prepended with the common#launcher()
String.void
printUsageHeading()
java.lang.String
savingModifiers()
-
-
-
Method Detail
-
printTitle
void printTitle()
-
printName
void printName()
-
printUsageHeading
void printUsageHeading()
-
printUsage
default void printUsage()
Prints eachlaunch option
prepended with the common#launcher()
String. Man page formatting doesn't mind the indentation so this is common for both formatters.
-
printOptionsHeading
void printOptionsHeading()
-
printMainOptionsSubheading
void printMainOptionsSubheading()
-
printSavingOptionsSubheading
void printSavingOptionsSubheading()
-
printOptions
default void printOptions()
-
printOptions
void printOptions(java.util.Map<java.lang.String,java.lang.String> map)
-
optionize
java.lang.String optionize(java.lang.String[] options)
Joins options together with a pipe and surrounds them in parentheses.- Parameters:
options
- String array containing the individual options- Returns:
- String in the format of "(opt1|opt2|...)"
-
indent
default java.lang.String indent(int depth)
-
launchOptions
default java.lang.String[] launchOptions()
-
launcher
java.lang.String launcher(boolean verbose)
-
savingModifiers
java.lang.String savingModifiers()
-
printNotesHeading
void printNotesHeading()
-
printNotes
void printNotes()
-
-