org.inferred.freebuilder.processor.util

Class CompilationUnitBuilder

java.lang.Object

org.inferred.freebuilder.processor.util.CompilationUnitBuilder

All Implemented Interfaces:

SourceBuilder

public class CompilationUnitBuilder
extends Object
implements SourceBuilder

SourceBuilder which also handles package declaration and imports.

Constructor Summary

Constructors

Constructor and Description
CompilationUnitBuilder(ProcessingEnvironment env, QualifiedName classToWrite, Collection<QualifiedName> nestedClasses) Returns a CompilationUnitBuilder for classToWrite.

Method Summary

Modifier and Type	Method and Description
SourceBuilder	add(Excerpt excerpt) Equivalent to add("%s", excerpt).
CompilationUnitBuilder	add(String fmt, Object... args) Appends formatted text to the source.
CompilationUnitBuilder	addLine(String fmt, Object... args) Appends a formatted line of code to the source.
<T extends Feature<T>> T	feature(FeatureType<T> feature) Returns the instance of featureType appropriate for the source being written.
SourceStringBuilder	subBuilder() Returns a SourceStringBuilder with the same configuration as this builder.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompilationUnitBuilder

public CompilationUnitBuilder(ProcessingEnvironment env,
                              QualifiedName classToWrite,
                              Collection<QualifiedName> nestedClasses)

Returns a CompilationUnitBuilder for classToWrite. The file preamble (package and imports) will be generated automatically; the feature set will be taken from env..

Method Detail

add

public CompilationUnitBuilder 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 CompilationUnitBuilder 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

feature

public <T extends Feature<T>> T feature(FeatureType<T> feature)

Description copied from interface: SourceBuilder

Returns the instance of featureType appropriate for the source being written. For instance, code.feature(GUAVA).isAvailable() returns true if the Guava library can be used in the generated source code.

Fluent extension point for features dynamically determined based on the current ProcessingEnvironment.

Specified by:

feature in interface SourceBuilder

See Also:

Feature

toString

public String toString()

Overrides:

toString in class Object