org.inferred.freebuilder.processor.util

Class Block

java.lang.Object

org.inferred.freebuilder.processor.util.ValueType

org.inferred.freebuilder.processor.util.Excerpt

org.inferred.freebuilder.processor.util.Block

All Implemented Interfaces:

SourceBuilder

public class Block
extends Excerpt
implements SourceBuilder

A Block contains a preamble of lazily-added declarations followed by a body.

Nested Class Summary

Nested classes/interfaces inherited from class org.inferred.freebuilder.processor.util.ValueType

ValueType.FieldReceiver

Method Summary

Modifier and Type	Method and Description
Block	add(Excerpt excerpt) Equivalent to add("%s", excerpt).
Block	add(java.lang.String fmt, java.lang.Object... args) Appends formatted text to the source.
protected void	addFields(ValueType.FieldReceiver fields) Implement this method to report the name and value of each field.
Block	addLine(java.lang.String fmt, java.lang.Object... args) Appends a formatted line of code to the source.
void	addTo(SourceBuilder source)
Excerpt	declare(Excerpt typeAndPreamble, java.lang.String preferredName, Excerpt value) Declare a variable, preferably named preferredName but renamed if necessary to avoid collisions, in this block's preamble, returning an Excerpt to use it.
<T extends Feature<T>> T	feature(FeatureType<T> featureType) Returns the instance of featureType appropriate for the source being written.
Block	innerBlock() Contains variable declaration to an inner block.
static Block	methodBody(SourceBuilder parent, java.lang.String... paramNames)
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 org.inferred.freebuilder.processor.util.ValueType

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

methodBody

public static Block methodBody(SourceBuilder parent,
                               java.lang.String... paramNames)

declare

public Excerpt declare(Excerpt typeAndPreamble,
                       java.lang.String preferredName,
                       Excerpt value)

Declare a variable, preferably named preferredName but renamed if necessary to avoid collisions, in this block's preamble, returning an Excerpt to use it. Duplicate declarations will be elided.

Throws:

java.lang.IllegalStateException - if preferredName has already been added to this block with a different declaration

innerBlock

public Block innerBlock()

Contains variable declaration to an inner block.

add

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

add

public Block add(Excerpt excerpt)

Description copied from interface: SourceBuilder

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

Specified by:

add 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> featureType)

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

addTo

public void addTo(SourceBuilder source)

Specified by:

addTo in class Excerpt

addFields

protected void addFields(ValueType.FieldReceiver fields)

Description copied from class: ValueType

Implement this method to report the name and value of each field.

Specified by:

addFields in class ValueType