Class FileStringParser


  • public class FileStringParser
    extends PropertyStringParser
    A StringParser for parsing File objects. The parse() method delegates the actual parsing to new File(String). If new File(String) throws a NullPointerException, it is encapsulated in a ParseException and re-thrown.
    Since:
    1.4
    Author:
    Marty Lamb, Edward Glen (edward@glencomm.com) (modified URLStringParser), Eric Sword (made setters return "this", fixed bug triggered when file does not exist)
    See Also:
    StringParser, URL
    • Constructor Detail

      • FileStringParser

        public FileStringParser()
        Deprecated.
        Creates a new FileStringParser.
    • Method Detail

      • setUp

        public void setUp()
                   throws ParseException
        Description copied from class: StringParser
        Performs any initialization not handled by this StringParser's constructor. The contract for this method is that it will be called AT LEAST once before this object's parse() method is called.

        In the JSAP API, this method is called every time an Option containing this StringParser is registered with a JSAP. If there is an initialization error, this method should throw a JSAPException to prevent the Option from being registered.
        Overrides:
        setUp in class StringParser
        Throws:
        ParseException
      • setMustBeDirectory

        public FileStringParser setMustBeDirectory​(boolean mustBeDirectory)
      • mustBeDirectory

        public boolean mustBeDirectory()
      • mustBeFile

        public boolean mustBeFile()
      • mustExist

        public boolean mustExist()
      • tearDown

        public void tearDown()
        Description copied from class: StringParser
        Performs any cleanup necessary for this StringParser. The contract for this method is that it MAY be called at any time after the setUp method has been called. It may be called more than once.

        In the JSAP API, this method is called every time an Option containing this StringParser is unregistered from a JSAP. During finalization, any registered Options are unregistered from a JSAP.
        Overrides:
        tearDown in class StringParser
      • parse

        public java.lang.Object parse​(java.lang.String arg)
                               throws ParseException
        Parses the specified argument into a File. This method delegates the actual parsing to new File(arg). If new File(arg) throws a NullPointerException, it is encapsulated in a ParseException and re-thrown.
        Specified by:
        parse in class StringParser
        Parameters:
        arg - the argument to parse
        Returns:
        a File as specified by arg.
        Throws:
        ParseException - if new File(arg) throws a NullPointerException.
        See Also:
        File, StringParser.parse(String)