org.eclipse.xtext.generator

Class AbstractFileSystemAccess

java.lang.Object

org.eclipse.xtext.generator.AbstractFileSystemAccess

All Implemented Interfaces:

IFileSystemAccess, IFileSystemAccessExtension, IFileSystemAccessExtension2

Direct Known Subclasses:

AbstractFileSystemAccess2

public abstract class AbstractFileSystemAccess
extends java.lang.Object
implements IFileSystemAccess, IFileSystemAccessExtension, IFileSystemAccessExtension2

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
AbstractFileSystemAccess()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteFile(java.lang.String fileName)
void	deleteFile(java.lang.String fileName, java.lang.String outputConfigurationName)
void	generateFile(java.lang.String fileName, java.lang.CharSequence contents)
protected java.lang.String	getCurrentSource() The current source folder, relative to the project location
protected OutputConfiguration	getOutputConfig(java.lang.String outputName)
java.util.Map<java.lang.String,OutputConfiguration>	getOutputConfigurations()
protected java.util.Map<java.lang.String,java.lang.String>	getPathes()
org.eclipse.emf.common.util.URI	getURI(java.lang.String fileName) Returns an URI for the specified file in the default output location.
protected java.lang.CharSequence	postProcess(java.lang.String fileName, java.lang.String outputConfiguration, java.lang.CharSequence content)
protected java.lang.CharSequence	postProcess(java.lang.String fileName, java.lang.String outputConfiguration, java.lang.CharSequence content, java.lang.String charset)
void	setCurrentSource(java.lang.String currentSource)
void	setOutputConfigurations(java.util.Map<java.lang.String,OutputConfiguration> outputs)
void	setOutputPath(java.lang.String path)
void	setOutputPath(java.lang.String outputName, java.lang.String path)

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

generateFile

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

getURI

Constructor Detail

AbstractFileSystemAccess

public AbstractFileSystemAccess()

Method Detail

setCurrentSource

public void setCurrentSource(java.lang.String currentSource)

Since:

2.6

getCurrentSource

protected java.lang.String getCurrentSource()

The current source folder, relative to the project location

Since:

2.6

setOutputConfigurations

public void setOutputConfigurations(java.util.Map<java.lang.String,OutputConfiguration> outputs)

Since:

2.1

getOutputConfigurations

public java.util.Map<java.lang.String,OutputConfiguration> getOutputConfigurations()

Since:

2.1

getOutputConfig

protected OutputConfiguration getOutputConfig(java.lang.String outputName)

Since:

2.1

getPathes

protected java.util.Map<java.lang.String,java.lang.String> getPathes()

setOutputPath

public void setOutputPath(java.lang.String outputName,
                 java.lang.String path)

setOutputPath

public void setOutputPath(java.lang.String path)

generateFile

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

Specified by:

generateFile in interface IFileSystemAccess

Parameters:

fileName - using '/' as file separator

contents - the to-be-written contents.

deleteFile

public void deleteFile(java.lang.String fileName)

Specified by:

deleteFile in interface IFileSystemAccess

Parameters:

fileName - using '/' as file separator

Since:

2.1

deleteFile

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

Specified by:

deleteFile in interface IFileSystemAccessExtension

Parameters:

fileName - using '/' as file separator

outputConfigurationName - the name of the output configuration

Since:

2.1

postProcess

protected java.lang.CharSequence postProcess(java.lang.String fileName,
                                 java.lang.String outputConfiguration,
                                 java.lang.CharSequence content)

Since:

2.3

postProcess

protected java.lang.CharSequence postProcess(java.lang.String fileName,
                                 java.lang.String outputConfiguration,
                                 java.lang.CharSequence content,
                                 java.lang.String charset)

Since:

2.4

getURI

public org.eclipse.emf.common.util.URI getURI(java.lang.String fileName)

Description copied from interface: IFileSystemAccessExtension2

Returns an URI for the specified file in the default output location. For workspace files a platform:/resource URI should be returned in order to pick up project specific preferences.

Specified by:

getURI in interface IFileSystemAccessExtension2

Since:

2.3