Package org.apache.rat.help

Class AbstractHelp.RatHelpFormatter

java.lang.Object
org.apache.commons.cli.HelpFormatter
org.apache.rat.help.AbstractHelp.RatHelpFormatter
Enclosing class:
AbstractHelp
public class AbstractHelp.RatHelpFormatter extends org.apache.commons.cli.HelpFormatter
Provides help for formatting text.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.apache.commons.cli.HelpFormatter

    org.apache.commons.cli.HelpFormatter.Builder

  • Field Summary

    Fields inherited from class org.apache.commons.cli.HelpFormatter

    DEFAULT_ARG_NAME, DEFAULT_DESC_PAD, DEFAULT_LEFT_PAD, DEFAULT_LONG_OPT_PREFIX, DEFAULT_LONG_OPT_SEPARATOR, DEFAULT_OPT_PREFIX, DEFAULT_SYNTAX_PREFIX, DEFAULT_WIDTH, defaultArgName, defaultDescPad, defaultLeftPad, defaultLongOptPrefix, defaultNewLine, defaultOptPrefix, defaultSyntaxPrefix, defaultWidth, optionComparator

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    printHelp(PrintWriter writer, String cmdLineSyntax, String header, org.apache.commons.cli.Options options, String footer)
    Prints the help text.
    protected StringBuffer
    renderOptions(StringBuffer sb, int width, org.apache.commons.cli.Options options, int leftPad, int descPad)
     

    Methods inherited from class org.apache.commons.cli.HelpFormatter

    builder, createPadding, findWrapPos, getArgName, getDescPadding, getDescription, getLeftPadding, getLongOptPrefix, getLongOptSeparator, getNewLine, getOptionComparator, getOptPrefix, getSyntaxPrefix, getWidth, printHelp, printHelp, printHelp, printHelp, printHelp, printHelp, printHelp, printHelp, printOptions, printUsage, printUsage, printWrapped, printWrapped, renderWrappedText, rtrim, setArgName, setDescPadding, setLeftPadding, setLongOptPrefix, setLongOptSeparator, setNewLine, setOptionComparator, setOptPrefix, setSyntaxPrefix, setWidth

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • printHelp

      public void printHelp(PrintWriter writer, String cmdLineSyntax, String header, org.apache.commons.cli.Options options, String footer)
      Prints the help text.
      Parameters:
      writer - the writer to write to.
      cmdLineSyntax - The command line syntax for the program.
      header - Additional information to proceed the Options descriptions.
      options - the Options to output help for.
      footer - Additional information to follow the Options descriptions.

    • renderOptions

      protected StringBuffer renderOptions(StringBuffer sb, int width, org.apache.commons.cli.Options options, int leftPad, int descPad)
      Overrides:
      renderOptions in class org.apache.commons.cli.HelpFormatter