Class CharacterStringParser

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

public class CharacterStringParser
extends StringParser
A StringParser for parsing Characters. The parse() method requires an argument of length exactly equal to 1 in order to perform the conversion; otherwise, a ParseException is thrown.
Author:
Marty Lamb
See Also:
StringParser, Character
  • Constructor Details

    • CharacterStringParser

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

    • getParser

      public static CharacterStringParser getParser()
      Returns a CharacterStringParser.

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

      Returns:
      a CharacterStringParser.
    • parse

      public java.lang.Object parse​(java.lang.String arg) throws ParseException
      Parses the specified argument into a Character. The conversion is performed by checking that the specified argument is exactly 1 character long, then encapsulating that char in a Character object. If the specified argument is not exactly 1 character long, a ParseException is thrown.
      Specified by:
      parse in class StringParser
      Parameters:
      arg - the argument to parse
      Returns:
      a Character object with the value contained in the specified argument.
      Throws:
      ParseException - if ( (arg==null) || (arg.length()!=1) )
      See Also:
      Character, StringParser.parse(String)