Datatype (FreeBuilder 2.1.1 API)

java.lang.Object
- org.inferred.freebuilder.processor.Datatype

public abstract class Datatype
extends java.lang.Object

Metadata about a user's datatype.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Datatype.Builder` Builder for `Datatype`.
`static class`	`Datatype.StandardMethod` Standard Java methods that may be underridden.
`static class`	`Datatype.UnderrideLevel` How compulsory the underride is.
`static class`	`Datatype.Visibility`

Constructor Summary

Constructors
Constructor and Description

Datatype()

Constructors
Constructor and Description
`Datatype()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Type`	`getBuilder()` Returns the builder type that users will see.
`abstract java.util.Optional<BuilderFactory>`	`getBuilderFactory()` Returns the builder factory mechanism the user has exposed, if any.
`abstract TypeClass`	`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 boolean`	`getHasToBuilderMethod()` Returns whether the value type has a toBuilder method that needs to be generated.
`abstract com.google.common.collect.ImmutableList<Excerpt>`	`getNestedClasses()` Returns a list of nested classes that should be added to the generated builder class.
`abstract TypeClass`	`getPartialType()` Returns the partial value class that should be generated.
`abstract TypeClass`	`getPropertyEnum()` Returns the Property enum that may be generated.
`abstract com.google.common.collect.ImmutableMap<Datatype.StandardMethod,Datatype.UnderrideLevel>`	`getStandardMethodUnderrides()`
`abstract TypeClass`	`getType()` Returns the type itself.
`abstract TypeClass`	`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 Datatype.Visibility`	`getValueTypeVisibility()` Returns the visibility of the generated value class.
`abstract boolean`	`isBuilderSerializable()` Returns whether the builder type should be serializable.
`abstract boolean`	`isExtensible()` Whether there is a package-visible, no-args constructor so we can subclass the Builder.
`abstract boolean`	`isInterfaceType()` Returns true if the type is an interface.
`Datatype.UnderrideLevel`	`standardMethodUnderride(Datatype.StandardMethod standardMethod)`
`Datatype.Builder`	`toBuilder()`

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

- Constructor Detail
  - Datatype
```
public Datatype()
```
- Method Detail
  - getType
```
public abstract TypeClass getType()
```
    Returns the type itself.
  - isInterfaceType
```
public abstract boolean isInterfaceType()
```
    Returns true if the type is an interface.
  - getBuilder
```
public abstract Type getBuilder()
```
    Returns the builder type that users will see.
    
    Throws:
    
    java.lang.IllegalStateException - if #hasBuilder returns false.
  - isExtensible
```
public abstract boolean isExtensible()
```
    Whether there is a package-visible, no-args constructor so we can subclass the Builder.
  - getBuilderFactory
```
public abstract java.util.Optional<BuilderFactory> getBuilderFactory()
```
    Returns the builder factory mechanism the user has exposed, if any.
  - getGeneratedBuilder
```
public abstract TypeClass getGeneratedBuilder()
```
    Returns the builder class that should be generated.
  - getValueType
```
public abstract TypeClass getValueType()
```
    Returns the value class that should be generated.
  - getPartialType
```
public abstract TypeClass getPartialType()
```
    Returns the partial value class that should be generated.
  - getPropertyEnum
```
public abstract TypeClass getPropertyEnum()
```
    Returns the Property enum that may be generated.
  - standardMethodUnderride
```
public Datatype.UnderrideLevel standardMethodUnderride(Datatype.StandardMethod standardMethod)
```
  - getStandardMethodUnderrides
```
public abstract com.google.common.collect.ImmutableMap<Datatype.StandardMethod,Datatype.UnderrideLevel> getStandardMethodUnderrides()
```
  - isBuilderSerializable
```
public abstract boolean isBuilderSerializable()
```
    Returns whether the builder type should be serializable.
  - getHasToBuilderMethod
```
public abstract boolean getHasToBuilderMethod()
```
    Returns whether the value type has a toBuilder method that needs to be generated.
  - 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 Datatype.Visibility getValueTypeVisibility()
```
    Returns the visibility of the generated value class.
  - getNestedClasses
```
public abstract com.google.common.collect.ImmutableList<Excerpt> getNestedClasses()
```
    Returns a list of nested classes that should be added to the generated builder class.
  - toBuilder
```
public Datatype.Builder toBuilder()
```

Class Datatype

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Datatype

Method Detail

getType

isInterfaceType

getBuilder

isExtensible

getBuilderFactory

getGeneratedBuilder

getValueType

getPartialType

getPropertyEnum

standardMethodUnderride

getStandardMethodUnderrides

isBuilderSerializable

getHasToBuilderMethod

getGeneratedBuilderAnnotations

getValueTypeAnnotations

getValueTypeVisibility

getNestedClasses

toBuilder