Package org.inferred.freebuilder.processor

Class BuildableType_Builder

java.lang.Object

org.inferred.freebuilder.processor.BuildableType_Builder

Direct Known Subclasses:

BuildableType.Builder

@Generated("org.inferred.freebuilder.processor.Processor")
abstract class BuildableType_Builder
extends java.lang.Object

Auto-generated superclass of BuildableType.Builder, derived from the API of BuildableType.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	BuildableType_Builder.Partial
private static class	BuildableType_Builder.Property
private static class	BuildableType_Builder.Rebuildable
private static class	BuildableType_Builder.Value

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.EnumSet<BuildableType_Builder.Property>	_unsetProperties
private BuilderFactory	builderFactory
private Type	builderType
private BuildableType.MergeBuilderMethod	mergeBuilder
private BuildableType.PartialToBuilderMethod	partialToBuilder
private Excerpt	suppressUnchecked
private Type	type

Constructor Summary

Constructors

Constructor	Description
BuildableType_Builder()

Method Summary

Modifier and Type	Method	Description
BuildableType	build()	Returns a newly-created BuildableType based on the contents of this Builder.
BuilderFactory	builderFactory()	Returns the value that will be returned by BuildableType.builderFactory().
BuildableType.Builder	builderFactory(BuilderFactory builderFactory)	Sets the value to be returned by BuildableType.builderFactory().
Type	builderType()	Returns the value that will be returned by BuildableType.builderType().
BuildableType.Builder	builderType(Type builderType)	Sets the value to be returned by BuildableType.builderType().
BuildableType	buildPartial()	Returns a newly-created partial BuildableType for use in unit tests.
BuildableType.Builder	clear()	Resets the state of this builder.
static BuildableType.Builder	from(BuildableType value)	Creates a new builder using value as a template.
BuildableType.Builder	mapBuilderFactory(java.util.function.UnaryOperator<BuilderFactory> mapper)	Replaces the value to be returned by BuildableType.builderFactory() by applying mapper to it and using the result.
BuildableType.Builder	mapBuilderType(java.util.function.UnaryOperator<Type> mapper)	Replaces the value to be returned by BuildableType.builderType() by applying mapper to it and using the result.
BuildableType.Builder	mapMergeBuilder(java.util.function.UnaryOperator<BuildableType.MergeBuilderMethod> mapper)	Replaces the value to be returned by BuildableType.mergeBuilder() by applying mapper to it and using the result.
BuildableType.Builder	mapPartialToBuilder(java.util.function.UnaryOperator<BuildableType.PartialToBuilderMethod> mapper)	Replaces the value to be returned by BuildableType.partialToBuilder() by applying mapper to it and using the result.
BuildableType.Builder	mapSuppressUnchecked(java.util.function.UnaryOperator<Excerpt> mapper)	Replaces the value to be returned by BuildableType.suppressUnchecked() by applying mapper to it and using the result.
BuildableType.Builder	mapType(java.util.function.UnaryOperator<Type> mapper)	Replaces the value to be returned by BuildableType.type() by applying mapper to it and using the result.
BuildableType.MergeBuilderMethod	mergeBuilder()	Returns the value that will be returned by BuildableType.mergeBuilder().
BuildableType.Builder	mergeBuilder(BuildableType.MergeBuilderMethod mergeBuilder)	Sets the value to be returned by BuildableType.mergeBuilder().
BuildableType.Builder	mergeFrom(BuildableType value)	Copies values from value.
BuildableType.Builder	mergeFrom(BuildableType.Builder template)	Copies values from template, skipping unset properties.
BuildableType.PartialToBuilderMethod	partialToBuilder()	Returns the value that will be returned by BuildableType.partialToBuilder().
BuildableType.Builder	partialToBuilder(BuildableType.PartialToBuilderMethod partialToBuilder)	Sets the value to be returned by BuildableType.partialToBuilder().
Excerpt	suppressUnchecked()	Returns the value that will be returned by BuildableType.suppressUnchecked().
BuildableType.Builder	suppressUnchecked(Excerpt suppressUnchecked)	Sets the value to be returned by BuildableType.suppressUnchecked().
Type	type()	Returns the value that will be returned by BuildableType.type().
BuildableType.Builder	type(Type type)	Sets the value to be returned by BuildableType.type().

Methods inherited from class java.lang.Object

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

Field Detail

type

private Type type

builderType

private Type builderType

mergeBuilder

private BuildableType.MergeBuilderMethod mergeBuilder

partialToBuilder

private BuildableType.PartialToBuilderMethod partialToBuilder

builderFactory

private BuilderFactory builderFactory

suppressUnchecked

private Excerpt suppressUnchecked

_unsetProperties

private final java.util.EnumSet<BuildableType_Builder.Property> _unsetProperties

Constructor Detail

BuildableType_Builder

BuildableType_Builder()

Method Detail

from

public static BuildableType.Builder from(BuildableType value)

Creates a new builder using value as a template.

If value is a partial, the builder will return more partials.

type

public BuildableType.Builder type(Type type)

Sets the value to be returned by BuildableType.type().

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if type is null

mapType

public BuildableType.Builder mapType(java.util.function.UnaryOperator<Type> mapper)

Replaces the value to be returned by BuildableType.type() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if mapper is null or returns null

java.lang.IllegalStateException - if the field has not been set

type

public Type type()

Returns the value that will be returned by BuildableType.type().

Throws:

java.lang.IllegalStateException - if the field has not been set

builderType

public BuildableType.Builder builderType(Type builderType)

Sets the value to be returned by BuildableType.builderType().

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if builderType is null

mapBuilderType

public BuildableType.Builder mapBuilderType(java.util.function.UnaryOperator<Type> mapper)

Replaces the value to be returned by BuildableType.builderType() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if mapper is null or returns null

java.lang.IllegalStateException - if the field has not been set

builderType

public Type builderType()

Returns the value that will be returned by BuildableType.builderType().

Throws:

java.lang.IllegalStateException - if the field has not been set

mergeBuilder

public BuildableType.Builder mergeBuilder(BuildableType.MergeBuilderMethod mergeBuilder)

Sets the value to be returned by BuildableType.mergeBuilder().

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if mergeBuilder is null

mapMergeBuilder

public BuildableType.Builder mapMergeBuilder(java.util.function.UnaryOperator<BuildableType.MergeBuilderMethod> mapper)

Replaces the value to be returned by BuildableType.mergeBuilder() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if mapper is null or returns null

java.lang.IllegalStateException - if the field has not been set

mergeBuilder

public BuildableType.MergeBuilderMethod mergeBuilder()

Returns the value that will be returned by BuildableType.mergeBuilder().

Throws:

java.lang.IllegalStateException - if the field has not been set

partialToBuilder

public BuildableType.Builder partialToBuilder(BuildableType.PartialToBuilderMethod partialToBuilder)

Sets the value to be returned by BuildableType.partialToBuilder().

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if partialToBuilder is null

mapPartialToBuilder

public BuildableType.Builder mapPartialToBuilder(java.util.function.UnaryOperator<BuildableType.PartialToBuilderMethod> mapper)

Replaces the value to be returned by BuildableType.partialToBuilder() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if mapper is null or returns null

java.lang.IllegalStateException - if the field has not been set

partialToBuilder

public BuildableType.PartialToBuilderMethod partialToBuilder()

Returns the value that will be returned by BuildableType.partialToBuilder().

Throws:

java.lang.IllegalStateException - if the field has not been set

builderFactory

public BuildableType.Builder builderFactory(BuilderFactory builderFactory)

Sets the value to be returned by BuildableType.builderFactory().

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if builderFactory is null

mapBuilderFactory

public BuildableType.Builder mapBuilderFactory(java.util.function.UnaryOperator<BuilderFactory> mapper)

Replaces the value to be returned by BuildableType.builderFactory() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if mapper is null or returns null

java.lang.IllegalStateException - if the field has not been set

builderFactory

public BuilderFactory builderFactory()

Returns the value that will be returned by BuildableType.builderFactory().

Throws:

java.lang.IllegalStateException - if the field has not been set

suppressUnchecked

public BuildableType.Builder suppressUnchecked(Excerpt suppressUnchecked)

Sets the value to be returned by BuildableType.suppressUnchecked().

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if suppressUnchecked is null

mapSuppressUnchecked

public BuildableType.Builder mapSuppressUnchecked(java.util.function.UnaryOperator<Excerpt> mapper)

Replaces the value to be returned by BuildableType.suppressUnchecked() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if mapper is null or returns null

java.lang.IllegalStateException - if the field has not been set

suppressUnchecked

public Excerpt suppressUnchecked()

Returns the value that will be returned by BuildableType.suppressUnchecked().

Throws:

java.lang.IllegalStateException - if the field has not been set

mergeFrom

public BuildableType.Builder mergeFrom(BuildableType value)

Copies values from value.

Returns:

this Builder object

mergeFrom

public BuildableType.Builder mergeFrom(BuildableType.Builder template)

Copies values from template, skipping unset properties.

Returns:

this Builder object

clear

public BuildableType.Builder clear()

Resets the state of this builder.

Returns:

this Builder object

build

public BuildableType build()

Returns a newly-created BuildableType based on the contents of this Builder.

Throws:

java.lang.IllegalStateException - if any field has not been set

buildPartial

public BuildableType buildPartial()

Returns a newly-created partial BuildableType for use in unit tests. State checking will not be performed. Unset properties will throw an UnsupportedOperationException when accessed via the partial object.

The builder returned by from(BuildableType) will propagate the partial status of its input, overriding build() to return another partial. This allows for robust tests of modify-rebuild code.

Partials should only ever be used in tests. They permit writing robust test cases that won't fail if this type gains more application-level constraints (e.g. new required fields) in future. If you require partially complete values in production code, consider using a Builder.