org.inferred.freebuilder.processor.util

Class AbstractSourceBuilder<B extends AbstractSourceBuilder<B>>

java.lang.Object

org.inferred.freebuilder.processor.util.AbstractSourceBuilder<B>

All Implemented Interfaces:

java.lang.Appendable, SourceBuilder

Direct Known Subclasses:

CompilationUnitBuilder, SourceStringBuilder

public abstract class AbstractSourceBuilder<B extends AbstractSourceBuilder<B>>
extends java.lang.Object
implements SourceBuilder, java.lang.Appendable

Field Summary

Fields

Modifier and Type	Field and Description
protected FeatureSet	features
protected Scope	scope
protected org.inferred.freebuilder.processor.util.TypeMirrorShortener	typeMirrorShortener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSourceBuilder(FeatureSet features, Scope scope)

Method Summary

Modifier and Type	Method and Description
B	add(Excerpt excerpt) Equivalent to add("%s", excerpt).
B	add(java.lang.String template, java.lang.Object... params) Appends formatted text to the source.
B	addLine(java.lang.String fmt, java.lang.Object... args) Appends a formatted line of code to the source.
abstract java.lang.Appendable	append(char c)
java.lang.Appendable	append(java.lang.CharSequence csq)
java.lang.Appendable	append(java.lang.CharSequence csq, int start, int end)
<T extends Feature<T>> T	feature(FeatureType<T> feature) Returns the instance of featureType appropriate for the source being written.
protected abstract org.inferred.freebuilder.processor.util.TypeShortener	getShortener()
protected abstract B	getThis()
Scope	scope() Returns the current scope (e.g.
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.

Methods inherited from class java.lang.Object

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

Field Detail

features

protected final FeatureSet features

scope

protected final Scope scope

typeMirrorShortener

protected final org.inferred.freebuilder.processor.util.TypeMirrorShortener typeMirrorShortener

Constructor Detail

AbstractSourceBuilder

protected AbstractSourceBuilder(FeatureSet features,
                                Scope scope)

Method Detail

getShortener

protected abstract org.inferred.freebuilder.processor.util.TypeShortener getShortener()

getThis

protected abstract B getThis()

append

public abstract java.lang.Appendable append(char c)

Specified by:

append in interface java.lang.Appendable

add

public B add(Excerpt excerpt)

Description copied from interface: SourceBuilder

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

Specified by:

add in interface SourceBuilder

add

public B add(java.lang.String template,
             java.lang.Object... params)

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 B 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

append

public java.lang.Appendable append(java.lang.CharSequence csq)

Specified by:

append in interface java.lang.Appendable

append

public java.lang.Appendable append(java.lang.CharSequence csq,
                                   int start,
                                   int end)

Specified by:

append in interface java.lang.Appendable