org.eclipse.xtext.generator

Class URIBasedFileSystemAccess

java.lang.Object

org.eclipse.xtext.generator.AbstractFileSystemAccess

org.eclipse.xtext.generator.AbstractFileSystemAccess2

org.eclipse.xtext.generator.URIBasedFileSystemAccess

All Implemented Interfaces:

IFileSystemAccess, IFileSystemAccess2, IFileSystemAccessExtension, IFileSystemAccessExtension2, IFileSystemAccessExtension3

public class URIBasedFileSystemAccess
extends AbstractFileSystemAccess2

A file system access implementation that is based on EMF URIs and URIConverter

Since:

2.9

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	URIBasedFileSystemAccess.BeforeDelete
static interface	URIBasedFileSystemAccess.BeforeRead
static interface	URIBasedFileSystemAccess.BeforeWrite

Field Summary

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

DEFAULT_OUTPUT

Constructor Summary

Constructors

Constructor and Description
URIBasedFileSystemAccess()

Method Summary

Methods

Modifier and Type	Method and Description
void	generateFile(String fileName, String outputCfgName, CharSequence contents)
void	generateFile(String fileName, String outputCfgName, InputStream content) Writes binary data to disk.
protected void	generateTrace(String generatedFile, String outputConfigName, CharSequence contents)
org.eclipse.emf.common.util.URI	getBaseDir()
URIBasedFileSystemAccess.BeforeDelete	getBeforeDelete()
URIBasedFileSystemAccess.BeforeRead	getBeforeRead()
URIBasedFileSystemAccess.BeforeWrite	getBeforeWrite()
org.eclipse.emf.ecore.resource.URIConverter	getConverter()
String	getEncoding(org.eclipse.emf.common.util.URI uri)
IEncodingProvider	getEncodingProvider()
TraceFileNameProvider	getTraceFileNameProvider()
TraceRegionSerializer	getTraceRegionSerializer()
org.eclipse.emf.common.util.URI	getURI(String path, String outputConfiguration) Returns an URI for the specified path.
boolean	isGenerateTraces()
InputStream	readBinaryFile(String fileName, String outputCfgName) Creates an InputStream to read a binary file from disk.
CharSequence	readTextFile(String fileName, String outputCfgName) Reads a text file from disk.
void	setBaseDir(org.eclipse.emf.common.util.URI baseDir)
void	setBeforeDelete(URIBasedFileSystemAccess.BeforeDelete beforeDelete)
void	setBeforeRead(URIBasedFileSystemAccess.BeforeRead beforeRead)
void	setBeforeWrite(URIBasedFileSystemAccess.BeforeWrite beforeWrite)
void	setConverter(org.eclipse.emf.ecore.resource.URIConverter converter)
void	setEncodingProvider(IEncodingProvider encodingProvider)
void	setGenerateTraces(boolean generateTraces)
void	setPostProcessor(IFilePostProcessor filePostProcessor)
void	setTraceFileNameProvider(TraceFileNameProvider traceFileNameProvider)
void	setTraceRegionSerializer(TraceRegionSerializer traceRegionSerializer)

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, 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

Constructor Detail

URIBasedFileSystemAccess

public URIBasedFileSystemAccess()

Method Detail

setPostProcessor

public void setPostProcessor(IFilePostProcessor filePostProcessor)

getURI

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

getEncoding

public String getEncoding(org.eclipse.emf.common.util.URI uri)

generateFile

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

Parameters:

fileName - using '/' as file separator

outputCfgName - the name of the output configuration

contents - the to-be-written contents.

generateTrace

protected void generateTrace(String generatedFile,
                 String outputConfigName,
                 CharSequence contents)

generateFile

public void generateFile(String fileName,
                String outputCfgName,
                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)

Throws:

RuntimeIOException

readBinaryFile

public InputStream readBinaryFile(String fileName,
                         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

readTextFile

public CharSequence readTextFile(String fileName,
                        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

getConverter

@Pure
public org.eclipse.emf.ecore.resource.URIConverter getConverter()

setConverter

public void setConverter(org.eclipse.emf.ecore.resource.URIConverter converter)

getBaseDir

@Pure
public org.eclipse.emf.common.util.URI getBaseDir()

setBaseDir

public void setBaseDir(org.eclipse.emf.common.util.URI baseDir)

isGenerateTraces

@Pure
public boolean isGenerateTraces()

setGenerateTraces

public void setGenerateTraces(boolean generateTraces)

getEncodingProvider

@Pure
public IEncodingProvider getEncodingProvider()

setEncodingProvider

public void setEncodingProvider(IEncodingProvider encodingProvider)

getTraceRegionSerializer

@Pure
public TraceRegionSerializer getTraceRegionSerializer()

setTraceRegionSerializer

public void setTraceRegionSerializer(TraceRegionSerializer traceRegionSerializer)

getTraceFileNameProvider

@Pure
public TraceFileNameProvider getTraceFileNameProvider()

setTraceFileNameProvider

public void setTraceFileNameProvider(TraceFileNameProvider traceFileNameProvider)

getBeforeDelete

@Pure
public URIBasedFileSystemAccess.BeforeDelete getBeforeDelete()

setBeforeDelete

public void setBeforeDelete(URIBasedFileSystemAccess.BeforeDelete beforeDelete)

getBeforeWrite

@Pure
public URIBasedFileSystemAccess.BeforeWrite getBeforeWrite()

setBeforeWrite

public void setBeforeWrite(URIBasedFileSystemAccess.BeforeWrite beforeWrite)

getBeforeRead

@Pure
public URIBasedFileSystemAccess.BeforeRead getBeforeRead()

setBeforeRead

public void setBeforeRead(URIBasedFileSystemAccess.BeforeRead beforeRead)