Class CliHelpFormatter
- java.lang.Object
-
- org.apache.commons.cli2.util.HelpFormatter
-
- org.apache.jackrabbit.vault.util.console.util.CliHelpFormatter
-
public class CliHelpFormatter extends org.apache.commons.cli2.util.HelpFormatter
Highly customized help formatter to work withCliCommand
s.
-
-
Field Summary
Fields Modifier and Type Field Description static String
SYS_PROP_TERM_WIDTH
-
Constructor Summary
Constructors Constructor Description CliHelpFormatter(String gutterLeft, String gutterCenter, String gutterRight, int fullWidth)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CliHelpFormatter
create()
CliCommand
getCmd()
String
getDescription()
String
getExample()
boolean
isShowUsage()
boolean
isSkipToplevel()
void
printDescription()
void
printExample()
void
printHelp()
Prints detailed help per option.void
printUsage()
void
setCmd(CliCommand cmd)
void
setDescription(String description)
void
setExample(String example)
void
setShowUsage(boolean showUsage)
void
setSkipToplevel(boolean skipToplevel)
-
Methods inherited from class org.apache.commons.cli2.util.HelpFormatter
getComparator, getDisplaySettings, getDivider, getException, getFooter, getFullUsageSettings, getGroup, getGutterCenter, getGutterLeft, getGutterRight, getHeader, getLineUsageSettings, getPageWidth, getPrintWriter, getShellCommand, pad, print, printDivider, printException, printFooter, printGutterLeft, printGutterRight, printHeader, printWrapped, setComparator, setDisplaySettings, setDivider, setException, setFooter, setFullUsageSettings, setGroup, setHeader, setLineUsageSettings, setPrintWriter, setShellCommand, wrap
-
-
-
-
Field Detail
-
SYS_PROP_TERM_WIDTH
public static final String SYS_PROP_TERM_WIDTH
- See Also:
- Constant Field Values
-
-
Method Detail
-
create
public static CliHelpFormatter create()
-
getCmd
public CliCommand getCmd()
-
setCmd
public void setCmd(CliCommand cmd)
-
printUsage
public void printUsage()
- Overrides:
printUsage
in classorg.apache.commons.cli2.util.HelpFormatter
-
isSkipToplevel
public boolean isSkipToplevel()
-
setSkipToplevel
public void setSkipToplevel(boolean skipToplevel)
-
isShowUsage
public boolean isShowUsage()
-
setShowUsage
public void setShowUsage(boolean showUsage)
-
getDescription
public String getDescription()
-
setDescription
public void setDescription(String description)
-
getExample
public String getExample()
-
setExample
public void setExample(String example)
-
printHelp
public void printHelp()
Prints detailed help per option.- Overrides:
printHelp
in classorg.apache.commons.cli2.util.HelpFormatter
-
printDescription
public void printDescription()
-
printExample
public void printExample()
-
-