org.eclipse.xtend.backend.syslib
Class FileIoOperations

java.lang.Object
  org.eclipse.xtend.middleend.javaannotations.AbstractExecutionContextAware
      org.eclipse.xtend.backend.syslib.FileIoOperations

All Implemented Interfaces:

ExecutionContextAware

public final class FileIoOperations
extends AbstractExecutionContextAware

This class provides functions for writing data to files. Since this is part of the core functionality of a code generator, these functions are in the syslib.
These functions replace the "FILE" construct of XPand. The class makes use of the "single instance per ExecutionContext" guarantee to store pre-registered "outlets" and allow reuse of predefined output configurations.

Author:

Arno Haase (http://www.haase-consulting.com)

Field Summary

static java.lang.String

DEFAULT_OUTLET_NAME

Fields inherited from class org.eclipse.xtend.middleend.javaannotations.AbstractExecutionContextAware

_ctx

Constructor Summary

FileIoOperations()

Method Summary

void	registerDefaultOutlet(Outlet outlet)
void	registerDefaultOutlet(java.lang.String baseDir)
void	registerDefaultOutlet(java.lang.String baseDir, java.lang.String fileEncoding)
void	registerDefaultOutlet(java.lang.String baseDir, java.lang.String fileEncoding, boolean overwrite)
void	registerOutlet(java.lang.String name, Outlet outlet)
void	registerOutlet(java.lang.String name, java.lang.String baseDir)
void	registerOutlet(java.lang.String name, java.lang.String baseDir, java.lang.String fileEncoding)
void	registerOutlet(java.lang.String name, java.lang.String baseDir, java.lang.String fileEncoding, boolean overwrite)
void	writeToFile(java.lang.String fileName, boolean append, java.lang.CharSequence content)
void	writeToFile(java.lang.String fileName, boolean append, FutureResultHolder content)
void	writeToFile(java.lang.String fileName, java.lang.CharSequence content)
void	writeToFile(java.lang.String fileName, FutureResultHolder content)
void	writeToFile(java.lang.String outletName, java.lang.String fileName, boolean append, java.lang.CharSequence content)
void	writeToFile(java.lang.String outletName, java.lang.String fileName, boolean append, FutureResultHolder content)
void	writeToFile(java.lang.String outletName, java.lang.String fileName, java.lang.CharSequence content)
void	writeToFile(java.lang.String outletName, java.lang.String fileName, FutureResultHolder content)

Methods inherited from class org.eclipse.xtend.middleend.javaannotations.AbstractExecutionContextAware

getExecutionContext, setExecutionContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_OUTLET_NAME

public static final java.lang.String DEFAULT_OUTLET_NAME

See Also:

Constant Field Values

Constructor Detail

FileIoOperations

public FileIoOperations()

Method Detail

registerDefaultOutlet

public void registerDefaultOutlet(Outlet outlet)

registerDefaultOutlet

public void registerDefaultOutlet(java.lang.String baseDir,
                                  java.lang.String fileEncoding,
                                  boolean overwrite)

registerDefaultOutlet

public void registerDefaultOutlet(java.lang.String baseDir,
                                  java.lang.String fileEncoding)

registerDefaultOutlet

public void registerDefaultOutlet(java.lang.String baseDir)

registerOutlet

public void registerOutlet(java.lang.String name,
                           Outlet outlet)

registerOutlet

public void registerOutlet(java.lang.String name,
                           java.lang.String baseDir,
                           java.lang.String fileEncoding,
                           boolean overwrite)

registerOutlet

public void registerOutlet(java.lang.String name,
                           java.lang.String baseDir,
                           java.lang.String fileEncoding)

registerOutlet

public void registerOutlet(java.lang.String name,
                           java.lang.String baseDir)

writeToFile

public void writeToFile(java.lang.String fileName,
                        java.lang.CharSequence content)

writeToFile

public void writeToFile(java.lang.String outletName,
                        java.lang.String fileName,
                        java.lang.CharSequence content)

writeToFile

public void writeToFile(java.lang.String fileName,
                        boolean append,
                        java.lang.CharSequence content)

writeToFile

public void writeToFile(java.lang.String outletName,
                        java.lang.String fileName,
                        boolean append,
                        java.lang.CharSequence content)

writeToFile

public void writeToFile(java.lang.String fileName,
                        FutureResultHolder content)

writeToFile

public void writeToFile(java.lang.String outletName,
                        java.lang.String fileName,
                        FutureResultHolder content)

writeToFile

public void writeToFile(java.lang.String fileName,
                        boolean append,
                        FutureResultHolder content)

writeToFile

public void writeToFile(java.lang.String outletName,
                        java.lang.String fileName,
                        boolean append,
                        FutureResultHolder content)