org.eclipse.core.filesystem
Interface IFileSystem

All Superinterfaces:

IAdaptable

All Known Implementing Classes:

FileSystem

public interface IFileSystem

extends IAdaptable

This is the main interface to a single file system. Each file system instance manages interaction with all files in the backing store represented by a particular URI scheme.

File systems are registered using the "filesystems" extension point.

This interface is not intended to be implemented by clients. File system implementations must subclass FileSystem rather than implementing this interface directly.

Since:

org.eclipse.core.filesystem 1.0

See Also:

EFS.getFileSystem(String)

Method Summary

int	attributes() Returns the file attributes supported by this file system.
boolean	canDelete() Returns whether this file system supports deletion
boolean	canWrite() Returns whether this file system supports modification.
String	getScheme() Returns the URI scheme of this file system.
IFileStore	getStore(IPath path) Returns a handle to a file store in this file system.
IFileStore	getStore(URI uri) Returns a handle to a file store in this file system.
boolean	isCaseSensitive() Returns whether this file system is case sensitive.

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

attributes

public int attributes()

Returns the file attributes supported by this file system. This value is a bit mask of the EFS.ATTRIBUTE_* constants.

Returns:

the file attributes supported by this file system.

canDelete

public boolean canDelete()

Returns whether this file system supports deletion

Returns:

true if this file system allows deletion of files and directories, and false otherwise.

canWrite

public boolean canWrite()

Returns whether this file system supports modification.

Returns:

true if this file system allows modification of files and directories, and false otherwise.

getScheme

public String getScheme()

Returns the URI scheme of this file system.

Returns:

the URI scheme of this file system.

getStore

public IFileStore getStore(IPath path)

Returns a handle to a file store in this file system. This method succeeds regardless of whether a file exists at that path in this file system.

This is a convenience method for file systems that do not make use of the authority URI component, such as a host or user information. The provided path argument is interpreted as the path component of the file system's URI.

Parameters:

path - A path to a file store within the scheme of this file system.

Returns:

A handle to a file store in this file system

getStore

public IFileStore getStore(URI uri)

Returns a handle to a file store in this file system. This method succeeds regardless of whether a file exists at that path in this file system.

Parameters:

uri - The URI of the file store to return.

Returns:

A handle to a file store in this file system

isCaseSensitive

public boolean isCaseSensitive()

Returns whether this file system is case sensitive. A case sensitive file system treats files with names that differ only in case as different files. For example, "HELLO", "Hello", and "hello" would be three different files or directories in a case sensitive file system.

Returns:

true if this file system is case sensitive, and false otherwise.