Package org.eclipse.core.filesystem

Class EFS

java.lang.Object
org.eclipse.core.filesystem.EFS
public class EFS extends Object
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.
Since:
org.eclipse.core.filesystem 1.0
Restriction:
This class is not intended to be subclassed by clients.
Restriction:
This class is not intended to be instantiated by clients.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    APPEND
    Option flag constant (value 1 <<0) indicating a file opened for appending data to the end.
    static final int
    ATTRIBUTE_ARCHIVE
    Attribute constant (value 1 <<3) indicating that a file is an archive.
    static final int
    ATTRIBUTE_EXECUTABLE
    Attribute constant (value 1 <<2) indicating that a file is a executable.
    static final int
    ATTRIBUTE_GROUP_EXECUTE
    Attribute constant (value 1 <<27) indicating that users in file's group have an execute permission.
    static final int
    ATTRIBUTE_GROUP_READ
    Attribute constant (value 1 <<25) indicating that users in file's group have a read permission.
    static final int
    ATTRIBUTE_GROUP_WRITE
    Attribute constant (value 1 <<26) indicating that users in file's group have a write permission.
    static final int
    ATTRIBUTE_HIDDEN
    Attribute constant (value 1 <<4) indicating that a file is hidden.
    static final int
    ATTRIBUTE_IMMUTABLE
    Attribute constant (value 1 <<21) indicating that a file is marked with immutable flag.
    static final int
    ATTRIBUTE_LINK_TARGET
    Attribute constant (value 1 <<6) for a string attribute indicating the target file name of a symbolic link.
    static final int
    ATTRIBUTE_OTHER_EXECUTE
    Attribute constant (value 1 <<30) indicating that other users have an execute permission.
    static final int
    ATTRIBUTE_OTHER_READ
    Attribute constant (value 1 <<28) indicating that other users have a read permission.
    static final int
    ATTRIBUTE_OTHER_WRITE
    Attribute constant (value 1 <<29) indicating that other users have a write permission.
    static final int
    ATTRIBUTE_OWNER_EXECUTE
    Attribute constant (value 1 <<24) indicating that file's owner has an execute permission.
    static final int
    ATTRIBUTE_OWNER_READ
    Attribute constant (value 1 <<22) indicating that a file's owner has a read permission.
    static final int
    ATTRIBUTE_OWNER_WRITE
    Attribute constant (value 1 <<23) indicating that file's owner has a write permission.
    static final int
    ATTRIBUTE_READ_ONLY
    Attribute constant (value 1 <<1) indicating that a file is read only.
    static final int
    ATTRIBUTE_SYMLINK
    Attribute constant (value 1 <<5) indicating that a file is a symbolic link.
    static final int
    CACHE
    Option flag constant (value 1 <<12) indicating that a cached representation of a file should be returned.
    static final int
    ERROR_AUTH_FAILED
    Status code constant (value 280) indicating that the file system failed to authenticate the request.
    static final 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 final int
    ERROR_DELETE
    Status code constant (value 273) indicating an error occurred while deleting from the file system.
    static final int
    ERROR_EXISTS
    Status code constant (value 268) indicating a store unexpectedly exists on the file system.
    static final int
    ERROR_INTERNAL
    Status code constant (value 566) indicating an internal error has occurred.
    static final int
    ERROR_NO_LOCATION
    Status code constant (value 270) indicating the file system location for a store could not be computed.
    static final int
    ERROR_NOT_EXISTS
    Status code constant (value 269) indicating a store unexpectedly does not exist on the file system.
    static final 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 final int
    ERROR_READ
    Status code constant (value 271) indicating an error occurred while reading from the file system.
    static final int
    ERROR_READ_ONLY
    Status code constant (value 279) indicating that the file in the file system is marked as read-only.
    static final int
    ERROR_WRITE
    Status code constant (value 272) indicating an error occurred while writing to the file system.
    static final 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 final int
    NONE
    A constant known to be zero (0), used in operations which take bit flags to indicate that "no bits are set".
    static final int
    OVERWRITE
    Option flag constant (value 1 <<1) indicating that existing files may be overwritten.
    static final String
    PI_FILE_SYSTEM
    The unique identifier constant (value "org.eclipse.core.filesystem") of the Core file system plug-in.
    static final 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 final String
    SCHEME_FILE
    Scheme constant (value "file") indicating the local file system scheme.
    static final String
    SCHEME_NULL
    Scheme constant (value "null") indicating the null file system scheme.
    static final int
    SET_ATTRIBUTES
    Option flag constant (value 1 <<10) indicating that a file's attributes should be updated.
    static final int
    SET_LAST_MODIFIED
    Option flag constant (value 1 <<11) indicating that a file's last modified time should be updated.
    static final 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

    Modifier and Type
    Method
    Description
    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