org.inferred.freebuilder.processor

Class Metadata

java.lang.Object

org.inferred.freebuilder.processor.Metadata

public abstract class Metadata
extends java.lang.Object

Metadata about a @FreeBuilder type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metadata.Builder Builder for Metadata.
static class	Metadata.Property Metadata about a property of a Metadata.
static class	Metadata.StandardMethod Standard Java methods that may be underridden.
static class	Metadata.UnderrideLevel How compulsory the underride is.
static class	Metadata.Visibility

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<Metadata.Property,PropertyCodeGenerator>	GET_CODE_GENERATOR

Constructor Summary

Constructors

Constructor and Description
Metadata()

Method Summary

Modifier and Type	Method and Description
ParameterizedType	getBuilder() Returns the builder type that users will see.
abstract com.google.common.base.Optional<BuilderFactory>	getBuilderFactory() Returns the builder factory mechanism the user has exposed, if any.
abstract ParameterizedType	getGeneratedBuilder() Returns the builder class that should be generated.
abstract com.google.common.collect.ImmutableList<Excerpt>	getGeneratedBuilderAnnotations() Returns a list of annotations that should be applied to the generated builder class.
abstract com.google.common.collect.ImmutableList<com.google.common.base.Function<Metadata,Excerpt>>	getNestedClasses() Returns a list of nested classes that should be added to the generated builder class.
abstract ParameterizedType	getPartialType() Returns the partial value class that should be generated.
abstract com.google.common.collect.ImmutableList<Metadata.Property>	getProperties() Returns metadata about the properties of the type.
abstract ParameterizedType	getPropertyEnum() Returns the Property enum that may be generated.
abstract com.google.common.collect.ImmutableMap<Metadata.StandardMethod,Metadata.UnderrideLevel>	getStandardMethodUnderrides()
abstract ParameterizedType	getType() Returns the type itself.
abstract ParameterizedType	getValueType() Returns the value class that should be generated.
abstract com.google.common.collect.ImmutableList<Excerpt>	getValueTypeAnnotations() Returns a list of annotations that should be applied to the generated value class.
abstract Metadata.Visibility	getValueTypeVisibility() Returns the visibility of the generated value class.
abstract com.google.common.collect.ImmutableSet<QualifiedName>	getVisibleNestedTypes() Returns a set of nested types that will be visible in the generated class, either because they will be generated, or because they are present in a superclass.
boolean	hasBuilder() Returns true if there is a user-visible Builder subclass defined.
abstract boolean	isBuilderSerializable() Returns whether the builder type should be serializable.
abstract boolean	isInterfaceType() Returns true if the type is an interface.
Metadata.UnderrideLevel	standardMethodUnderride(Metadata.StandardMethod standardMethod)
Metadata.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

GET_CODE_GENERATOR

public static final com.google.common.base.Function<Metadata.Property,PropertyCodeGenerator> GET_CODE_GENERATOR

Constructor Detail

Metadata

public Metadata()

Method Detail

getType

public abstract ParameterizedType getType()

Returns the type itself.

isInterfaceType

public abstract boolean isInterfaceType()

Returns true if the type is an interface.

hasBuilder

public boolean hasBuilder()

Returns true if there is a user-visible Builder subclass defined.

getBuilder

public ParameterizedType getBuilder()

Returns the builder type that users will see.

Throws:

java.lang.IllegalStateException - if hasBuilder() returns false.

getBuilderFactory

public abstract com.google.common.base.Optional<BuilderFactory> getBuilderFactory()

Returns the builder factory mechanism the user has exposed, if any.

getGeneratedBuilder

public abstract ParameterizedType getGeneratedBuilder()

Returns the builder class that should be generated.

getValueType

public abstract ParameterizedType getValueType()

Returns the value class that should be generated.

getPartialType

public abstract ParameterizedType getPartialType()

Returns the partial value class that should be generated.

getVisibleNestedTypes

public abstract com.google.common.collect.ImmutableSet<QualifiedName> getVisibleNestedTypes()

Returns a set of nested types that will be visible in the generated class, either because they will be generated, or because they are present in a superclass.

getPropertyEnum

public abstract ParameterizedType getPropertyEnum()

Returns the Property enum that may be generated.

getProperties

public abstract com.google.common.collect.ImmutableList<Metadata.Property> getProperties()

Returns metadata about the properties of the type.

standardMethodUnderride

public Metadata.UnderrideLevel standardMethodUnderride(Metadata.StandardMethod standardMethod)

getStandardMethodUnderrides

public abstract com.google.common.collect.ImmutableMap<Metadata.StandardMethod,Metadata.UnderrideLevel> getStandardMethodUnderrides()

isBuilderSerializable

public abstract boolean isBuilderSerializable()

Returns whether the builder type should be serializable.

getGeneratedBuilderAnnotations

public abstract com.google.common.collect.ImmutableList<Excerpt> getGeneratedBuilderAnnotations()

Returns a list of annotations that should be applied to the generated builder class.

getValueTypeAnnotations

public abstract com.google.common.collect.ImmutableList<Excerpt> getValueTypeAnnotations()

Returns a list of annotations that should be applied to the generated value class.

getValueTypeVisibility

public abstract Metadata.Visibility getValueTypeVisibility()

Returns the visibility of the generated value class.

getNestedClasses

public abstract com.google.common.collect.ImmutableList<com.google.common.base.Function<Metadata,Excerpt>> getNestedClasses()

Returns a list of nested classes that should be added to the generated builder class.

toBuilder

public Metadata.Builder toBuilder()