Class ParserProperties

java.lang.Object
org.kohsuke.args4j.ParserProperties

public class ParserProperties extends Object
Set of properties that controls CmdLineParser behaviours.
See Also:
  • Field Details

    • DEFAULT_USAGE_WIDTH

      private static final int DEFAULT_USAGE_WIDTH
      See Also:
    • usageWidth

      private int usageWidth
    • optionSorter

      private Comparator<OptionHandler> optionSorter
    • optionValueDelimiter

      private String optionValueDelimiter
    • atSyntax

      private boolean atSyntax
    • showDefaults

      private boolean showDefaults
    • DEFAULT_COMPARATOR

      static final Comparator<OptionHandler> DEFAULT_COMPARATOR
  • Constructor Details

    • ParserProperties

      private ParserProperties()
  • Method Details

    • defaults

      public static ParserProperties defaults()
      Returns an instance of the default parser properties. This instance can be manipulated with the withXXX() methods in this class.
    • withAtSyntax

      public ParserProperties withAtSyntax(boolean atSyntax)
      Toggles the parsing of @-prefixes in values. If a command line value starts with @, it is interpreted as being a file, loaded, and interpreted as if the file content would have been passed to the command line.
      Parameters:
      atSyntax - true if at sign is being parsed, false if it is to be ignored. Defaults to true.
      See Also:
    • getAtSyntax

      public boolean getAtSyntax()
      Gets whether @-prefix-parsing is enabled.
      See Also:
    • withShowDefaults

      public ParserProperties withShowDefaults(boolean showDefaults)
      Toggles the showing of default values in the command line help.
      Parameters:
      showDefaults - true if to show defaults, false otherweise. Defaults to true.
      See Also:
    • getShowDefaults

      public boolean getShowDefaults()
      Gets whether show defaults is enabled.
      See Also:
    • withUsageWidth

      public ParserProperties withUsageWidth(int usageWidth)
      Sets the width of a usage line. If the usage message is longer than this value, the parser wraps the line. Defaults to 80.
      Parameters:
      usageWidth - the width of the usage output in columns.
      Throws:
      IllegalArgumentException - if usageWidth is negative
    • getUsageWidth

      int getUsageWidth()
      Returns:
      the width of a usage line.
    • withOptionSorter

      public ParserProperties withOptionSorter(Comparator<OptionHandler> sorter)
      Controls how options are sorted in the usage screen.
      Parameters:
      sorter - If non-null, options are sorted in the order induced by this comparator.
    • getOptionSorter

      Comparator<OptionHandler> getOptionSorter()
      Returns:
      null if options are left unsorted and should be listed by their discovery order. Otherwise the returned comparator is used to sort options. The default value is a comparator that sorts options alphabetically.
    • withOptionValueDelimiter

      public ParserProperties withOptionValueDelimiter(String v)
      Sets the string used to separate option name and its value (such as --foo=bar vs --foo bar) Default to whitespace. Note that the tokens separated in the argument array (such as '-foo','bar') is always recognized as a valid name/value separator.
    • getOptionValueDelimiter

      public String getOptionValueDelimiter()