Package org.eclipse.xtext.generator

Interface IFileSystemAccessExtension3

All Known Subinterfaces:

IFileSystemAccess2

All Known Implementing Classes:

AbstractFileSystemAccess2, InMemoryFileSystemAccess, JavaIoFileSystemAccess, URIBasedFileSystemAccess

public interface IFileSystemAccessExtension3

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

Since:

2.4

Method Summary

Modifier and Type	Method	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 org.eclipse.xtext.util.RuntimeIOException

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

Throws:

org.eclipse.xtext.util.RuntimeIOException

generateFile

void generateFile(java.lang.String fileName,
                  java.io.InputStream content)
           throws org.eclipse.xtext.util.RuntimeIOException

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

Throws:

org.eclipse.xtext.util.RuntimeIOException

readBinaryFile

java.io.InputStream readBinaryFile(java.lang.String fileName,
                                   java.lang.String outputCfgName)
                            throws org.eclipse.xtext.util.RuntimeIOException

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

Throws:

org.eclipse.xtext.util.RuntimeIOException

readBinaryFile

java.io.InputStream readBinaryFile(java.lang.String fileName)
                            throws org.eclipse.xtext.util.RuntimeIOException

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

Throws:

org.eclipse.xtext.util.RuntimeIOException

readTextFile

java.lang.CharSequence readTextFile(java.lang.String fileName,
                                    java.lang.String outputCfgName)
                             throws org.eclipse.xtext.util.RuntimeIOException

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

Throws:

org.eclipse.xtext.util.RuntimeIOException

readTextFile

java.lang.CharSequence readTextFile(java.lang.String fileName)
                             throws org.eclipse.xtext.util.RuntimeIOException

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

Throws:

org.eclipse.xtext.util.RuntimeIOException