Class CliHelpFormatter

  • public class CliHelpFormatter
    extends org.apache.commons.cli2.util.HelpFormatter
    Highly customized help formatter to work with CliCommands.
    • Constructor Detail

      • CliHelpFormatter

        public CliHelpFormatter​(String gutterLeft,
                                String gutterCenter,
                                String gutterRight,
                                int fullWidth)
    • Method Detail

      • printUsage

        public void printUsage()
        printUsage in class org.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.
        printHelp in class org.apache.commons.cli2.util.HelpFormatter
      • printDescription

        public void printDescription()
      • printExample

        public void printExample()