ch.rasc.bsoncodec.model

Class ImmutableInstanceField.Builder

java.lang.Object

ch.rasc.bsoncodec.model.ImmutableInstanceField.Builder

Enclosing class:

ImmutableInstanceField

@NotThreadSafe
public static final class ImmutableInstanceField.Builder
extends Object

Builds instances of type ImmutableInstanceField. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
ImmutableInstanceField	build() Builds a new ImmutableInstanceField.
ImmutableInstanceField.Builder	codecForClass(com.squareup.javapoet.TypeName codecForClass) Initializes the value for the codecForClass attribute.
ImmutableInstanceField.Builder	customCodec(boolean customCodec) Initializes the value for the customCodec attribute.
ImmutableInstanceField.Builder	from(InstanceField instance) Fill a builder with attribute values from the provided InstanceField instance.
ImmutableInstanceField.Builder	name(String name) Initializes the value for the name attribute.
ImmutableInstanceField.Builder	type(com.squareup.javapoet.TypeName type) Initializes the value for the type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableInstanceField.Builder from(InstanceField instance)

Fill a builder with attribute values from the provided InstanceField instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

type

public final ImmutableInstanceField.Builder type(com.squareup.javapoet.TypeName type)

Initializes the value for the type attribute.

Parameters:

type - The value for type

Returns:

this builder for use in a chained invocation

name

public final ImmutableInstanceField.Builder name(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

codecForClass

public final ImmutableInstanceField.Builder codecForClass(@Nullable
                                                          com.squareup.javapoet.TypeName codecForClass)

Initializes the value for the codecForClass attribute.

Parameters:

codecForClass - The value for codecForClass (can be null)

Returns:

this builder for use in a chained invocation

customCodec

public final ImmutableInstanceField.Builder customCodec(boolean customCodec)

Initializes the value for the customCodec attribute.

If not set, this attribute will have a default value as returned by the initializer of customCodec.

Parameters:

customCodec - The value for customCodec

Returns:

this builder for use in a chained invocation

build

public ImmutableInstanceField build()

Builds a new ImmutableInstanceField.

Returns:

An immutable instance of InstanceField

Throws:

IllegalStateException - if any required attributes are missing