org.eclipse.xtext.xbase.file

Class ParallelFileSystemSupport

java.lang.Object

org.eclipse.xtext.xbase.file.ParallelFileSystemSupport

All Implemented Interfaces:

FileSystemSupport, MutableFileSystemSupport

public class ParallelFileSystemSupport
extends java.lang.Object
implements MutableFileSystemSupport

Author:

kosyakov - Initial contribution and API

Constructor Summary

Constructors

Constructor and Description
ParallelFileSystemSupport(org.eclipse.emf.common.util.URI uri, MutableFileSystemSupport delegate, FileSystemAccessQueue queue)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Path path) Deletes the file or folder the given path points to.
boolean	exists(Path path)
java.lang.String	getCharset(Path path) Returns the name of a charset to be used when decoding the contents of this file into characters.
java.lang.Iterable<? extends Path>	getChildren(Path path)
java.lang.CharSequence	getContents(Path path) Returns the contents of this file as a char sequence.
java.io.InputStream	getContentsAsStream(Path path) Returns an open input stream on the contents of this file.
long	getLastModification(Path path)
boolean	isFile(Path path)
boolean	isFolder(Path path)
void	mkdir(Path path) Creates a directory for the given path and all its parents if necessary.
void	setContents(Path path, java.lang.CharSequence contents) Writes the given contents to the given path.
void	setContentsAsStream(Path path, java.io.InputStream source) Sets the contents of this file to the bytes in the given input stream.
java.net.URI	toURI(Path path) Returns the URI representing the given path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParallelFileSystemSupport

public ParallelFileSystemSupport(org.eclipse.emf.common.util.URI uri,
                         MutableFileSystemSupport delegate,
                         FileSystemAccessQueue queue)

Method Detail

delete

public void delete(Path path)

Description copied from interface: MutableFileSystemSupport

Deletes the file or folder the given path points to. If path points to a folder this method will also delete all its contents. Implementors may decide to perform this method asynchronously. Clients should not rely on invocation timing.

Specified by:

delete in interface MutableFileSystemSupport

mkdir

public void mkdir(Path path)

Description copied from interface: MutableFileSystemSupport

Creates a directory for the given path and all its parents if necessary. Implementors may decide to perform this method asynchronously. Clients should not rely on invocation timing.

Specified by:

mkdir in interface MutableFileSystemSupport

Parameters:

path - the path to the file

setContents

public void setContents(Path path,
               java.lang.CharSequence contents)

Description copied from interface: MutableFileSystemSupport

Writes the given contents to the given path. It will create the file if it doesn't exist, and create folders for all parents if the don't exist. Implementors may decide to perform this method asynchronously. Clients should not rely on invocation timing.

Specified by:

setContents in interface MutableFileSystemSupport

Parameters:

path - the path to write the contents to

contents - the contents of the file

setContentsAsStream

public void setContentsAsStream(Path path,
                       java.io.InputStream source)

Description copied from interface: MutableFileSystemSupport

Sets the contents of this file to the bytes in the given input stream. The stream will be closed after the operation has finished. Implementors may decide to perform this method asynchronously. Clients should not rely on invocation timing.

Specified by:

setContentsAsStream in interface MutableFileSystemSupport

Parameters:

path - the path to the file

source - an input stream containing the new contents of the file

exists

public boolean exists(Path path)

Specified by:

exists in interface FileSystemSupport

Parameters:

path - the path

Returns:

whether the given path points to an existent file.

getCharset

public java.lang.String getCharset(Path path)

Description copied from interface: FileSystemSupport

Returns the name of a charset to be used when decoding the contents of this file into characters.

Specified by:

getCharset in interface FileSystemSupport

Parameters:

path - the path

Returns:

the name of a charset

getChildren

public java.lang.Iterable<? extends Path> getChildren(Path path)

Specified by:

getChildren in interface FileSystemSupport

Returns:

the children of the folder the given path points to; empty iterable if the path points to a non existent resource or to an existent file

getContents

public java.lang.CharSequence getContents(Path path)

Description copied from interface: FileSystemSupport

Returns the contents of this file as a char sequence.

Specified by:

getContents in interface FileSystemSupport

Parameters:

path - the path

Returns:

an input stream containing the contents of the file

getContentsAsStream

public java.io.InputStream getContentsAsStream(Path path)

Description copied from interface: FileSystemSupport

Returns an open input stream on the contents of this file.

Specified by:

getContentsAsStream in interface FileSystemSupport

Parameters:

path - the path

Returns:

an input stream containing the contents of the file

getLastModification

public long getLastModification(Path path)

Specified by:

getLastModification in interface FileSystemSupport

Returns:

A long value representing the time the file was last modified, measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970), or 0L if the file does not exist.

isFile

public boolean isFile(Path path)

Specified by:

isFile in interface FileSystemSupport

Returns:

whether the given path points to an existent file

isFolder

public boolean isFolder(Path path)

Specified by:

isFolder in interface FileSystemSupport

Returns:

whether the given path points to an existent folder

toURI

public java.net.URI toURI(Path path)

Description copied from interface: FileSystemSupport

Returns the URI representing the given path.

Warning: Don't use this method to get write access.

Specified by:

toURI in interface FileSystemSupport

Parameters:

path - the path

Returns:

the URI representing the given path