org.inferred.freebuilder.processor

Class Metadata

java.lang.Object

org.inferred.freebuilder.processor.Metadata

public abstract class Metadata
extends 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 interface	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.

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

Methods

Modifier and Type	Method and Description
TypeElement	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 QualifiedName	getGeneratedBuilder() Returns the builder class that should be generated.
PackageElement	getPackage() Returns the package the type is in.
abstract QualifiedName	getPartialType() Returns the partial value class that should be generated.
abstract com.google.common.collect.ImmutableList<Metadata.Property>	getProperties() Returns metadata about the properies of the type.
abstract QualifiedName	getPropertyEnum() Returns the Property enum that may be generated.
abstract com.google.common.collect.ImmutableMap<Metadata.StandardMethod,Metadata.UnderrideLevel>	getStandardMethodUnderrides()
abstract TypeElement	getType() Returns the type itself.
abstract QualifiedName	getValueType() Returns the value class that should be generated.
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	isGwtCompatible() Returns whether the type (and hence the generated builder type) is GWT compatible.
abstract boolean	isGwtSerializable() Returns whether the type (and hence the generated value type) is GWT serializable.
Metadata.UnderrideLevel	standardMethodUnderride(Metadata.StandardMethod standardMethod)

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

getPackage

public PackageElement getPackage()

Returns the package the type is in.

getType

public abstract TypeElement getType()

Returns the type itself.

hasBuilder

public boolean hasBuilder()

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

getBuilder

public TypeElement getBuilder()

Returns the builder type that users will see.

Throws:

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 QualifiedName getGeneratedBuilder()

Returns the builder class that should be generated.

getValueType

public abstract QualifiedName getValueType()

Returns the value class that should be generated.

getPartialType

public abstract QualifiedName 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 QualifiedName getPropertyEnum()

Returns the Property enum that may be generated.

getProperties

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

Returns metadata about the properies 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.

isGwtCompatible

public abstract boolean isGwtCompatible()

Returns whether the type (and hence the generated builder type) is GWT compatible.

isGwtSerializable

public abstract boolean isGwtSerializable()

Returns whether the type (and hence the generated value type) is GWT serializable.