Metadata.Builder (@FreeBuilder 1.5 API)

java.lang.Object
- org.inferred.freebuilder.processor.Metadata.Builder

Enclosing class:: Metadata

public static class Metadata.Builder
extends Object

Builder for Metadata.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Metadata.Builder`	`addAllProperties(Iterable<? extends Metadata.Property> elements)` Adds each element of `elements` to the list to be returned from `Metadata.getProperties()`.
`Metadata.Builder`	`addAllVisibleNestedTypes(Iterable<? extends QualifiedName> elements)` Adds each element of `elements` to the set to be returned from `Metadata.getVisibleNestedTypes()`, ignoring duplicate elements (only the first duplicate element is added).
`Metadata.Builder`	`addProperties(Metadata.Property... elements)` Adds each element of `elements` to the list to be returned from `Metadata.getProperties()`.
`Metadata.Builder`	`addProperties(Metadata.Property element)` Adds `element` to the list to be returned from `Metadata.getProperties()`.
`Metadata.Builder`	`addVisibleNestedTypes(QualifiedName... elements)` Adds each element of `elements` to the set to be returned from `Metadata.getVisibleNestedTypes()`, ignoring duplicate elements (only the first duplicate element is added).
`Metadata.Builder`	`addVisibleNestedTypes(QualifiedName element)` Adds `element` to the set to be returned from `Metadata.getVisibleNestedTypes()`.
`Metadata`	`build()` Returns a newly-built `Metadata` based on the content of the `Builder`.
`Metadata`	`buildPartial()` Returns a newly-created partial `Metadata` based on the contents of the `Builder`.
`Metadata.Builder`	`clear()` Resets the state of this builder.
`Metadata.Builder`	`clearBuilderFactory()` Sets the value to be returned by `Metadata.getBuilderFactory()` to `Optional.absent()`.
`Metadata.Builder`	`clearOptionalBuilder()` Sets the value to be returned by `Metadata.getOptionalBuilder()` to `Optional.absent()`.
`Metadata.Builder`	`clearProperties()` Clears the list to be returned from `Metadata.getProperties()`.
`Metadata.Builder`	`clearStandardMethodUnderrides()` Removes all of the mappings from the map to be returned from `Metadata.getStandardMethodUnderrides()`.
`Metadata.Builder`	`clearVisibleNestedTypes()` Clears the set to be returned from `Metadata.getVisibleNestedTypes()`.
`com.google.common.base.Optional<BuilderFactory>`	`getBuilderFactory()` Returns the value that will be returned by `Metadata.getBuilderFactory()`.
`ParameterizedType`	`getGeneratedBuilder()` Returns the value that will be returned by `Metadata.getGeneratedBuilder()`.
`com.google.common.base.Optional<ParameterizedType>`	`getOptionalBuilder()` Returns the value that will be returned by `Metadata.getOptionalBuilder()`.
`ParameterizedType`	`getPartialType()` Returns the value that will be returned by `Metadata.getPartialType()`.
`List<Metadata.Property>`	`getProperties()` Returns an unmodifiable view of the list that will be returned by `Metadata.getProperties()`.
`ParameterizedType`	`getPropertyEnum()` Returns the value that will be returned by `Metadata.getPropertyEnum()`.
`Map<Metadata.StandardMethod,Metadata.UnderrideLevel>`	`getStandardMethodUnderrides()` Returns an unmodifiable view of the map that will be returned by `Metadata.getStandardMethodUnderrides()`.
`ParameterizedType`	`getType()` Returns the value that will be returned by `Metadata.getType()`.
`ParameterizedType`	`getValueType()` Returns the value that will be returned by `Metadata.getValueType()`.
`Set<QualifiedName>`	`getVisibleNestedTypes()` Returns an unmodifiable view of the set that will be returned by `Metadata.getVisibleNestedTypes()`.
`boolean`	`isBuilderSerializable()` Returns the value that will be returned by `Metadata.isBuilderSerializable()`.
`boolean`	`isGwtCompatible()` Returns the value that will be returned by `Metadata.isGwtCompatible()`.
`boolean`	`isGwtSerializable()` Returns the value that will be returned by `Metadata.isGwtSerializable()`.
`boolean`	`isInterfaceType()` Returns the value that will be returned by `Metadata.isInterfaceType()`.
`Metadata.Builder`	`mergeFrom(Metadata.Builder template)` Copies values from the given `Builder`.
`Metadata.Builder`	`mergeFrom(Metadata value)` Sets all property values using the given `Metadata` as a template.
`Metadata.Builder`	`putAllStandardMethodUnderrides(Map<? extends Metadata.StandardMethod,? extends Metadata.UnderrideLevel> map)` Associates all of `map`'s keys and values in the map to be returned from `Metadata.getStandardMethodUnderrides()`.
`Metadata.Builder`	`putStandardMethodUnderrides(Metadata.StandardMethod key, Metadata.UnderrideLevel value)` Associates `key` with `value` in the map to be returned from `Metadata.getStandardMethodUnderrides()`.
`Metadata.Builder`	`removeStandardMethodUnderrides(Metadata.StandardMethod key)` Removes the mapping for `key` from the map to be returned from `Metadata.getStandardMethodUnderrides()`.
`Metadata.Builder`	`setBuilder(com.google.common.base.Optional<ParameterizedType> builder)` Sets the builder class that users will see, if any.
`Metadata.Builder`	`setBuilder(ParameterizedType builder)` Sets the builder class that users will see.
`Metadata.Builder`	`setBuilderFactory(BuilderFactory builderFactory)` Sets the value to be returned by `Metadata.getBuilderFactory()`.
`Metadata.Builder`	`setBuilderFactory(com.google.common.base.Optional<? extends BuilderFactory> builderFactory)` Sets the value to be returned by `Metadata.getBuilderFactory()`.
`Metadata.Builder`	`setBuilderSerializable(boolean builderSerializable)` Sets the value to be returned by `Metadata.isBuilderSerializable()`.
`Metadata.Builder`	`setGeneratedBuilder(ParameterizedType generatedBuilder)` Sets the value to be returned by `Metadata.getGeneratedBuilder()`.
`Metadata.Builder`	`setGwtCompatible(boolean gwtCompatible)` Sets the value to be returned by `Metadata.isGwtCompatible()`.
`Metadata.Builder`	`setGwtSerializable(boolean gwtSerializable)` Sets the value to be returned by `Metadata.isGwtSerializable()`.
`Metadata.Builder`	`setInterfaceType(boolean interfaceType)` Sets the value to be returned by `Metadata.isInterfaceType()`.
`Metadata.Builder`	`setNullableBuilderFactory(BuilderFactory builderFactory)` Sets the value to be returned by `Metadata.getBuilderFactory()`.
`Metadata.Builder`	`setNullableOptionalBuilder(ParameterizedType optionalBuilder)` Sets the value to be returned by `Metadata.getOptionalBuilder()`.
`Metadata.Builder`	`setOptionalBuilder(com.google.common.base.Optional<? extends ParameterizedType> optionalBuilder)` Sets the value to be returned by `Metadata.getOptionalBuilder()`.
`Metadata.Builder`	`setOptionalBuilder(ParameterizedType optionalBuilder)` Sets the value to be returned by `Metadata.getOptionalBuilder()`.
`Metadata.Builder`	`setPartialType(ParameterizedType partialType)` Sets the value to be returned by `Metadata.getPartialType()`.
`Metadata.Builder`	`setPropertyEnum(ParameterizedType propertyEnum)` Sets the value to be returned by `Metadata.getPropertyEnum()`.
`Metadata.Builder`	`setType(ParameterizedType type)` Sets the value to be returned by `Metadata.getType()`.
`Metadata.Builder`	`setValueType(ParameterizedType valueType)` Sets the value to be returned by `Metadata.getValueType()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - setBuilder
```
public Metadata.Builder setBuilder(com.google.common.base.Optional<ParameterizedType> builder)
```
    Sets the builder class that users will see, if any.
  - setBuilder
```
public Metadata.Builder setBuilder(ParameterizedType builder)
```
    Sets the builder class that users will see.
  - build
```
public Metadata build()
```
    Returns a newly-built Metadata based on the content of the Builder.
  - setBuilderFactory
```
public Metadata.Builder setBuilderFactory(BuilderFactory builderFactory)
```
    Sets the value to be returned by Metadata.getBuilderFactory().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if builderFactory is null
  - setBuilderFactory
```
public Metadata.Builder setBuilderFactory(com.google.common.base.Optional<? extends BuilderFactory> builderFactory)
```
    Sets the value to be returned by Metadata.getBuilderFactory().
    
    Returns:
    
    this Builder object
  - setNullableBuilderFactory
```
public Metadata.Builder setNullableBuilderFactory(@Nullable
                                                  BuilderFactory builderFactory)
```
    Sets the value to be returned by Metadata.getBuilderFactory().
    
    Returns:
    
    this Builder object
  - clearBuilderFactory
```
public Metadata.Builder clearBuilderFactory()
```
    Sets the value to be returned by Metadata.getBuilderFactory() to Optional.absent().
    
    Returns:
    
    this Builder object
  - getBuilderFactory
```
public com.google.common.base.Optional<BuilderFactory> getBuilderFactory()
```
    Returns the value that will be returned by Metadata.getBuilderFactory().
  - setGeneratedBuilder
```
public Metadata.Builder setGeneratedBuilder(ParameterizedType generatedBuilder)
```
    Sets the value to be returned by Metadata.getGeneratedBuilder().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if generatedBuilder is null
  - getGeneratedBuilder
```
public ParameterizedType getGeneratedBuilder()
```
    Returns the value that will be returned by Metadata.getGeneratedBuilder().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - setOptionalBuilder
```
public Metadata.Builder setOptionalBuilder(ParameterizedType optionalBuilder)
```
    Sets the value to be returned by Metadata.getOptionalBuilder().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if optionalBuilder is null
  - setOptionalBuilder
```
public Metadata.Builder setOptionalBuilder(com.google.common.base.Optional<? extends ParameterizedType> optionalBuilder)
```
    Sets the value to be returned by Metadata.getOptionalBuilder().
    
    Returns:
    
    this Builder object
  - setNullableOptionalBuilder
```
public Metadata.Builder setNullableOptionalBuilder(@Nullable
                                                   ParameterizedType optionalBuilder)
```
    Sets the value to be returned by Metadata.getOptionalBuilder().
    
    Returns:
    
    this Builder object
  - clearOptionalBuilder
```
public Metadata.Builder clearOptionalBuilder()
```
    Sets the value to be returned by Metadata.getOptionalBuilder() to Optional.absent().
    
    Returns:
    
    this Builder object
  - getOptionalBuilder
```
public com.google.common.base.Optional<ParameterizedType> getOptionalBuilder()
```
    Returns the value that will be returned by Metadata.getOptionalBuilder().
  - setPartialType
```
public Metadata.Builder setPartialType(ParameterizedType partialType)
```
    Sets the value to be returned by Metadata.getPartialType().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if partialType is null
  - getPartialType
```
public ParameterizedType getPartialType()
```
    Returns the value that will be returned by Metadata.getPartialType().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - addProperties
```
public Metadata.Builder addProperties(Metadata.Property element)
```
    Adds element to the list to be returned from Metadata.getProperties().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if element is null
  - addProperties
```
public Metadata.Builder addProperties(Metadata.Property... elements)
```
    Adds each element of elements to the list to be returned from Metadata.getProperties().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if elements is null or contains a null element
  - addAllProperties
```
public Metadata.Builder addAllProperties(Iterable<? extends Metadata.Property> elements)
```
    Adds each element of elements to the list to be returned from Metadata.getProperties().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if elements is null or contains a null element
  - clearProperties
```
public Metadata.Builder clearProperties()
```
    Clears the list to be returned from Metadata.getProperties().
    
    Returns:
    
    this Builder object
  - getProperties
```
public List<Metadata.Property> getProperties()
```
    Returns an unmodifiable view of the list that will be returned by Metadata.getProperties(). Changes to this builder will be reflected in the view.
  - setPropertyEnum
```
public Metadata.Builder setPropertyEnum(ParameterizedType propertyEnum)
```
    Sets the value to be returned by Metadata.getPropertyEnum().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if propertyEnum is null
  - getPropertyEnum
```
public ParameterizedType getPropertyEnum()
```
    Returns the value that will be returned by Metadata.getPropertyEnum().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - putStandardMethodUnderrides
```
public Metadata.Builder putStandardMethodUnderrides(Metadata.StandardMethod key,
                                                    Metadata.UnderrideLevel value)
```
    Associates key with value in the map to be returned from Metadata.getStandardMethodUnderrides(). Duplicate keys are not allowed.
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if either key or value are null
    
    IllegalArgumentException - if key is already present
  - putAllStandardMethodUnderrides
```
public Metadata.Builder putAllStandardMethodUnderrides(Map<? extends Metadata.StandardMethod,? extends Metadata.UnderrideLevel> map)
```
    Associates all of map's keys and values in the map to be returned from Metadata.getStandardMethodUnderrides(). Duplicate keys are not allowed.
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if map is null or contains a null key or value
    
    IllegalArgumentException - if any key is already present
  - removeStandardMethodUnderrides
```
public Metadata.Builder removeStandardMethodUnderrides(Metadata.StandardMethod key)
```
    Removes the mapping for key from the map to be returned from Metadata.getStandardMethodUnderrides().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if key is null
    
    IllegalArgumentException - if key is not present
  - clearStandardMethodUnderrides
```
public Metadata.Builder clearStandardMethodUnderrides()
```
    Removes all of the mappings from the map to be returned from Metadata.getStandardMethodUnderrides().
    
    Returns:
    
    this Builder object
  - getStandardMethodUnderrides
```
public Map<Metadata.StandardMethod,Metadata.UnderrideLevel> getStandardMethodUnderrides()
```
    Returns an unmodifiable view of the map that will be returned by Metadata.getStandardMethodUnderrides(). Changes to this builder will be reflected in the view.
  - setType
```
public Metadata.Builder setType(ParameterizedType type)
```
    Sets the value to be returned by Metadata.getType().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if type is null
  - getType
```
public ParameterizedType getType()
```
    Returns the value that will be returned by Metadata.getType().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - setValueType
```
public Metadata.Builder setValueType(ParameterizedType valueType)
```
    Sets the value to be returned by Metadata.getValueType().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if valueType is null
  - getValueType
```
public ParameterizedType getValueType()
```
    Returns the value that will be returned by Metadata.getValueType().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - addVisibleNestedTypes
```
public Metadata.Builder addVisibleNestedTypes(QualifiedName element)
```
    Adds element to the set to be returned from Metadata.getVisibleNestedTypes(). If the set already contains element, then addVisibleNestedTypes has no effect (only the previously added element is retained).
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if element is null
  - addVisibleNestedTypes
```
public Metadata.Builder addVisibleNestedTypes(QualifiedName... elements)
```
    Adds each element of elements to the set to be returned from Metadata.getVisibleNestedTypes(), ignoring duplicate elements (only the first duplicate element is added).
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if elements is null or contains a null element
  - addAllVisibleNestedTypes
```
public Metadata.Builder addAllVisibleNestedTypes(Iterable<? extends QualifiedName> elements)
```
    Adds each element of elements to the set to be returned from Metadata.getVisibleNestedTypes(), ignoring duplicate elements (only the first duplicate element is added).
    
    Returns:
    
    this Builder object
    
    Throws:
    
    NullPointerException - if elements is null or contains a null element
  - clearVisibleNestedTypes
```
public Metadata.Builder clearVisibleNestedTypes()
```
    Clears the set to be returned from Metadata.getVisibleNestedTypes().
    
    Returns:
    
    this Builder object
  - getVisibleNestedTypes
```
public Set<QualifiedName> getVisibleNestedTypes()
```
    Returns an unmodifiable view of the set that will be returned by Metadata.getVisibleNestedTypes(). Changes to this builder will be reflected in the view.
  - setBuilderSerializable
```
public Metadata.Builder setBuilderSerializable(boolean builderSerializable)
```
    Sets the value to be returned by Metadata.isBuilderSerializable().
    
    Returns:
    
    this Builder object
  - isBuilderSerializable
```
public boolean isBuilderSerializable()
```
    Returns the value that will be returned by Metadata.isBuilderSerializable().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - setGwtCompatible
```
public Metadata.Builder setGwtCompatible(boolean gwtCompatible)
```
    Sets the value to be returned by Metadata.isGwtCompatible().
    
    Returns:
    
    this Builder object
  - isGwtCompatible
```
public boolean isGwtCompatible()
```
    Returns the value that will be returned by Metadata.isGwtCompatible().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - setGwtSerializable
```
public Metadata.Builder setGwtSerializable(boolean gwtSerializable)
```
    Sets the value to be returned by Metadata.isGwtSerializable().
    
    Returns:
    
    this Builder object
  - isGwtSerializable
```
public boolean isGwtSerializable()
```
    Returns the value that will be returned by Metadata.isGwtSerializable().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - setInterfaceType
```
public Metadata.Builder setInterfaceType(boolean interfaceType)
```
    Sets the value to be returned by Metadata.isInterfaceType().
    
    Returns:
    
    this Builder object
  - isInterfaceType
```
public boolean isInterfaceType()
```
    Returns the value that will be returned by Metadata.isInterfaceType().
    
    Throws:
    
    IllegalStateException - if the field has not been set
  - mergeFrom
```
public Metadata.Builder mergeFrom(Metadata value)
```
    Sets all property values using the given Metadata as a template.
  - mergeFrom
```
public Metadata.Builder mergeFrom(Metadata.Builder template)
```
    Copies values from the given Builder. Does not affect any properties not set on the input.
  - clear
```
public Metadata.Builder clear()
```
    Resets the state of this builder.
  - buildPartial
```
public Metadata buildPartial()
```
    Returns a newly-created partial Metadata based on the contents of the Builder. State checking will not be performed. Unset properties will throw an UnsupportedOperationException when accessed via the partial object.
    Partials should only ever be used in tests.

Class Metadata.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setBuilder

setBuilder

build

setBuilderFactory

setBuilderFactory

setNullableBuilderFactory

clearBuilderFactory

getBuilderFactory

setGeneratedBuilder

getGeneratedBuilder

setOptionalBuilder

setOptionalBuilder

setNullableOptionalBuilder

clearOptionalBuilder

getOptionalBuilder

setPartialType

getPartialType

addProperties

addProperties

addAllProperties

clearProperties

getProperties

setPropertyEnum

getPropertyEnum

putStandardMethodUnderrides

putAllStandardMethodUnderrides

removeStandardMethodUnderrides

clearStandardMethodUnderrides

getStandardMethodUnderrides

setType

getType

setValueType

getValueType

addVisibleNestedTypes

addVisibleNestedTypes

addAllVisibleNestedTypes

clearVisibleNestedTypes

getVisibleNestedTypes

setBuilderSerializable

isBuilderSerializable

setGwtCompatible

isGwtCompatible

setGwtSerializable

isGwtSerializable

setInterfaceType

isInterfaceType

mergeFrom

mergeFrom

clear

buildPartial