org.eclipse.xtext.generator

Interface IFileSystemAccess2

All Superinterfaces:

IFileSystemAccess, IFileSystemAccessExtension, IFileSystemAccessExtension2, IFileSystemAccessExtension3

All Known Implementing Classes:

AbstractFileSystemAccess2, InMemoryFileSystemAccess, JavaIoFileSystemAccess, URIBasedFileSystemAccess

public interface IFileSystemAccess2
extends IFileSystemAccess, IFileSystemAccessExtension, IFileSystemAccessExtension2, IFileSystemAccessExtension3

Abstraction for file system operations with the added value of a logical path mapping (outlet). This interface composes all the extension interfaces to IFileSystemAccess. Further enhancements will be implemented directly in this interface.

Since:

2.9

Noimplement:

This interface is not intended to be implemented by clients.

Field Summary

Fields inherited from interface org.eclipse.xtext.generator.IFileSystemAccess

DEFAULT_OUTPUT

Method Summary

Modifier and Type	Method and Description
boolean	isFile(java.lang.String path) Tests whether the file exists at the location in the default output configuration.
boolean	isFile(java.lang.String path, java.lang.String outputConfigurationName) Tests whether the file exists at the location denoted by the output configuration.

Methods inherited from interface org.eclipse.xtext.generator.IFileSystemAccess

deleteFile, generateFile, generateFile

Methods inherited from interface org.eclipse.xtext.generator.IFileSystemAccessExtension

deleteFile

Methods inherited from interface org.eclipse.xtext.generator.IFileSystemAccessExtension2

getURI, getURI

Methods inherited from interface org.eclipse.xtext.generator.IFileSystemAccessExtension3

generateFile, generateFile, readBinaryFile, readBinaryFile, readTextFile, readTextFile

Method Detail

isFile

boolean isFile(java.lang.String path,
               java.lang.String outputConfigurationName)
        throws org.eclipse.xtext.util.RuntimeIOException

Tests whether the file exists at the location denoted by the output configuration. Returns true if the file at the described location exists and is a normal file (not a directory). Otherwise false.

Parameters:

path - using '/' as path separator

outputConfigurationName - the name of the output configuration

Returns:

true when the file at the given path exists and is a normal file. Will return false when the path belongs to a directory.

Throws:

org.eclipse.xtext.util.RuntimeIOException

isFile

boolean isFile(java.lang.String path)
        throws org.eclipse.xtext.util.RuntimeIOException

Tests whether the file exists at the location in the default output configuration. Returns true if the file at the described location exists and is a normal file (not a directory). Otherwise false.

Parameters:

path - using '/' as path separator

Returns:

true when the file at the given path exists and is a normal file. Will return false when the path belongs to a directory.

Throws:

org.eclipse.xtext.util.RuntimeIOException