Module jEdit
Package org.gjt.sp.jedit.io

Class FileVFS

java.lang.Object
org.gjt.sp.jedit.io.VFS
org.gjt.sp.jedit.io.FileVFS
public class FileVFS extends VFS
Local filesystem VFS.
Version:
$Id: FileVFS.java 25330 2020-05-09 14:21:52Z kpouer $
Author:
Slava Pestov

  • Field Details

  • Constructor Details

    • FileVFS

      public FileVFS()

  • Method Details

    • getParentOfPath

      @Nonnull public String getParentOfPath(String path)
      Description copied from class: VFS
      Returns the parent of the specified path. This must be overridden to return a non-null value for browsing of this filesystem to work.
      Overrides:
      getParentOfPath in class VFS
      Parameters:
      path - The path

    • constructPath

      public String constructPath(String parent, String path)
      Description copied from class: VFS
      Constructs a path from the specified directory and file name component. This must be overridden to return a non-null value, otherwise browsing this filesystem will not work.

      Unless you are writing a VFS, this method should not be called directly. To ensure correct behavior, you must call MiscUtilities.constructPath(String,String) instead.

      Overrides:
      constructPath in class VFS
      Parameters:
      parent - The parent directory
      path - The path

    • getFileSeparator

      public char getFileSeparator()
      Description copied from class: VFS
      Returns the file separator used by this VFS.
      Overrides:
      getFileSeparator in class VFS

    • getTwoStageSaveName

      @Nullable public String getTwoStageSaveName(String path)
      Returns a temporary file name based on the given path.

      If the directory where the file would be created cannot be written (i.e., no new files can be created in that directory), this method returns null.

      Overrides:
      getTwoStageSaveName in class VFS
      Parameters:
      path - The path name

    • save

      public boolean save(View view, Buffer buffer, String path)
      Description copied from class: VFS
      Saves the specifies buffer. The default implementation posts an I/O request to the I/O thread.
      Overrides:
      save in class VFS
      Parameters:
      view - The view
      buffer - The buffer
      path - The path

    • insert

      public boolean insert(View view, Buffer buffer, String path)
      Description copied from class: VFS
      Inserts a file into the specified buffer. The default implementation posts an I/O request to the I/O thread.
      Overrides:
      insert in class VFS
      Parameters:
      view - The view
      buffer - The buffer
      path - The path

    • recursiveDelete

      public static boolean recursiveDelete(File path)
      #
      Parameters:
      path - the directory path to recursive delete
      Returns:
      true if successful, else false

    • _canonPath

      public String _canonPath(Object session, String path, Component comp) throws IOException
      Returns the canonical form if the specified path name. For example, ~ might be expanded to the user's home directory.
      Overrides:
      _canonPath in class VFS
      Parameters:
      session - The session
      path - The path
      comp - The component that will parent error dialog boxes
      Throws:
      IOException - if an I/O error occurred
      Since:
      jEdit 4.0pre2

    • _listFiles

      public VFSFile[] _listFiles(Object session, String path, Component comp)
      Description copied from class: VFS
      Lists the specified directory.
      Overrides:
      _listFiles in class VFS
      Parameters:
      session - The session
      path - The directory. Note that this must be a full URL, including the host name, path name, and so on. The username and password (if needed by the VFS) is obtained from the session instance.
      comp - The component that will parent error dialog boxes

    • _getFile

      public VFSFile _getFile(Object session, String path, Component comp)
      Description copied from class: VFS
      Returns the specified directory entry.
      Overrides:
      _getFile in class VFS
      Parameters:
      session - The session get it with VFS.createVFSSession(String, Component)
      path - The path
      comp - The component that will parent error dialog boxes
      Returns:
      The specified directory entry, or null if it doesn't exist.

    • _delete

      public boolean _delete(Object session, String path, Component comp)
      Description copied from class: VFS
      Deletes the specified URL.
      Overrides:
      _delete in class VFS
      Parameters:
      session - The VFS session
      path - The path
      comp - The component that will parent error dialog boxes

    • _rename

      public boolean _rename(Object session, String from, String to, Component comp)
      Description copied from class: VFS
      Renames the specified URL. Some filesystems might support moving URLs between directories, however others may not. Do not rely on this behavior.
      Overrides:
      _rename in class VFS
      Parameters:
      session - The VFS session
      from - The old path
      to - The new path
      comp - The component that will parent error dialog boxes

    • _mkdir

      public boolean _mkdir(Object session, String directory, Component comp)
      Description copied from class: VFS
      Creates a new directory with the specified URL.
      Overrides:
      _mkdir in class VFS
      Parameters:
      session - The VFS session
      directory - The directory
      comp - The component that will parent error dialog boxes

    • _createInputStream

      public InputStream _createInputStream(Object session, String path, boolean ignoreErrors, Component comp) throws IOException
      Description copied from class: VFS
      Creates an input stream. This method is called from the I/O thread.
      Overrides:
      _createInputStream in class VFS
      Parameters:
      session - the VFS session
      path - The path
      ignoreErrors - If true, file not found errors should be ignored
      comp - The component that will parent error dialog boxes
      Returns:
      an inputstream or null if there was a problem
      Throws:
      IOException - If an I/O error occurs

    • _createOutputStream

      public OutputStream _createOutputStream(Object session, String path, Component comp) throws IOException
      Description copied from class: VFS
      Creates an output stream. This method is called from the I/O thread.
      Overrides:
      _createOutputStream in class VFS
      Parameters:
      session - the VFS session
      path - The path
      comp - The component that will parent error dialog boxes
      Throws:
      IOException - If an I/O error occurs

    • _saveComplete

      public void _saveComplete(Object session, Buffer buffer, String path, Component comp)
      Description copied from class: VFS
      Called after a file has been saved.
      Overrides:
      _saveComplete in class VFS
      Parameters:
      session - The VFS session
      buffer - The buffer
      path - The path the buffer was saved to (can be different from Buffer.getPath() if the user invoked the Save a Copy As command, for example).
      comp - The component that will parent error dialog boxes

    • getPermissions

      public static int getPermissions(String path)
      Returns numeric permissions of a file. On non-Unix systems, always returns zero.
      Since:
      jEdit 3.2pre9

    • setPermissions

      public static void setPermissions(String path, int permissions)
      Sets numeric permissions of a file. On non-Unix platforms, does nothing.
      Since:
      jEdit 3.2pre9