org.eclipse.xtext.generator

Class InMemoryFileSystemAccess

java.lang.Object

org.eclipse.xtext.generator.AbstractFileSystemAccess

org.eclipse.xtext.generator.AbstractFileSystemAccess2

org.eclipse.xtext.generator.InMemoryFileSystemAccess

All Implemented Interfaces:

IFileSystemAccess, IFileSystemAccess2, IFileSystemAccessExtension, IFileSystemAccessExtension2, IFileSystemAccessExtension3

Direct Known Subclasses:

RegisteringFileSystemAccess

public class InMemoryFileSystemAccess
extends AbstractFileSystemAccess2

Since:

2.0

Author:

Sven Efftinge - Initial contribution and API, Moritz Eysholdt

Field Summary

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

DEFAULT_OUTPUT

Constructor Summary

Constructors

Constructor and Description
InMemoryFileSystemAccess()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteFile(java.lang.String fileName, java.lang.String outputConfigName)
void	generateFile(java.lang.String fileName, java.lang.String outputConfigName, java.lang.CharSequence contents)
void	generateFile(java.lang.String fileName, java.lang.String outputCfgName, java.io.InputStream content) Writes binary data to disk.
java.util.Map<java.lang.String,java.lang.Object>	getAllFiles()
java.util.Map<java.lang.String,byte[]>	getBinaryFiles()
protected java.lang.String	getFileName(java.lang.String fileName, java.lang.String outputConfigName)
java.util.Map<java.lang.String,java.lang.CharSequence>	getFiles() Deprecated.
java.lang.String	getTextFileEncoding()
java.util.Map<java.lang.String,java.lang.CharSequence>	getTextFiles()
org.eclipse.emf.common.util.URI	getURI(java.lang.String fileName, java.lang.String outputConfiguration) Returns an URI for the specified path.
java.io.InputStream	readBinaryFile(java.lang.String fileName, java.lang.String outputCfgName) Creates an InputStream to read a binary file from disk.
java.lang.CharSequence	readTextFile(java.lang.String fileName, java.lang.String outputCfgName) Reads a text file from disk.
void	setPostProcessor(IFilePostProcessor postProcessor)
void	setTextFileEnconding(java.lang.String textFileEnconding)

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

generateFile, isFile, isFile, readBinaryFile, readTextFile, setContext

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

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.IFileSystemAccessExtension2

getURI

Constructor Detail

InMemoryFileSystemAccess

public InMemoryFileSystemAccess()

Method Detail

generateFile

public void generateFile(java.lang.String fileName,
                java.lang.String outputConfigName,
                java.lang.CharSequence contents)

Parameters:

fileName - using '/' as file separator

outputConfigName - the name of the output configuration

contents - the to-be-written contents.

getTextFileEncoding

public java.lang.String getTextFileEncoding()

Since:

2.4

setTextFileEnconding

public void setTextFileEnconding(java.lang.String textFileEnconding)

Since:

2.4

setPostProcessor

public void setPostProcessor(IFilePostProcessor postProcessor)

Since:

2.4

getFileName

protected java.lang.String getFileName(java.lang.String fileName,
                           java.lang.String outputConfigName)

Since:

2.4

deleteFile

public void deleteFile(java.lang.String fileName,
              java.lang.String outputConfigName)

Specified by:

deleteFile in interface IFileSystemAccessExtension

Overrides:

deleteFile in class AbstractFileSystemAccess

Parameters:

fileName - using '/' as file separator

outputConfigName - the name of the output configuration

getTextFiles

public java.util.Map<java.lang.String,java.lang.CharSequence> getTextFiles()

Since:

2.4

getBinaryFiles

public java.util.Map<java.lang.String,byte[]> getBinaryFiles()

Since:

2.4

getAllFiles

public java.util.Map<java.lang.String,java.lang.Object> getAllFiles()

Since:

2.4

getFiles

@Deprecated
public java.util.Map<java.lang.String,java.lang.CharSequence> getFiles()

Deprecated.

use getTextFiles() or getAllFiles().

getURI

public org.eclipse.emf.common.util.URI getURI(java.lang.String fileName,
                                     java.lang.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.

Since:

2.3

generateFile

public void generateFile(java.lang.String fileName,
                java.lang.String outputCfgName,
                java.io.InputStream content)

Description copied from interface: IFileSystemAccessExtension3

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

Since:

2.4

readBinaryFile

public java.io.InputStream readBinaryFile(java.lang.String fileName,
                                 java.lang.String outputCfgName)
                                   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) .

Throws:

RuntimeIOException

Since:

2.4

readTextFile

public java.lang.CharSequence readTextFile(java.lang.String fileName,
                                  java.lang.String outputCfgName)
                                    throws RuntimeIOException

Description copied from interface: IFileSystemAccessExtension3

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

Throws:

RuntimeIOException

Since:

2.4