org.inferred.freebuilder.processor.util

Class CompilationUnitWriter

java.lang.Object

org.inferred.freebuilder.processor.util.CompilationUnitWriter

All Implemented Interfaces:

Closeable, AutoCloseable, SourceBuilder

public class CompilationUnitWriter
extends Object
implements SourceBuilder, Closeable

Convenience wrapper around the Writer instances returned by Filer.

Constructor Summary

Constructors

Constructor and Description
CompilationUnitWriter(Filer filer, Elements elements, SourceLevel sourceLevel, boolean isGuavaAvailable, QualifiedName classToWrite, Collection<QualifiedName> nestedClasses, Element originatingElement) Returns a CompilationUnitWriter for classToWrite.

Method Summary

Modifier and Type	Method and Description
SourceBuilder	add(Excerpt excerpt) Equivalent to add("%s", excerpt).
CompilationUnitWriter	add(String fmt, Object... args) Appends formatted text to the source.
CompilationUnitWriter	addLine(String fmt, Object... args) Appends a formatted line of code to the source.
void	close()
SourceLevel	getSourceLevel()
boolean	isGuavaAvailable()
SourceStringBuilder	subBuilder() Returns a SourceStringBuilder with the same configuration as this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompilationUnitWriter

public CompilationUnitWriter(Filer filer,
                             Elements elements,
                             SourceLevel sourceLevel,
                             boolean isGuavaAvailable,
                             QualifiedName classToWrite,
                             Collection<QualifiedName> nestedClasses,
                             Element originatingElement)
                      throws FilerException

Returns a CompilationUnitWriter for classToWrite. The file preamble (package and imports) will be generated automatically.

Throws:

FilerException - if a Filer guarantee is violated (see the FilerException JavaDoc for more information); propagated because this is often seen in GUIDE projects, so should be downgraded to a warning, whereas runtime exceptions should be flagged as an internal error to the user

Method Detail

add

public CompilationUnitWriter add(String fmt,
                                 Object... args)

Description copied from interface: SourceBuilder

Appends formatted text to the source.

Formatting is done by String.format(java.lang.String, java.lang.Object...), except that:

• Package and PackageElement instances use their fully-qualified names (no "package " prefix).
• Class, TypeElement, DeclaredType and QualifiedName instances use their qualified names where necessary, or shorter versions if a suitable import line can be added.
• Excerpt instances have Excerpt.addTo(SourceBuilder) called.

Specified by:

add in interface SourceBuilder

add

public SourceBuilder add(Excerpt excerpt)

Description copied from interface: SourceBuilder

Equivalent to add("%s", excerpt).

Specified by:

add in interface SourceBuilder

addLine

public CompilationUnitWriter addLine(String fmt,
                                     Object... args)

Description copied from interface: SourceBuilder

Appends a formatted line of code to the source.

Formatting is done by String.format(java.lang.String, java.lang.Object...), except that:

• Package and PackageElement instances use their fully-qualified names (no "package " prefix).
• Class, TypeElement, DeclaredType and QualifiedName instances use their qualified names where necessary, or shorter versions if a suitable import line can be added.
• Excerpt instances have Excerpt.addTo(SourceBuilder) called.

Specified by:

addLine in interface SourceBuilder

subBuilder

public SourceStringBuilder subBuilder()

Description copied from interface: SourceBuilder

Returns a SourceStringBuilder with the same configuration as this builder. In particular, the TypeShortener will be shared, so any types added to the sub-builder will be included in the imports for this builder (and its parents).

Specified by:

subBuilder in interface SourceBuilder

getSourceLevel

public SourceLevel getSourceLevel()

Specified by:

getSourceLevel in interface SourceBuilder

isGuavaAvailable

public boolean isGuavaAvailable()

Specified by:

isGuavaAvailable in interface SourceBuilder

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable