Package com.scriptbasic.utility.functions.file

Class FileHandlingFunctions

  • public class FileHandlingFunctions
extends java.lang.Object
    This class implements static methods, which can be used from BASIC programs to access the file system.

    Note that these functions are NOT registered into the BASIC interpreter by default. The embedding application has to ask the interpreter to register the methods of this class if it wants BASIC programs access the file system.

    Author:
    Peter Verhas

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String absoluteFileName​(java.lang.String fileName)  
      static void close​(FileHandler fh)  
      static void deleteFile​(java.lang.String fileName)  
      static boolean fileCanExecute​(java.lang.String fileName)  
      static boolean fileExists​(java.lang.String fileName)  
      static boolean fileIsExecutable​(java.lang.String fileName)  
      static boolean fileIsReadable​(java.lang.String fileName)  
      static boolean fileIsWritable​(java.lang.String fileName)  
      static java.lang.Long fileLength​(java.lang.String fileName)  
      static java.lang.Long freeSpace​(java.lang.String fileName)  
      static boolean isDirectory​(java.lang.String fileName)  
      static boolean isFile​(java.lang.String fileName)  
      static boolean isHidden​(java.lang.String fileName)  
      static java.lang.Long lastModified​(java.lang.String fileName)  
      static BasicArray listFiles​(java.lang.String fileName)  
      static boolean mkdir​(java.lang.String fileName)  
      static FileHandler open​(java.lang.String fileName, java.lang.String mode)
      Opens a file and returns a file handler.
      static java.lang.String parentDirectory​(java.lang.String fileName)  
      static void printf​(FileHandler fh, java.lang.String line)  
      static void printfln​(FileHandler fh, java.lang.String line)  
      static byte[] read​(FileHandler fh, int len)  
      static java.lang.String readLine​(FileHandler fh)  
      static boolean renameFile​(java.lang.String fileNameFrom, java.lang.String fileNameTo)  
      static boolean setExecutable​(java.lang.String fileName, boolean executable, boolean ownerOnly)  
      static boolean setLastModified​(java.lang.String fileName, java.lang.Long time)  
      static boolean setReadable​(java.lang.String fileName, boolean readable, boolean ownerOnly)  
      static boolean setRedOnly​(java.lang.String fileName)  
      static boolean setWritable​(java.lang.String fileName, boolean writable, boolean ownerOnly)  
      static void write​(FileHandler fh, byte[] buffer)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • open

        public static FileHandler open​(java.lang.String fileName,
                               java.lang.String mode)
        Opens a file and returns a file handler. Files can be opened read, write or append. Also the mode can be binary or text. Default is read and text.
        Parameters:
        fileName - the name of the file to be opened.
        mode - the mode how to open the file
        Returns:
        return value

      • close

        public static void close​(FileHandler fh)
                  throws java.lang.Exception
        Throws:
        java.lang.Exception

      • deleteFile

        public static void deleteFile​(java.lang.String fileName)

      • fileExists

        public static boolean fileExists​(java.lang.String fileName)

      • fileCanExecute

        public static boolean fileCanExecute​(java.lang.String fileName)

      • fileIsReadable

        public static boolean fileIsReadable​(java.lang.String fileName)

      • fileIsWritable

        public static boolean fileIsWritable​(java.lang.String fileName)

      • fileIsExecutable

        public static boolean fileIsExecutable​(java.lang.String fileName)

      • isDirectory

        public static boolean isDirectory​(java.lang.String fileName)

      • isFile

        public static boolean isFile​(java.lang.String fileName)

      • absoluteFileName

        public static java.lang.String absoluteFileName​(java.lang.String fileName)

      • freeSpace

        public static java.lang.Long freeSpace​(java.lang.String fileName)

      • parentDirectory

        public static java.lang.String parentDirectory​(java.lang.String fileName)

      • isHidden

        public static boolean isHidden​(java.lang.String fileName)

      • mkdir

        public static boolean mkdir​(java.lang.String fileName)

      • renameFile

        public static boolean renameFile​(java.lang.String fileNameFrom,
                                 java.lang.String fileNameTo)

      • setExecutable

        public static boolean setExecutable​(java.lang.String fileName,
                                    boolean executable,
                                    boolean ownerOnly)

      • setReadable

        public static boolean setReadable​(java.lang.String fileName,
                                  boolean readable,
                                  boolean ownerOnly)

      • setWritable

        public static boolean setWritable​(java.lang.String fileName,
                                  boolean writable,
                                  boolean ownerOnly)

      • setRedOnly

        public static boolean setRedOnly​(java.lang.String fileName)

      • lastModified

        public static java.lang.Long lastModified​(java.lang.String fileName)

      • fileLength

        public static java.lang.Long fileLength​(java.lang.String fileName)

      • setLastModified

        public static boolean setLastModified​(java.lang.String fileName,
                                      java.lang.Long time)