|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.filesystem.EFS
This class is the main entry point for clients of the Eclipse file system API. This class has factory methods for obtaining instances of file systems and file stores, and provides constants for option values and error codes.
This class is not intended to be instantiated or subclassed.
Field Summary | |
---|---|
static int |
APPEND
Option flag constant (value 1 <<0) indicating a file opened for appending data to the end. |
static int |
ATTRIBUTE_ARCHIVE
Attribute constant (value 1 <<3) indicating that a file is an archive. |
static int |
ATTRIBUTE_EXECUTABLE
Attribute constant (value 1 <<2) indicating that a file is a executable. |
static int |
ATTRIBUTE_HIDDEN
Attribute constant (value 1 <<4) indicating that a file is hidden. |
static int |
ATTRIBUTE_LINK_TARGET
Attribute constant (value 1 <<6) for a string attribute indicating the target file name of a symbolic link. |
static int |
ATTRIBUTE_READ_ONLY
Attribute constant (value 1 <<1) indicating that a file is read only. |
static int |
ATTRIBUTE_SYMLINK
Attribute constant (value 1 <<5) indicating that a file is a symbolic link. |
static int |
CACHE
Option flag constant (value 1 <<12) indicating that a cached representation of a file should be returned. |
static int |
ERROR_CASE_VARIANT_EXISTS
Status code constant (value 275) indicating this file system is not case sensitive and a file that differs only in case unexpectedly exists on the file system. |
static int |
ERROR_DELETE
Status code constant (value 273) indicating an error occurred while deleting from the file system. |
static int |
ERROR_EXISTS
Status code constant (value 268) indicating a store unexpectedly exists on the file system. |
static int |
ERROR_INTERNAL
Status code constant (value 566) indicating an error internal has occurred. |
static int |
ERROR_NO_LOCATION
Status code constant (value 270) indicating the file system location for a store could not be computed. |
static int |
ERROR_NOT_EXISTS
Status code constant (value 269) indicating a store unexpectedly does not exist on the file system. |
static int |
ERROR_PARENT_READ_ONLY
Status code constant (value 277) indicating that the parent file in the file system is marked as read-only. |
static int |
ERROR_READ
Status code constant (value 271) indicating an error occurred while reading from the file system. |
static int |
ERROR_READ_ONLY
Status code constant (value 279) indicating that the file in the file system is marked as read-only. |
static int |
ERROR_WRITE
Status code constant (value 272) indicating an error occurred while writing to the file system. |
static int |
ERROR_WRONG_TYPE
Status code constant (value 276) indicating a file exists in the file system but is not of the expected type (file instead of directory, or vice-versa). |
static int |
NONE
A constant known to be zero (0), used in operations which take bit flags to indicate that "no bits are set". |
static int |
OVERWRITE
Option flag constant (value 1 <<1) indicating that existing files may be overwritten. |
static String |
PI_FILE_SYSTEM
The unique identifier constant (value " org.eclipse.core.filesystem ")
of the Core file system plug-in. |
static String |
PT_FILE_SYSTEMS
The simple identifier constant (value " filesystems ") of
the extension point of the Core file system plug-in where plug-ins declare
file system implementations. |
static String |
SCHEME_FILE
Scheme constant (value "file") indicating the local file system scheme. |
static String |
SCHEME_NULL
Scheme constant (value "null") indicating the null file system scheme. |
static int |
SET_ATTRIBUTES
Option flag constant (value 1 <<10) indicating that a file's attributes should be updated. |
static int |
SET_LAST_MODIFIED
Option flag constant (value 1 <<11) indicating that a file's last modified time should be updated. |
static int |
SHALLOW
Option flag constant (value 1 <<2) indicating that an operation acts on a single file or directory, and not its parents or children. |
Method Summary | |
---|---|
static IFileInfo |
createFileInfo()
Creates an empty file information object. |
static IFileSystem |
getFileSystem(String scheme)
Returns a file system corresponding to the given scheme. |
static IFileSystem |
getLocalFileSystem()
Returns the local file system. |
static IFileSystem |
getNullFileSystem()
Returns the null file system. |
static IFileStore |
getStore(URI uri)
Returns the file store corresponding to the provided URI. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String PI_FILE_SYSTEM
org.eclipse.core.filesystem
")
of the Core file system plug-in.
public static final String PT_FILE_SYSTEMS
filesystems
") of
the extension point of the Core file system plug-in where plug-ins declare
file system implementations.
public static final int NONE
IFileInfo.getLength()
,
IFileInfo.getLastModified()
,
Constant Field Valuespublic static final int APPEND
IFileStore.openOutputStream(int, IProgressMonitor)
,
Constant Field Valuespublic static final int OVERWRITE
IFileStore.copy(IFileStore, int, IProgressMonitor)
,
IFileStore.move(IFileStore, int, IProgressMonitor)
,
Constant Field Valuespublic static final int SHALLOW
IFileStore.copy(IFileStore, int, IProgressMonitor)
,
IFileStore.mkdir(int, IProgressMonitor)
,
Constant Field Valuespublic static final int SET_ATTRIBUTES
IFileStore.putInfo(IFileInfo, int, IProgressMonitor)
,
Constant Field Valuespublic static final int SET_LAST_MODIFIED
IFileStore.putInfo(IFileInfo, int, IProgressMonitor)
,
Constant Field Valuespublic static final int CACHE
IFileStore.toLocalFile(int, IProgressMonitor)
,
Constant Field Valuespublic static final int ATTRIBUTE_READ_ONLY
IFileStore.fetchInfo()
,
IFileStore.putInfo(IFileInfo, int, IProgressMonitor)
,
IFileInfo.getAttribute(int)
,
IFileInfo.setAttribute(int, boolean)
,
Constant Field Valuespublic static final int ATTRIBUTE_EXECUTABLE
IFileStore.fetchInfo()
,
IFileStore.putInfo(IFileInfo, int, IProgressMonitor)
,
IFileInfo.getAttribute(int)
,
IFileInfo.setAttribute(int, boolean)
,
Constant Field Valuespublic static final int ATTRIBUTE_ARCHIVE
IFileStore.fetchInfo()
,
IFileStore.putInfo(IFileInfo, int, IProgressMonitor)
,
IFileInfo.getAttribute(int)
,
IFileInfo.setAttribute(int, boolean)
,
Constant Field Valuespublic static final int ATTRIBUTE_HIDDEN
IFileStore.fetchInfo()
,
IFileStore.putInfo(IFileInfo, int, IProgressMonitor)
,
IFileInfo.getAttribute(int)
,
IFileInfo.setAttribute(int, boolean)
,
Constant Field Valuespublic static final int ATTRIBUTE_SYMLINK
If this attribute is true
for a given IFileInfo
instance, a String value may be associated with the attribute
holding the symbolic link target. This link target can be
retrieved with IFileInfo.getStringAttribute(int)
with attribute
type ATTRIBUTE_LINK_TARGET
.
Symbolic links are handled transparently, as implemented by the
underlying operating system. This means, that all other attributes
of a IFileInfo
apply to the link target instead of the link.
Reading or writing a file, or changing attributes applies to the
link target and not the link itself. In case a symbolic link points
to another symbolic link, the chain of links is transparently followed
and operations apply to the actual file or directory being referenced
by the chain of symbolic links.
Broken symbolic links (which do not reference any valid file or directory)
are being returned by IFileStore.childInfos(int, IProgressMonitor)
,
but IFileInfo.exists()
returns false
for these.
Operations like reading or writing on broken symbolic links throw
a "file not found" exception.
IFileStore.fetchInfo()
,
IFileStore.putInfo(IFileInfo, int, IProgressMonitor)
,
IFileInfo.getAttribute(int)
,
IFileInfo.setAttribute(int, boolean)
,
Constant Field Valuespublic static final int ATTRIBUTE_LINK_TARGET
Note that setting the link target attribute does not cause a symbolic link to be created, or changed to link to a different file. Rather, this attribute is set by file system implementations based on the current state of a link.
IFileInfo.getStringAttribute(int)
,
FileInfo.setStringAttribute(int, String)
,
ATTRIBUTE_SYMLINK
,
Constant Field Valuespublic static final String SCHEME_FILE
getLocalFileSystem()
,
Constant Field Valuespublic static final String SCHEME_NULL
getNullFileSystem()
,
Constant Field Valuespublic static final int ERROR_EXISTS
public static final int ERROR_NOT_EXISTS
public static final int ERROR_NO_LOCATION
public static final int ERROR_READ
public static final int ERROR_WRITE
public static final int ERROR_DELETE
public static final int ERROR_CASE_VARIANT_EXISTS
public static final int ERROR_WRONG_TYPE
public static final int ERROR_PARENT_READ_ONLY
public static final int ERROR_READ_ONLY
public static final int ERROR_INTERNAL
Method Detail |
public static IFileInfo createFileInfo()
IFileStore.putInfo(IFileInfo, int, IProgressMonitor)
public static IFileSystem getFileSystem(String scheme) throws CoreException
scheme
- The file system URI scheme
CoreException
- if this method fails. Reasons include:
public static IFileSystem getLocalFileSystem()
public static IFileSystem getNullFileSystem()
Basic handle-based queries can be performed on the null file system, but all operations that actually require file system access will fail.
public static IFileStore getStore(URI uri) throws CoreException
uri
- The URI of the file store to return
CoreException
- if this method fails. Reasons include:
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.