org.inferred.freebuilder.processor.util

Class SourceStringBuilder

java.lang.Object

org.inferred.freebuilder.processor.util.SourceStringBuilder

All Implemented Interfaces:

SourceBuilder

public class SourceStringBuilder
extends java.lang.Object
implements SourceBuilder

A SourceBuilder that writes to a StringBuilder.

Method Summary

Modifier and Type	Method and Description
SourceBuilder	add(Excerpt excerpt) Equivalent to add("%s", excerpt).
SourceBuilder	add(java.lang.String fmt, java.lang.Object... args) Appends formatted text to the source.
SourceBuilder	addLine(java.lang.String fmt, java.lang.Object... args) Appends a formatted line of code to the source.
static SourceBuilder	compilable(FeatureSet features) Returns a SourceStringBuilder that returns compilable code.
<T extends Feature<T>> T	feature(FeatureType<T> feature) Returns the instance of featureType appropriate for the source being written.
Scope	scope() Returns the current scope (e.g.
static SourceBuilder	simple(Feature<?>... features) Returns a SourceStringBuilder that always shortens types, even if that causes conflicts.
SourceStringBuilder	subBuilder() Returns a SourceStringBuilder with the same configuration as this builder.
SourceStringBuilder	subScope(Scope newScope) Returns a SourceStringBuilder with the same configuration as this builder, but with a different scope.
java.lang.String	toString() Returns the source code written so far.

Methods inherited from class java.lang.Object

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

Method Detail

simple

public static SourceBuilder simple(Feature<?>... features)

Returns a SourceStringBuilder that always shortens types, even if that causes conflicts.

compilable

public static SourceBuilder compilable(FeatureSet features)

Returns a SourceStringBuilder that returns compilable code.

add

public SourceBuilder add(Excerpt excerpt)

Description copied from interface: SourceBuilder

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

Specified by:

add in interface SourceBuilder

add

public SourceBuilder add(java.lang.String fmt,
                         java.lang.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

addLine

public SourceBuilder addLine(java.lang.String fmt,
                             java.lang.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

subScope

public SourceStringBuilder subScope(Scope newScope)

Description copied from interface: SourceBuilder

Returns a SourceStringBuilder with the same configuration as this builder, but with a different scope. 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:

subScope 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

scope

public Scope scope()

Description copied from interface: SourceBuilder

Returns the current scope (e.g. visible method parameters).

Specified by:

scope in interface SourceBuilder

toString

public java.lang.String toString()

Returns the source code written so far.

Overrides:

toString in class java.lang.Object