org.eclipse.xtext.generator

Class FileSystemSupportBasedFileSystemAccess

java.lang.Object

org.eclipse.xtext.generator.AbstractFileSystemAccess

org.eclipse.xtext.generator.AbstractFileSystemAccess2

org.eclipse.xtext.generator.FileSystemSupportBasedFileSystemAccess

All Implemented Interfaces:

IFileSystemAccess, IFileSystemAccessExtension, IFileSystemAccessExtension2, IFileSystemAccessExtension3, IFileSystemAccessExtension4

public class FileSystemSupportBasedFileSystemAccess
extends AbstractFileSystemAccess2
implements IFileSystemAccess, IFileSystemAccessExtension, IFileSystemAccessExtension2, IFileSystemAccessExtension3

An adapter between {org.eclipse.xtend.lib.macro.file.MutableFileSystemSupport} and {org.eclipse.xtext.generator.IFileSystemAccess}

Since:

2.7

Author:

Sven Efftinge - Initial contribution and API

Field Summary

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

DEFAULT_OUTPUT

Constructor Summary

Constructors

Constructor and Description
FileSystemSupportBasedFileSystemAccess()

Method Summary

Methods

Modifier and Type	Method and Description
void	generateFile(String fileName, String outputConfigurationName, CharSequence contents)
void	generateFile(String fileName, String outputConfigurationName, InputStream content) Writes binary data to disk.
protected Path	getPath(String fileName, String outputConfigurationName)
org.eclipse.emf.common.util.URI	getURI(String fileName, String outputConfiguration) Returns an URI for the specified path.
InputStream	readBinaryFile(String fileName, String outputConfigurationName) Creates an InputStream to read a binary file from disk.
CharSequence	readTextFile(String fileName, String outputConfigurationName) Reads a text file from disk.
void	setFileSystemSupport(MutableFileSystemSupport fileSystemSupport)
void	setProjectName(String projectName)

Methods inherited from class org.eclipse.xtext.generator.AbstractFileSystemAccess2

generateFile, isFile, readBinaryFile, readTextFile, setContext

Methods inherited from class org.eclipse.xtext.generator.AbstractFileSystemAccess

deleteFile, deleteFile, generateFile, getCurrentSource, getOutputConfig, getOutputConfigurations, getPathes, getURI, postProcess, postProcess, setCurrentSource, setOutputConfigurations, setOutputPath, setOutputPath

Methods inherited from class java.lang.Object

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

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

deleteFile, generateFile

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

deleteFile

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

getURI

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

generateFile, readBinaryFile, readTextFile

Constructor Detail

FileSystemSupportBasedFileSystemAccess

public FileSystemSupportBasedFileSystemAccess()

Method Detail

getPath

protected Path getPath(String fileName,
           String outputConfigurationName)

generateFile

public void generateFile(String fileName,
                String outputConfigurationName,
                CharSequence contents)

Specified by:

generateFile in interface IFileSystemAccess

Parameters:

fileName - using '/' as file separator

outputConfigurationName - the name of the output configuration

contents - the to-be-written contents.

getURI

public org.eclipse.emf.common.util.URI getURI(String fileName,
                                     String outputConfiguration)

Description copied from interface: IFileSystemAccessExtension2

Returns an URI for the specified path. For workspace resources a platform:/resource URI should be returned in order to pick up project specific preferences.

Specified by:

getURI in interface IFileSystemAccessExtension2

generateFile

public void generateFile(String fileName,
                String outputConfigurationName,
                InputStream content)
                  throws RuntimeIOException

Description copied from interface: IFileSystemAccessExtension3

Writes binary data to disk. For writing text, it is recommended to use IFileSystemAccess.generateFile(String, String, CharSequence)

Specified by:

generateFile in interface IFileSystemAccessExtension3

Throws:

RuntimeIOException

readBinaryFile

public InputStream readBinaryFile(String fileName,
                         String outputConfigurationName)
                           throws RuntimeIOException

Description copied from interface: IFileSystemAccessExtension3

Creates an InputStream to read a binary file from disk. For text files, use IFileSystemAccessExtension3.readTextFile(String, String) .

Specified by:

readBinaryFile in interface IFileSystemAccessExtension3

Throws:

RuntimeIOException

readTextFile

public CharSequence readTextFile(String fileName,
                        String outputConfigurationName)
                          throws RuntimeIOException

Description copied from interface: IFileSystemAccessExtension3

Reads a text file from disk. To read a binary file, use IFileSystemAccessExtension3.readBinaryFile(String, String).

Specified by:

readTextFile in interface IFileSystemAccessExtension3

Throws:

RuntimeIOException

setFileSystemSupport

public void setFileSystemSupport(MutableFileSystemSupport fileSystemSupport)

setProjectName

public void setProjectName(String projectName)