Module jamal.tools

Class FileTools


  • public class FileTools
    extends java.lang.Object
    Utility class containing static methods handling files.
    • Constructor Summary

      Constructors 
      Constructor Description
      FileTools()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String absolute​(java.lang.String reference, java.lang.String fileName)
      Convert the file name to an absolute file name if it is relative to the directory containing the reference file.
      static Input getInput​(java.lang.String fileName)
      Create a new input from a file.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • FileTools

        public FileTools()
    • Method Detail

      • getInput

        public static Input getInput​(java.lang.String fileName)
                              throws BadSyntax
        Create a new input from a file.
        Parameters:
        fileName - the name of the file. This is used to open and read the file as well as reference file name in the input.
        Returns:
        the input containing the contend of the file.
        Throws:
        BadSyntaxAt - if the file cannot be read.
        BadSyntax
      • absolute

        public static java.lang.String absolute​(java.lang.String reference,
                                                java.lang.String fileName)
        Convert the file name to an absolute file name if it is relative to the directory containing the reference file. Note that reference is the name of a file and not a directory.

        If the name of the file starts with one of the characters:

        • /
        • \
        • ~

        or starts with an alpha character and a : (DOS drive letter, like C: then the file name is absolute and it is returned as it is.

        Otherwise the string in the parameter reference is used as it was a file name (the file does not need to exist) and file is treated as a relative file name and the absolute path is calculated.

        Parameters:
        reference - the name of the reference file
        fileName - the name of the file, absolute or relative
        Returns:
        the absolute file name of the file