org.eclipse.xtext.generator

Interface IFileSystemAccessExtension3

All Known Subinterfaces:

IFileSystemAccess2, IXtextGeneratorFileSystemAccess

All Known Implementing Classes:

AbstractFileSystemAccess2, EclipseResourceFileSystemAccess, EclipseResourceFileSystemAccess2, InMemoryFileSystemAccess, JavaIoFileSystemAccess, JDTAwareEclipseResourceFileSystemAccess2, ParallelFileSystemAccess, RegisteringFileSystemAccess, URIBasedFileSystemAccess, XtextGeneratorFileSystemAccess

public interface IFileSystemAccessExtension3

This class extends IFileSystemAccess with the capability to write binary files.

Since:

2.4

Author:

Moritz Eysholdt - Initial contribution and API

Method Summary

Methods

Modifier and Type	Method and Description
void	generateFile(java.lang.String fileName, java.io.InputStream content) Writes binary data to disk.
void	generateFile(java.lang.String fileName, java.lang.String outputCfgName, java.io.InputStream content) Writes binary data to disk.
java.io.InputStream	readBinaryFile(java.lang.String fileName) Creates an InputStream to read a binary file from disk.
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) Reads a text file from disk.
java.lang.CharSequence	readTextFile(java.lang.String fileName, java.lang.String outputCfgName) Reads a text file from disk.

Method Detail

generateFile

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

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

Throws:

RuntimeIOException

generateFile

void generateFile(java.lang.String fileName,
                java.io.InputStream content)
                  throws RuntimeIOException

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

Throws:

RuntimeIOException

readBinaryFile

java.io.InputStream readBinaryFile(java.lang.String fileName,
                                 java.lang.String outputCfgName)
                                   throws RuntimeIOException

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

Throws:

RuntimeIOException

readBinaryFile

java.io.InputStream readBinaryFile(java.lang.String fileName)
                                   throws RuntimeIOException

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

Throws:

RuntimeIOException

readTextFile

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

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

Throws:

RuntimeIOException

readTextFile

java.lang.CharSequence readTextFile(java.lang.String fileName)
                                    throws RuntimeIOException

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

Throws:

RuntimeIOException