org.inferred.freebuilder.processor

Class BuildableType

java.lang.Object

org.inferred.freebuilder.processor.BuildableType

public abstract class BuildableType
extends java.lang.Object

Metadata about a buildable user type.

A buildable type is one with a Builder class providing a similar API to proto or @FreeBuilder:

• a public constructor, or static builder()/newBuilder() method;
• build(), buildPartial() and clear() methods; and
• a mergeWith(Value) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildableType.Builder
static class	BuildableType.MergeBuilderMethod How to merge the values from one Builder into another.
static class	BuildableType.PartialToBuilderMethod How to convert a partial value into a Builder.

Constructor Summary

Constructors

Constructor and Description
BuildableType()

Method Summary

Modifier and Type	Method and Description
abstract BuilderFactory	builderFactory()
abstract Type	builderType() Returns the builder type that will build instances of type().
static BuildableType	create(javax.lang.model.type.DeclaredType datatype, javax.lang.model.type.DeclaredType builder, javax.lang.model.util.Elements elements, javax.lang.model.util.Types types)
static java.util.Optional<javax.lang.model.type.DeclaredType>	maybeBuilder(javax.lang.model.type.DeclaredType type, javax.lang.model.util.Elements elements, javax.lang.model.util.Types types)
abstract BuildableType.MergeBuilderMethod	mergeBuilder()
Excerpt	newBuilder(BuilderFactory.TypeInference typeInference) Returns an excerpt calling the Builder factory method.
abstract BuildableType.PartialToBuilderMethod	partialToBuilder()
abstract Excerpt	suppressUnchecked()
abstract Type	type() Returns the parameterized buildable type.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildableType

public BuildableType()

Method Detail

type

public abstract Type type()

Returns the parameterized buildable type.

This may be parameterized with any compatible types, including concrete types, wildcards, type variables, or generic types containing any combination of the above.

builderType

public abstract Type builderType()

Returns the builder type that will build instances of type().

mergeBuilder

public abstract BuildableType.MergeBuilderMethod mergeBuilder()

partialToBuilder

public abstract BuildableType.PartialToBuilderMethod partialToBuilder()

builderFactory

public abstract BuilderFactory builderFactory()

suppressUnchecked

public abstract Excerpt suppressUnchecked()

newBuilder

public Excerpt newBuilder(BuilderFactory.TypeInference typeInference)

Returns an excerpt calling the Builder factory method.

maybeBuilder

public static java.util.Optional<javax.lang.model.type.DeclaredType> maybeBuilder(javax.lang.model.type.DeclaredType type,
                                                                                  javax.lang.model.util.Elements elements,
                                                                                  javax.lang.model.util.Types types)

create

public static BuildableType create(javax.lang.model.type.DeclaredType datatype,
                                   javax.lang.model.type.DeclaredType builder,
                                   javax.lang.model.util.Elements elements,
                                   javax.lang.model.util.Types types)