org.inferred.freebuilder.processor.util

Interface SourceBuilder

All Known Implementing Classes:

Block, CompilationUnitBuilder, SourceStringBuilder

public interface SourceBuilder

Source code builder, using format strings for readability, with sensible formatting for type objects.

 // Imports StringBuilder and appends "  StringBuilder foo;\n" to the source code.
 builder.addLine("  %s foo;", StringBuilder.class);

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.
<T extends Feature<T>> T	feature(FeatureType<T> featureType) Returns the instance of featureType appropriate for the source being written.
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.

Method Detail

add

SourceBuilder add(java.lang.String fmt,
                  java.lang.Object... args)

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.

add

SourceBuilder add(Excerpt excerpt)

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

addLine

SourceBuilder addLine(java.lang.String fmt,
                      java.lang.Object... args)

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.

subBuilder

SourceStringBuilder subBuilder()

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).

subScope

SourceStringBuilder subScope(Scope newScope)

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).

feature

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

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.

See Also:

Feature

scope

Scope scope()

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