/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/jedit/io/VFS.html
HTML | 1477 lines | 1326 code | 140 blank | 11 comment | 0 complexity | 66fffa2d938027991ce955cd01366e01 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:02 GMT-08:00 2008 -->
- <TITLE>
- VFS (jEdit API)
- </TITLE>
- <META NAME="keywords" CONTENT="org.gjt.sp.jedit.io.VFS class">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
- <NOSCRIPT>
- </NOSCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" >
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VFS.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../org/gjt/sp/jedit/io/UrlVFS.html" title="class in org.gjt.sp.jedit.io"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.DirectoryEntry.html" title="class in org.gjt.sp.jedit.io"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../index.html?org/gjt/sp/jedit/io/VFS.html" target="_top"><B>FRAMES</B></A>
- <A HREF="VFS.html" target="_top"><B>NO FRAMES</B></A>
-
- <NOSCRIPT>
- <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.gjt.sp.jedit.io</FONT>
- <BR>
- Class VFS</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.jedit.io.VFS</B>
- </PRE>
- <DL>
- <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/gjt/sp/jedit/io/FavoritesVFS.html" title="class in org.gjt.sp.jedit.io">FavoritesVFS</A>, <A HREF="../../../../../org/gjt/sp/jedit/io/FileRootsVFS.html" title="class in org.gjt.sp.jedit.io">FileRootsVFS</A>, <A HREF="../../../../../org/gjt/sp/jedit/io/FileVFS.html" title="class in org.gjt.sp.jedit.io">FileVFS</A>, <A HREF="../../../../../org/gjt/sp/jedit/io/UrlVFS.html" title="class in org.gjt.sp.jedit.io">UrlVFS</A></DD>
- </DL>
- <HR>
- <DL>
- <DT><PRE>public abstract class <B>VFS</B><DT>extends java.lang.Object</DL>
- </PRE>
- <P>
- A virtual filesystem implementation.<p>
- Plugins can provide virtual file systems by defining entries in their
- <code>services.xml</code> files like so:
- <pre><SERVICE CLASS="org.gjt.sp.jedit.io.VFS" NAME="<i>name</i>">
- new <i>MyVFS</i>();
- </SERVICE></pre>
- URLs of the form <code><i>name</i>:<i>path</i></code> will then be handled
- by the VFS named <code><i>name</i></code>.<p>
- See <A HREF="../../../../../org/gjt/sp/jedit/ServiceManager.html" title="class in org.gjt.sp.jedit"><CODE>ServiceManager</CODE></A> for details.<p>
- <h3>Session objects:</h3>
- A session is used to persist things like login information, any network
- sockets, etc. File system implementations that do not need this kind of
- persistence return a dummy object as a session.<p>
- Methods whose names are prefixed with "_" expect to be given a
- previously-obtained session object. A session must be obtained from the AWT
- thread in one of two ways:
- <ul>
- <li><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#createVFSSession(java.lang.String, java.awt.Component)"><CODE>createVFSSession(String,Component)</CODE></A></li>
- <li><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#showBrowseDialog(java.lang.Object[], java.awt.Component)"><CODE>showBrowseDialog(Object[],Component)</CODE></A></li>
- </ul>
- When done, the session must be disposed of using
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_endVFSSession(java.lang.Object, java.awt.Component)"><CODE>_endVFSSession(Object,Component)</CODE></A>.<p>
- <h3>Thread safety:</h3>
- The following methods cannot be called from an I/O thread:
- <ul>
- <li><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#createVFSSession(java.lang.String, java.awt.Component)"><CODE>createVFSSession(String,Component)</CODE></A></li>
- <li><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#insert(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)"><CODE>insert(View,Buffer,String)</CODE></A></li>
- <li><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#load(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)"><CODE>load(View,Buffer,String)</CODE></A></li>
- <li><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#save(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)"><CODE>save(View,Buffer,String)</CODE></A></li>
- <li><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#showBrowseDialog(java.lang.Object[], java.awt.Component)"><CODE>showBrowseDialog(Object[],Component)</CODE></A></li>
- </ul>
- All remaining methods are required to be thread-safe in subclasses.
- <h3>Implementing a VFS</h3>
- You can override as many or as few methods as you want. Make sure
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getCapabilities()"><CODE>getCapabilities()</CODE></A> returns a value reflecting the functionality
- implemented by your VFS.
- <P>
- <P>
- <DL>
- <DT><B>See Also:</B><DD><A HREF="../../../../../org/gjt/sp/jedit/io/VFSManager.html#getVFSForPath(java.lang.String)"><CODE>VFSManager.getVFSForPath(String)</CODE></A>,
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFSManager.html#getVFSForProtocol(java.lang.String)"><CODE>VFSManager.getVFSForProtocol(String)</CODE></A></DL>
- <HR>
- <P>
- <!-- ======== NESTED CLASS SUMMARY ======== -->
- <A NAME="nested_class_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Nested Class Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static class</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.DirectoryEntry.html" title="class in org.gjt.sp.jedit.io">VFS.DirectoryEntry</A></B></CODE>
- <BR>
- <B>Deprecated.</B> <I>Use <code>VFSFile</code> instead.</I></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static class</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.DirectoryEntryCompare.html" title="class in org.gjt.sp.jedit.io">VFS.DirectoryEntryCompare</A></B></CODE>
- <BR>
- Implementation of <CODE>Comparator</CODE>
- interface that compares <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.DirectoryEntry.html" title="class in org.gjt.sp.jedit.io"><CODE>VFS.DirectoryEntry</CODE></A> instances.</TD>
- </TR>
- </TABLE>
- <!-- =========== FIELD SUMMARY =========== -->
- <A NAME="field_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Field Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#BROWSE_CAP">BROWSE_CAP</A></B></CODE>
- <BR>
- Browse capability</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#CASE_INSENSITIVE_CAP">CASE_INSENSITIVE_CAP</A></B></CODE>
- <BR>
- Case insensitive file system capability.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#DELETE_CAP">DELETE_CAP</A></B></CODE>
- <BR>
- Delete file capability.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#EA_MODIFIED">EA_MODIFIED</A></B></CODE>
- <BR>
- File last modified date.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#EA_SIZE">EA_SIZE</A></B></CODE>
- <BR>
- File size.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#EA_STATUS">EA_STATUS</A></B></CODE>
- <BR>
- File status (read only, read write, etc).</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#EA_TYPE">EA_TYPE</A></B></CODE>
- <BR>
- File type.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#IOBUFSIZE">IOBUFSIZE</A></B></CODE>
- <BR>
- </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#LOW_LATENCY_CAP">LOW_LATENCY_CAP</A></B></CODE>
- <BR>
- Low latency capability.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#MKDIR_CAP">MKDIR_CAP</A></B></CODE>
- <BR>
- Make directory capability.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#READ_CAP">READ_CAP</A></B></CODE>
- <BR>
- Read capability.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#RENAME_CAP">RENAME_CAP</A></B></CODE>
- <BR>
- Rename file capability.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#WRITE_CAP">WRITE_CAP</A></B></CODE>
- <BR>
- Write capability.</TD>
- </TR>
- </TABLE>
-
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <A NAME="constructor_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Constructor Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected </CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#VFS(java.lang.String)">VFS</A></B>(java.lang.String name)</CODE>
- <BR>
- <B>Deprecated.</B> <I>Use the form where the constructor takes a capability
- list.</I></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected </CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#VFS(java.lang.String, int)">VFS</A></B>(java.lang.String name,
- int caps)</CODE>
- <BR>
- Creates a new virtual filesystem.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected </CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#VFS(java.lang.String, int, java.lang.String[])">VFS</A></B>(java.lang.String name,
- int caps,
- java.lang.String[] extAttrs)</CODE>
- <BR>
- Creates a new virtual filesystem.</TD>
- </TR>
- </TABLE>
-
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_backup(java.lang.Object, java.lang.String, java.awt.Component)">_backup</A></B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- Backs up the specified file.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_canonPath(java.lang.Object, java.lang.String, java.awt.Component)">_canonPath</A></B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- Returns the canonical form of the specified path name.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.io.InputStream</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_createInputStream(java.lang.Object, java.lang.String, boolean, java.awt.Component)">_createInputStream</A></B>(java.lang.Object session,
- java.lang.String path,
- boolean ignoreErrors,
- java.awt.Component comp)</CODE>
- <BR>
- Creates an input stream.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.io.OutputStream</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_createOutputStream(java.lang.Object, java.lang.String, java.awt.Component)">_createOutputStream</A></B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- Creates an output stream.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_delete(java.lang.Object, java.lang.String, java.awt.Component)">_delete</A></B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- Deletes the specified URL.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_endVFSSession(java.lang.Object, java.awt.Component)">_endVFSSession</A></B>(java.lang.Object session,
- java.awt.Component comp)</CODE>
- <BR>
- Finishes the specified VFS session.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_finishTwoStageSave(java.lang.Object, org.gjt.sp.jedit.Buffer, java.lang.String, java.awt.Component)">_finishTwoStageSave</A></B>(java.lang.Object session,
- <A HREF="../../../../../org/gjt/sp/jedit/Buffer.html" title="class in org.gjt.sp.jedit">Buffer</A> buffer,
- java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- Called after a file has been saved and we use twoStageSave (first saving to
- another file).</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.DirectoryEntry.html" title="class in org.gjt.sp.jedit.io">VFS.DirectoryEntry</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_getDirectoryEntry(java.lang.Object, java.lang.String, java.awt.Component)">_getDirectoryEntry</A></B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- <B>Deprecated.</B> <I>Use <code>_getFile()</code> instead.</I></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../../org/gjt/sp/jedit/io/VFSFile.html" title="class in org.gjt.sp.jedit.io">VFSFile</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_getFile(java.lang.Object, java.lang.String, java.awt.Component)">_getFile</A></B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- Returns the specified directory entry.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.DirectoryEntry.html" title="class in org.gjt.sp.jedit.io">VFS.DirectoryEntry</A>[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_listDirectory(java.lang.Object, java.lang.String, java.awt.Component)">_listDirectory</A></B>(java.lang.Object session,
- java.lang.String directory,
- java.awt.Component comp)</CODE>
- <BR>
- <B>Deprecated.</B> <I>Use <code>_listFiles()</code> instead.</I></TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_listDirectory(java.lang.Object, java.lang.String, java.lang.String, boolean, java.awt.Component)">_listDirectory</A></B>(java.lang.Object session,
- java.lang.String directory,
- java.lang.String glob,
- boolean recursive,
- java.awt.Component comp)</CODE>
- <BR>
- A convinience method that matches file names against globs, and can
- optionally list the directory recursively.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_listDirectory(java.lang.Object, java.lang.String, java.lang.String, boolean, java.awt.Component, boolean, boolean)">_listDirectory</A></B>(java.lang.Object session,
- java.lang.String directory,
- java.lang.String glob,
- boolean recursive,
- java.awt.Component comp,
- boolean skipBinary,
- boolean skipHidden)</CODE>
- <BR>
- A convinience method that matches file names against globs, and can
- optionally list the directory recursively.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_listDirectory(java.lang.Object, java.lang.String, org.gjt.sp.jedit.io.VFSFileFilter, boolean, java.awt.Component, boolean, boolean)">_listDirectory</A></B>(java.lang.Object session,
- java.lang.String directory,
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFSFileFilter.html" title="interface in org.gjt.sp.jedit.io">VFSFileFilter</A> filter,
- boolean recursive,
- java.awt.Component comp,
- boolean skipBinary,
- boolean skipHidden)</CODE>
- <BR>
- A convinience method that filters the directory listing
- according to a filter, and can optionally list the directory
- recursively.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> <A HREF="../../../../../org/gjt/sp/jedit/io/VFSFile.html" title="class in org.gjt.sp.jedit.io">VFSFile</A>[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_listFiles(java.lang.Object, java.lang.String, java.awt.Component)">_listFiles</A></B>(java.lang.Object session,
- java.lang.String directory,
- java.awt.Component comp)</CODE>
- <BR>
- Lists the specified directory.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_mkdir(java.lang.Object, java.lang.String, java.awt.Component)">_mkdir</A></B>(java.lang.Object session,
- java.lang.String directory,
- java.awt.Component comp)</CODE>
- <BR>
- Creates a new directory with the specified URL.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_rename(java.lang.Object, java.lang.String, java.lang.String, java.awt.Component)">_rename</A></B>(java.lang.Object session,
- java.lang.String from,
- java.lang.String to,
- java.awt.Component comp)</CODE>
- <BR>
- Renames the specified URL.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#_saveComplete(java.lang.Object, org.gjt.sp.jedit.Buffer, java.lang.String, java.awt.Component)">_saveComplete</A></B>(java.lang.Object session,
- <A HREF="../../../../../org/gjt/sp/jedit/Buffer.html" title="class in org.gjt.sp.jedit">Buffer</A> buffer,
- java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- Called after a file has been saved.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#constructPath(java.lang.String, java.lang.String)">constructPath</A></B>(java.lang.String parent,
- java.lang.String path)</CODE>
- <BR>
- Constructs a path from the specified directory and
- file name component.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#copy(org.gjt.sp.util.ProgressObserver, java.lang.String, java.lang.String, java.awt.Component, boolean)">copy</A></B>(<A HREF="../../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util">ProgressObserver</A> progress,
- java.lang.String sourcePath,
- java.lang.String targetPath,
- java.awt.Component comp,
- boolean canStop)</CODE>
- <BR>
- Copy a file to another using VFS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#copy(org.gjt.sp.util.ProgressObserver, org.gjt.sp.jedit.io.VFS, java.lang.Object, java.lang.String, org.gjt.sp.jedit.io.VFS, java.lang.Object, java.lang.String, java.awt.Component, boolean)">copy</A></B>(<A HREF="../../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util">ProgressObserver</A> progress,
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html" title="class in org.gjt.sp.jedit.io">VFS</A> sourceVFS,
- java.lang.Object sourceSession,
- java.lang.String sourcePath,
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html" title="class in org.gjt.sp.jedit.io">VFS</A> targetVFS,
- java.lang.Object targetSession,
- java.lang.String targetPath,
- java.awt.Component comp,
- boolean canStop)</CODE>
- <BR>
- Copy a file to another using VFS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.Object</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#createVFSSession(java.lang.String, java.awt.Component)">createVFSSession</A></B>(java.lang.String path,
- java.awt.Component comp)</CODE>
- <BR>
- Creates a VFS session.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getCapabilities()">getCapabilities</A></B>()</CODE>
- <BR>
- Returns the capabilities of this VFS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.awt.Color</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getDefaultColorFor(java.lang.String)">getDefaultColorFor</A></B>(java.lang.String name)</CODE>
- <BR>
- Returns color of the specified file name, by matching it against
- user-specified regular expressions.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String[]</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getExtendedAttributes()">getExtendedAttributes</A></B>()</CODE>
- <BR>
- Returns the extended attributes supported by this VFS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getFileName(java.lang.String)">getFileName</A></B>(java.lang.String path)</CODE>
- <BR>
- Returns the file name component of the specified path.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> char</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getFileSeparator()">getFileSeparator</A></B>()</CODE>
- <BR>
- Returns the file separator used by this VFS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getName()">getName</A></B>()</CODE>
- <BR>
- Returns this VFS's name.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getParentOfPath(java.lang.String)">getParentOfPath</A></B>(java.lang.String path)</CODE>
- <BR>
- Returns the parent of the specified path.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#getTwoStageSaveName(java.lang.String)">getTwoStageSaveName</A></B>(java.lang.String path)</CODE>
- <BR>
- Returns a temporary file name based on the given path.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#insert(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)">insert</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
- <A HREF="../../../../../org/gjt/sp/jedit/Buffer.html" title="class in org.gjt.sp.jedit">Buffer</A> buffer,
- java.lang.String path)</CODE>
- <BR>
- Inserts a file into the specified buffer.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#isMarkersFileSupported()">isMarkersFileSupported</A></B>()</CODE>
- <BR>
- Returns if an additional markers file can be saved by this VFS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#load(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)">load</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
- <A HREF="../../../../../org/gjt/sp/jedit/Buffer.html" title="class in org.gjt.sp.jedit">Buffer</A> buffer,
- java.lang.String path)</CODE>
- <BR>
- Loads the specified buffer.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#reloadDirectory(java.lang.String)">reloadDirectory</A></B>(java.lang.String path)</CODE>
- <BR>
- Called before a directory is reloaded by the file system browser.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#save(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)">save</A></B>(<A HREF="../../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
- <A HREF="../../../../../org/gjt/sp/jedit/Buffer.html" title="class in org.gjt.sp.jedit">Buffer</A> buffer,
- java.lang.String path)</CODE>
- <BR>
- Saves the specifies buffer.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#showBrowseDialog(java.lang.Object[], java.awt.Component)">showBrowseDialog</A></B>(java.lang.Object[] session,
- java.awt.Component comp)</CODE>
- <BR>
- <B>Deprecated.</B> <I>This function is not used in the jEdit core anymore,
- so it doesn't have to be provided anymore. If you want
- to use it for another purpose like in the FTP plugin,
- feel free to do so.</I></TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ============ FIELD DETAIL =========== -->
- <A NAME="field_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Field Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="READ_CAP"><!-- --></A><H3>
- READ_CAP</H3>
- <PRE>
- public static final int <B>READ_CAP</B></PRE>
- <DL>
- <DD>Read capability.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre2</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.READ_CAP">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="WRITE_CAP"><!-- --></A><H3>
- WRITE_CAP</H3>
- <PRE>
- public static final int <B>WRITE_CAP</B></PRE>
- <DL>
- <DD>Write capability.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre2</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.WRITE_CAP">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="BROWSE_CAP"><!-- --></A><H3>
- BROWSE_CAP</H3>
- <PRE>
- public static final int <B>BROWSE_CAP</B></PRE>
- <DL>
- <DD>Browse capability
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre11
- This was the official API for adding items to a file
- system browser's <b>Plugins</b> menu in jEdit 4.1 and earlier. In
- jEdit 4.2, there is a different way of doing this, you must provide
- a <code>browser.actions.xml</code> file in your plugin JAR, and
- define <code>plugin.<i>class</i>.browser-menu-item</code>
- or <code>plugin.<i>class</i>.browser-menu</code> properties.
- See <A HREF="../../../../../org/gjt/sp/jedit/EditPlugin.html" title="class in org.gjt.sp.jedit"><CODE>EditPlugin</CODE></A> for details.</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.BROWSE_CAP">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="DELETE_CAP"><!-- --></A><H3>
- DELETE_CAP</H3>
- <PRE>
- public static final int <B>DELETE_CAP</B></PRE>
- <DL>
- <DD>Delete file capability.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre2</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.DELETE_CAP">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="RENAME_CAP"><!-- --></A><H3>
- RENAME_CAP</H3>
- <PRE>
- public static final int <B>RENAME_CAP</B></PRE>
- <DL>
- <DD>Rename file capability.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre2</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.RENAME_CAP">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="MKDIR_CAP"><!-- --></A><H3>
- MKDIR_CAP</H3>
- <PRE>
- public static final int <B>MKDIR_CAP</B></PRE>
- <DL>
- <DD>Make directory capability.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre2</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.MKDIR_CAP">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="LOW_LATENCY_CAP"><!-- --></A><H3>
- LOW_LATENCY_CAP</H3>
- <PRE>
- public static final int <B>LOW_LATENCY_CAP</B></PRE>
- <DL>
- <DD>Low latency capability. If this is not set, then a confirm dialog
- will be shown before doing a directory search in this VFS.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.1pre1</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.LOW_LATENCY_CAP">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="CASE_INSENSITIVE_CAP"><!-- --></A><H3>
- CASE_INSENSITIVE_CAP</H3>
- <PRE>
- public static final int <B>CASE_INSENSITIVE_CAP</B></PRE>
- <DL>
- <DD>Case insensitive file system capability.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.1pre1</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.CASE_INSENSITIVE_CAP">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="EA_TYPE"><!-- --></A><H3>
- EA_TYPE</H3>
- <PRE>
- public static final java.lang.String <B>EA_TYPE</B></PRE>
- <DL>
- <DD>File type.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.EA_TYPE">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="EA_STATUS"><!-- --></A><H3>
- EA_STATUS</H3>
- <PRE>
- public static final java.lang.String <B>EA_STATUS</B></PRE>
- <DL>
- <DD>File status (read only, read write, etc).
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.EA_STATUS">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="EA_SIZE"><!-- --></A><H3>
- EA_SIZE</H3>
- <PRE>
- public static final java.lang.String <B>EA_SIZE</B></PRE>
- <DL>
- <DD>File size.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.EA_SIZE">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="EA_MODIFIED"><!-- --></A><H3>
- EA_MODIFIED</H3>
- <PRE>
- public static final java.lang.String <B>EA_MODIFIED</B></PRE>
- <DL>
- <DD>File last modified date.
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.gjt.sp.jedit.io.VFS.EA_MODIFIED">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="IOBUFSIZE"><!-- --></A><H3>
- IOBUFSIZE</H3>
- <PRE>
- public static int <B>IOBUFSIZE</B></PRE>
- <DL>
- <DL>
- </DL>
- </DL>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <A NAME="constructor_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Constructor Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="VFS(java.lang.String)"><!-- --></A><H3>
- VFS</H3>
- <PRE>
- <FONT SIZE="-1">@Deprecated
- </FONT>protected <B>VFS</B>(java.lang.String name)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <I>Use the form where the constructor takes a capability
- list.</I>
- <P>
- </DL>
- <HR>
- <A NAME="VFS(java.lang.String, int)"><!-- --></A><H3>
- VFS</H3>
- <PRE>
- protected <B>VFS</B>(java.lang.String name,
- int caps)</PRE>
- <DL>
- <DD>Creates a new virtual filesystem.
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name<DD><CODE>caps</CODE> - The capabilities</DL>
- </DL>
- <HR>
- <A NAME="VFS(java.lang.String, int, java.lang.String[])"><!-- --></A><H3>
- VFS</H3>
- <PRE>
- protected <B>VFS</B>(java.lang.String name,
- int caps,
- java.lang.String[] extAttrs)</PRE>
- <DL>
- <DD>Creates a new virtual filesystem.
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name<DD><CODE>caps</CODE> - The capabilities<DD><CODE>extAttrs</CODE> - The extended attributes<DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- </DL>
- </DL>
- <!-- ============ METHOD DETAIL ========== -->
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="getName()"><!-- --></A><H3>
- getName</H3>
- <PRE>
- public java.lang.String <B>getName</B>()</PRE>
- <DL>
- <DD>Returns this VFS's name. The name is used to obtain the
- label stored in the <code>vfs.<i>name</i>.label</code>
- property.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getCapabilities()"><!-- --></A><H3>
- getCapabilities</H3>
- <PRE>
- public int <B>getCapabilities</B>()</PRE>
- <DL>
- <DD>Returns the capabilities of this VFS.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="isMarkersFileSupported()"><!-- --></A><H3>
- isMarkersFileSupported</H3>
- <PRE>
- public boolean <B>isMarkersFileSupported</B>()</PRE>
- <DL>
- <DD>Returns if an additional markers file can be saved by this VFS.
- Default is <code>true</code>.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre10</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getExtendedAttributes()"><!-- --></A><H3>
- getExtendedAttributes</H3>
- <PRE>
- public java.lang.String[] <B>getExtendedAttributes</B>()</PRE>
- <DL>
- <DD>Returns the extended attributes supported by this VFS.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.2pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="showBrowseDialog(java.lang.Object[], java.awt.Component)"><!-- --></A><H3>
- showBrowseDialog</H3>
- <PRE>
- <FONT SIZE="-1">@Deprecated
- </FONT>public java.lang.String <B>showBrowseDialog</B>(java.lang.Object[] session,
- java.awt.Component comp)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <I>This function is not used in the jEdit core anymore,
- so it doesn't have to be provided anymore. If you want
- to use it for another purpose like in the FTP plugin,
- feel free to do so.</I>
- <P>
- <DD>Displays a dialog box that should set up a session and return
- the initial URL to browse.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>session</CODE> - Where the VFS session will be stored<DD><CODE>comp</CODE> - The component that will parent error dialog boxes
- <DT><B>Returns:</B><DD>The URL<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getFileName(java.lang.String)"><!-- --></A><H3>
- getFileName</H3>
- <PRE>
- public java.lang.String <B>getFileName</B>(java.lang.String path)</PRE>
- <DL>
- <DD>Returns the file name component of the specified path.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>path</CODE> - The path<DT><B>Since:</B></DT>
- <DD>jEdit 3.1pre4</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getParentOfPath(java.lang.String)"><!-- --></A><H3>
- getParentOfPath</H3>
- <PRE>
- public java.lang.String <B>getParentOfPath</B>(java.lang.String path)</PRE>
- <DL>
- <DD>Returns the parent of the specified path. This must be
- overridden to return a non-null value for browsing of this
- filesystem to work.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>path</CODE> - The path<DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="constructPath(java.lang.String, java.lang.String)"><!-- --></A><H3>
- constructPath</H3>
- <PRE>
- public java.lang.String <B>constructPath</B>(java.lang.String parent,
- java.lang.String path)</PRE>
- <DL>
- <DD>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.<p>
- Unless you are writing a VFS, this method should not be called
- directly. To ensure correct behavior, you <b>must</b> call
- <A HREF="../../../../../org/gjt/sp/jedit/MiscUtilities.html#constructPath(java.lang.String, java.lang.String)"><CODE>MiscUtilities.constructPath(String,String)</CODE></A>
- instead.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>parent</CODE> - The parent directory<DD><CODE>path</CODE> - The path<DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getFileSeparator()"><!-- --></A><H3>
- getFileSeparator</H3>
- <PRE>
- public char <B>getFileSeparator</B>()</PRE>
- <DL>
- <DD>Returns the file separator used by this VFS.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre9</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getTwoStageSaveName(java.lang.String)"><!-- --></A><H3>
- getTwoStageSaveName</H3>
- <PRE>
- public java.lang.String <B>getTwoStageSaveName</B>(java.lang.String path)</PRE>
- <DL>
- <DD>Returns a temporary file name based on the given path.
- By default jEdit first saves a file to <code>#<i>name</i>#save#</code>
- and then renames it to the original file. However some virtual file
- systems might not support the <code>#</code> character in filenames,
- so this method permits the VFS to override this behavior.
- If this method returns <code>null</code>, two stage save will not
- be used for that particular file (introduced in jEdit 4.3pre1).
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>path</CODE> - The path name<DT><B>Since:</B></DT>
- <DD>jEdit 4.1pre7</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="reloadDirectory(java.lang.String)"><!-- --></A><H3>
- reloadDirectory</H3>
- <PRE>
- public void <B>reloadDirectory</B>(java.lang.String path)</PRE>
- <DL>
- <DD>Called before a directory is reloaded by the file system browser.
- Can be used to flush a cache, etc.
- <P>
- <DD><DL>
- <DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre3</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="createVFSSession(java.lang.String, java.awt.Component)"><!-- --></A><H3>
- createVFSSession</H3>
- <PRE>
- public java.lang.Object <B>createVFSSession</B>(java.lang.String path,
- java.awt.Component comp)</PRE>
- <DL>
- <DD>Creates a VFS session. This method is called from the AWT thread,
- so it should not do any I/O. It could, however, prompt for
- a login name and password, for example.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>path</CODE> - The path in question<DD><CODE>comp</CODE> - The component that will parent any dialog boxes shown
- <DT><B>Returns:</B><DD>The session. The session can be null if there were errors<DT><B>Since:</B></DT>
- <DD>jEdit 2.6pre3</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="load(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)"><!-- --></A><H3>
- load</H3>
- <PRE>
- public boolean <B>load</B>(<A HREF="../../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
- <A HREF="../../../../../org/gjt/sp/jedit/Buffer.html" title="class in org.gjt.sp.jedit">Buffer</A> buffer,
- java.lang.String path)</PRE>
- <DL>
- <DD>Loads the specified buffer. The default implementation posts
- an I/O request to the I/O thread.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DD><CODE>buffer</CODE> - The buffer<DD><CODE>path</CODE> - The path</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="save(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)"><!-- --></A><H3>
- save</H3>
- <PRE>
- public boolean <B>save</B>(<A HREF="../../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
- <A HREF="../../../../../org/gjt/sp/jedit/Buffer.html" title="class in org.gjt.sp.jedit">Buffer</A> buffer,
- java.lang.String path)</PRE>
- <DL>
- <DD>Saves the specifies buffer. The default implementation posts
- an I/O request to the I/O thread.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DD><CODE>buffer</CODE> - The buffer<DD><CODE>path</CODE> - The path</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="copy(org.gjt.sp.util.ProgressObserver, org.gjt.sp.jedit.io.VFS, java.lang.Object, java.lang.String, org.gjt.sp.jedit.io.VFS, java.lang.Object, java.lang.String, java.awt.Component, boolean)"><!-- --></A><H3>
- copy</H3>
- <PRE>
- public static boolean <B>copy</B>(<A HREF="../../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util">ProgressObserver</A> progress,
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html" title="class in org.gjt.sp.jedit.io">VFS</A> sourceVFS,
- java.lang.Object sourceSession,
- java.lang.String sourcePath,
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html" title="class in org.gjt.sp.jedit.io">VFS</A> targetVFS,
- java.lang.Object targetSession,
- java.lang.String targetPath,
- java.awt.Component comp,
- boolean canStop)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Copy a file to another using VFS.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>progress</CODE> - the progress observer. It could be null if you don't want to monitor progress. If not null
- you should probably launch this command in a WorkThread<DD><CODE>sourceVFS</CODE> - the source VFS<DD><CODE>sourceSession</CODE> - the VFS session<DD><CODE>sourcePath</CODE> - the source path<DD><CODE>targetVFS</CODE> - the target VFS<DD><CODE>targetSession</CODE> - the target session<DD><CODE>targetPath</CODE> - the target path<DD><CODE>comp</CODE> - comp The component that will parent error dialog boxes<DD><CODE>canStop</CODE> - could this copy be stopped ?
- <DT><B>Returns:</B><DD>true if the copy was successful
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - IOException If an I/O error occurs<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre3</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="copy(org.gjt.sp.util.ProgressObserver, java.lang.String, java.lang.String, java.awt.Component, boolean)"><!-- --></A><H3>
- copy</H3>
- <PRE>
- public static boolean <B>copy</B>(<A HREF="../../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util">ProgressObserver</A> progress,
- java.lang.String sourcePath,
- java.lang.String targetPath,
- java.awt.Component comp,
- boolean canStop)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Copy a file to another using VFS.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>progress</CODE> - the progress observer. It could be null if you don't want to monitor progress. If not null
- you should probably launch this command in a WorkThread<DD><CODE>sourcePath</CODE> - the source path<DD><CODE>targetPath</CODE> - the target path<DD><CODE>comp</CODE> - comp The component that will parent error dialog boxes<DD><CODE>canStop</CODE> - if true the copy can be stopped
- <DT><B>Returns:</B><DD>true if the copy was successful
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - IOException If an I/O error occurs<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre3</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="insert(org.gjt.sp.jedit.View, org.gjt.sp.jedit.Buffer, java.lang.String)"><!-- --></A><H3>
- insert</H3>
- <PRE>
- public boolean <B>insert</B>(<A HREF="../../../../../org/gjt/sp/jedit/View.html" title="class in org.gjt.sp.jedit">View</A> view,
- <A HREF="../../../../../org/gjt/sp/jedit/Buffer.html" title="class in org.gjt.sp.jedit">Buffer</A> buffer,
- java.lang.String path)</PRE>
- <DL>
- <DD>Inserts a file into the specified buffer. The default implementation
- posts an I/O request to the I/O thread.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>view</CODE> - The view<DD><CODE>buffer</CODE> - The buffer<DD><CODE>path</CODE> - The path</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_canonPath(java.lang.Object, java.lang.String, java.awt.Component)"><!-- --></A><H3>
- _canonPath</H3>
- <PRE>
- public java.lang.String <B>_canonPath</B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Returns the canonical form of the specified path name. For example,
- <code>~</code> might be expanded to the user's home directory.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>session</CODE> - The session<DD><CODE>path</CODE> - The path<DD><CODE>comp</CODE> - The component that will parent error dialog boxes
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - if an I/O error occurred<DT><B>Since:</B></DT>
- <DD>jEdit 4.0pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_listDirectory(java.lang.Object, java.lang.String, java.lang.String, boolean, java.awt.Component)"><!-- --></A><H3>
- _listDirectory</H3>
- <PRE>
- public java.lang.String[] <B>_listDirectory</B>(java.lang.Object session,
- java.lang.String directory,
- java.lang.String glob,
- boolean recursive,
- java.awt.Component comp)
- throws java.io.IOException</PRE>
- <DL>
- <DD>A convinience method that matches file names against globs, and can
- optionally list the directory recursively.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>session</CODE> - The session<DD><CODE>directory</CODE> - 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.<DD><CODE>glob</CODE> - Only file names matching this glob will be returned<DD><CODE>recursive</CODE> - If true, subdirectories will also be listed.<DD><CODE>comp</CODE> - The component that will parent error dialog boxes
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - if an I/O error occurred<DT><B>Since:</B></DT>
- <DD>jEdit 4.1pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_listDirectory(java.lang.Object, java.lang.String, java.lang.String, boolean, java.awt.Component, boolean, boolean)"><!-- --></A><H3>
- _listDirectory</H3>
- <PRE>
- public java.lang.String[] <B>_listDirectory</B>(java.lang.Object session,
- java.lang.String directory,
- java.lang.String glob,
- boolean recursive,
- java.awt.Component comp,
- boolean skipBinary,
- boolean skipHidden)
- throws java.io.IOException</PRE>
- <DL>
- <DD>A convinience method that matches file names against globs, and can
- optionally list the directory recursively.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>session</CODE> - The session<DD><CODE>directory</CODE> - 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.<DD><CODE>glob</CODE> - Only file names matching this glob will be returned<DD><CODE>recursive</CODE> - If true, subdirectories will also be listed.<DD><CODE>comp</CODE> - The component that will parent error dialog boxes<DD><CODE>skipBinary</CODE> - ignore binary files (do not return them).
- This will slow down the process since it will open the files<DD><CODE>skipHidden</CODE> - skips hidden files, directories, and
- backup files. Ignores any file beginning with . or #, or ending with ~
- or .bak
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - if an I/O error occurred<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_listDirectory(java.lang.Object, java.lang.String, org.gjt.sp.jedit.io.VFSFileFilter, boolean, java.awt.Component, boolean, boolean)"><!-- --></A><H3>
- _listDirectory</H3>
- <PRE>
- public java.lang.String[] <B>_listDirectory</B>(java.lang.Object session,
- java.lang.String directory,
- <A HREF="../../../../../org/gjt/sp/jedit/io/VFSFileFilter.html" title="interface in org.gjt.sp.jedit.io">VFSFileFilter</A> filter,
- boolean recursive,
- java.awt.Component comp,
- boolean skipBinary,
- boolean skipHidden)
- throws java.io.IOException</PRE>
- <DL>
- <DD>A convinience method that filters the directory listing
- according to a filter, and can optionally list the directory
- recursively.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>session</CODE> - The session<DD><CODE>directory</CODE> - 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.<DD><CODE>filter</CODE> - The <A HREF="../../../../../org/gjt/sp/jedit/io/VFSFileFilter.html" title="interface in org.gjt.sp.jedit.io"><CODE>VFSFileFilter</CODE></A> to use for filtering.<DD><CODE>recursive</CODE> - If true, subdirectories will also be listed.<DD><CODE>comp</CODE> - The component that will parent error dialog boxes<DD><CODE>skipBinary</CODE> - ignore binary files (do not return them).
- This will slow down the process since it will open the files<DD><CODE>skipHidden</CODE> - skips hidden files, directories, and
- backup files. Ignores any file beginning with . or #, or ending with ~
- or .bak
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - if an I/O error occurred<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre7</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_listFiles(java.lang.Object, java.lang.String, java.awt.Component)"><!-- --></A><H3>
- _listFiles</H3>
- <PRE>
- public <A HREF="../../../../../org/gjt/sp/jedit/io/VFSFile.html" title="class in org.gjt.sp.jedit.io">VFSFile</A>[] <B>_listFiles</B>(java.lang.Object session,
- java.lang.String directory,
- java.awt.Component comp)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Lists the specified directory.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>session</CODE> - The session<DD><CODE>directory</CODE> - 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.<DD><CODE>comp</CODE> - The component that will parent error dialog boxes
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - if an I/O error occurred<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_listDirectory(java.lang.Object, java.lang.String, java.awt.Component)"><!-- --></A><H3>
- _listDirectory</H3>
- <PRE>
- <FONT SIZE="-1">@Deprecated
- </FONT>public <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.DirectoryEntry.html" title="class in org.gjt.sp.jedit.io">VFS.DirectoryEntry</A>[] <B>_listDirectory</B>(java.lang.Object session,
- java.lang.String directory,
- java.awt.Component comp)
- throws java.io.IOException</PRE>
- <DL>
- <DD><B>Deprecated.</B> <I>Use <code>_listFiles()</code> instead.</I>
- <P>
- <DD><DL>
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE></DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_getFile(java.lang.Object, java.lang.String, java.awt.Component)"><!-- --></A><H3>
- _getFile</H3>
- <PRE>
- public <A HREF="../../../../../org/gjt/sp/jedit/io/VFSFile.html" title="class in org.gjt.sp.jedit.io">VFSFile</A> <B>_getFile</B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Returns the specified directory entry.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>session</CODE> - The session get it with <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#createVFSSession(java.lang.String, java.awt.Component)"><CODE>createVFSSession(String, Component)</CODE></A><DD><CODE>path</CODE> - The path<DD><CODE>comp</CODE> - The component that will parent error dialog boxes
- <DT><B>Returns:</B><DD>The specified directory entry, or null if it doesn't exist.
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - if an I/O error occurred<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre2</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_getDirectoryEntry(java.lang.Object, java.lang.String, java.awt.Component)"><!-- --></A><H3>
- _getDirectoryEntry</H3>
- <PRE>
- <FONT SIZE="-1">@Deprecated
- </FONT>public <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.DirectoryEntry.html" title="class in org.gjt.sp.jedit.io">VFS.DirectoryEntry</A> <B>_getDirectoryEntry</B>(java.lang.Object session,
- java.lang.String path,
- java.awt.Component comp)
- throws java.io.IOException</PRE>
- <DL>
- <DD><B>Deprecated.</B> <I>Use <code>_getFile()</code> instead.</I>
- <P>
- <DD>Returns the specified directory entry.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>session</CODE> - The session get it with <A HREF="../../../../../org/gjt/sp/jedit/io/VFS.html#createVFSSession(java.lang.String, java.awt.Component)"><CODE>createVFSSession(String, Component)</CODE></A><DD><CODE>path</CODE> - The path<DD><CODE>comp</CODE> - The component that will parent error dialog boxes
- <DT><B>Returns:</B><DD>The specified directory entry, or null if it doesn't exist.
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - if an I/O error occurred<DT><B>Since:</B></DT>
- <DD>jEdit 2.7pre1</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="_delete(java.lang.Object, java.lang.String, java.awt.Component)"><!-- --></A><H3