org.gjt.sp.jedit.io
Class VFSManager

java.lang.Object
  |
  +--org.gjt.sp.jedit.io.VFSManager

public class VFSManager
extends java.lang.Object

jEdit's virtual filesystem allows it to transparently edit files stored elsewhere than the local filesystem, for example on an FTP site.

Version:
$Id: VFSManager.java,v 1.7 2002/06/01 02:32:02 spestov Exp $
Author:
Slava Pestov

Method Summary
static void error(java.awt.Component comp, java.lang.String error, java.lang.Object[] args)
          Deprecated. Call the other error() method instead.
static void error(java.awt.Component comp, java.lang.String path, java.lang.String messageProp, java.lang.Object[] args)
          Reports an I/O error.
static boolean errorOccurred()
          Returns if the last request caused an error.
static java.util.Enumeration getFilesystems()
          Returns an enumeration of all registered filesystems.
static VFS getFileVFS()
          Returns the local filesystem VFS.
static WorkThreadPool getIOThreadPool()
          Returns the I/O thread pool.
static int getRequestCount()
          Returns the number of pending I/O requests.
static VFS getUrlVFS()
          Returns the URL VFS.
static VFS getVFSByName(java.lang.String name)
          Returns the VFS for the specified name.
static VFS getVFSForPath(java.lang.String path)
          Returns the VFS for the specified path.
static VFS getVFSForProtocol(java.lang.String protocol)
          Returns the VFS for the specified protocol.
static void init()
          Do not call.
static void registerVFS(java.lang.String protocol, VFS vfs)
          Registers a virtual filesystem.
static void runInAWTThread(java.lang.Runnable run)
          Executes the specified runnable in the AWT thread once all pending I/O requests are complete.
static void runInWorkThread(java.lang.Runnable run)
          Executes the specified runnable in one of the I/O threads.
static void sendVFSUpdate(VFS vfs, java.lang.String path, boolean parent)
          Sends a VFS update message.
static void start()
          Do not call.
static void waitForRequests()
          Returns when all pending requests are complete.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

init

public static void init()
Do not call.


start

public static void start()
Do not call.


getFileVFS

public static VFS getFileVFS()
Returns the local filesystem VFS.

Since:
jEdit 2.5pre1

getUrlVFS

public static VFS getUrlVFS()
Returns the URL VFS.

Since:
jEdit 2.5pre1

getVFSByName

public static VFS getVFSByName(java.lang.String name)
Returns the VFS for the specified name.

Parameters:
name - The VFS name
Since:
jEdit 2.6pre4

getVFSForProtocol

public static VFS getVFSForProtocol(java.lang.String protocol)
Returns the VFS for the specified protocol.

Parameters:
protocol - The protocol
Since:
jEdit 2.5pre1

getVFSForPath

public static VFS getVFSForPath(java.lang.String path)
Returns the VFS for the specified path.

Parameters:
path - The path
Since:
jEdit 2.6pre4

registerVFS

public static void registerVFS(java.lang.String protocol,
                               VFS vfs)
Registers a virtual filesystem.

Parameters:
protocol - The protocol
vfs - The VFS
Since:
jEdit 2.5pre1

getFilesystems

public static java.util.Enumeration getFilesystems()
Returns an enumeration of all registered filesystems.

Since:
jEdit 2.5pre1

getIOThreadPool

public static WorkThreadPool getIOThreadPool()
Returns the I/O thread pool.


waitForRequests

public static void waitForRequests()
Returns when all pending requests are complete.

Since:
jEdit 2.5pre1

errorOccurred

public static boolean errorOccurred()
Returns if the last request caused an error.


getRequestCount

public static int getRequestCount()
Returns the number of pending I/O requests.


runInAWTThread

public static void runInAWTThread(java.lang.Runnable run)
Executes the specified runnable in the AWT thread once all pending I/O requests are complete.

Since:
jEdit 2.5pre1

runInWorkThread

public static void runInWorkThread(java.lang.Runnable run)
Executes the specified runnable in one of the I/O threads.

Since:
jEdit 2.6pre2

error

public static void error(java.awt.Component comp,
                         java.lang.String error,
                         java.lang.Object[] args)
Deprecated. Call the other error() method instead.


error

public static void error(java.awt.Component comp,
                         java.lang.String path,
                         java.lang.String messageProp,
                         java.lang.Object[] args)
Reports an I/O error.

Parameters:
comp - The component
path - The path name that caused the error
args - Positional parameters
Since:
jEdit 4.0pre3

sendVFSUpdate

public static void sendVFSUpdate(VFS vfs,
                                 java.lang.String path,
                                 boolean parent)
Sends a VFS update message.

Parameters:
vfs - The VFS
path - The path that changed
parent - True if an update should be sent for the path's parent too
Since:
jEdit 2.6pre4