com.asakusafw.utils.java.model.util

Class Filer

java.lang.Object

com.asakusafw.utils.java.model.util.Emitter

com.asakusafw.utils.java.model.util.Filer

public class Filer
extends Emitter

An implementation of Emitter which generates files into the local file system.

Constructor Summary

Constructors

Constructor and Description
Filer(File outputPath, Charset encoding) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
File	getFolderFor(Name packageNameOrNull) Returns the folder for the target package.
File	getFolderFor(PackageDeclaration packageDeclOrNull) Returns the folder for the target package.
PrintWriter	openFor(PackageDeclaration packageDeclOrNull, String subPath) Creates a new resource file and returns the writer for writing the contents of the resource.

Methods inherited from class com.asakusafw.utils.java.model.util.Emitter

findPrimaryType, openFor

Methods inherited from class java.lang.Object

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

Constructor Detail

Filer

public Filer(File outputPath,
             Charset encoding)

Creates a new instance.

Parameters:

outputPath - the base output directory

encoding - the character set encoding of generating source files

Throws:

IllegalArgumentException - if the parameters are null

Method Detail

getFolderFor

public File getFolderFor(PackageDeclaration packageDeclOrNull)

Returns the folder for the target package. The returning folder may not exist.

Parameters:

packageDeclOrNull - the target package, or null for the default (unnamed) package

Returns:

the corresponded folder path

getFolderFor

public File getFolderFor(Name packageNameOrNull)

Returns the folder for the target package. The returning folder may not exist.

Parameters:

packageNameOrNull - the target package, or null for the default (unnamed) package

Returns:

the corresponded folder path

openFor

public PrintWriter openFor(PackageDeclaration packageDeclOrNull,
                           String subPath)
                    throws IOException

Description copied from class: Emitter

Creates a new resource file and returns the writer for writing the contents of the resource.

Specified by:

openFor in class Emitter

Parameters:

packageDeclOrNull - the base package, or null if it is the default (unnamed) package

subPath - the relative path from the base package

Returns:

the created writer

Throws:

IOException - if error was occurred while creating the target resource