Class BooleanStringParser

java.lang.Object
com.martiansoftware.jsap.StringParser
com.martiansoftware.jsap.stringparsers.BooleanStringParser

public class BooleanStringParser extends StringParser

A StringParser for parsing Booleans. This StringParser is also used internally by the Switch class.

When parsing, the following arguments are interpreted as TRUE:

  • null
  • "t" (case-insensitive)
  • "true" (case-insensitive)
  • "y" (case-insensitive)
  • "yes" (case-insensitive)
  • "1"

The following arguments are interpreted as FALSE:

  • "f" (case-insensitive)
  • "false" (case-insensitive)
  • "n" (case-insensitive)
  • "no" (case-insensitive)
  • "0"

All other input throws a ParseException.

Author:
Marty Lamb
See Also:
  • Constructor Details

    • BooleanStringParser

      public BooleanStringParser()
      Deprecated.
      Use getParser() or, even better, JSAP.BOOLEAN_PARSER.
      Creates a new BooleanStringParser
  • Method Details

    • getParser

      public static BooleanStringParser getParser()
      Returns a BooleanStringParser.

      Convenient access to the only instance returned by this method is available through JSAP.BOOLEAN_PARSER.

      Returns:
      a BooleanStringParser.
    • parse

      public Object parse(String arg) throws ParseException
      Converts the specified argument into a Boolean.

      When parsing, the following arguments are interpreted as TRUE:

      • null
      • "t" (case-insensitive)
      • "true" (case-insensitive)
      • "y" (case-insensitive)
      • "yes" (case-insensitive)
      • "1"
        • The following arguments are interpreted as FALSE:

          • "f" (case-insensitive)
          • "false" (case-insensitive)
          • "n" (case-insensitive)
          • "no" (case-insensitive)
          • "0"

          All other input throws a ParseException.

      Specified by:
      parse in class StringParser
      Parameters:
      arg - the argument to convert to a Boolean.
      Returns:
      a Boolean as described above.
      Throws:
      ParseException - if none of the above cases are matched.