com.asakusafw.utils.java.model.util

Class Emitter

java.lang.Object

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

Direct Known Subclasses:

Filer

public abstract class Emitter
extends Object

An abstract super class of Java source code emitters.

Constructor Summary

Constructors

Constructor and Description
Emitter()

Method Summary

Modifier and Type	Method and Description
static TypeDeclaration	findPrimaryType(CompilationUnit unit) Returns a primary type declaration in the compilation unit.
PrintWriter	openFor(CompilationUnit unit) Creates a new Java source file and returns the writer for writing the contents of the file.
abstract 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 java.lang.Object

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

Constructor Detail

Emitter

public Emitter()

Method Detail

openFor

public PrintWriter openFor(CompilationUnit unit)
                    throws IOException

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

Parameters:

unit - the target compilation unit

Returns:

the created writer

Throws:

IOException - if error was occurred while creating the target source file

IllegalArgumentException - if the parameter is null

findPrimaryType

public static TypeDeclaration findPrimaryType(CompilationUnit unit)

Returns a primary type declaration in the compilation unit. Primary type is a type which is declared as top-level public type, or the first type in the compilation unit.

Parameters:

unit - the target compilation unit

Returns:

the primary type declaration, or null if the compilation unit does not contain any types

Throws:

IllegalArgumentException - if the parameter is null

openFor

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

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

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

IllegalArgumentException - if the parameter is null