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 ImmutableInstanceField. Initialize attributes and then invoke build() method to create immutable instance.

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

Method Summary

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

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 builder with attribute values from provided InstanceField instance. Regular attribute values will be replaced with ones of an instance. Instance's absent optional values will not replace present values.

Parameters:

instance - instance to copy values from

Returns:

this builder for chained invocation

type

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

Initializes value for type.

Parameters:

type - value for type

Returns:

this builder for chained invocation

name

public final ImmutableInstanceField.Builder name(String name)

Initializes value for name.

Parameters:

name - value for name

Returns:

this builder for chained invocation

codecForClass

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

Initializes value for codecForClass.

Parameters:

codecForClass - value for codecForClass, can be null

Returns:

this builder for chained invocation

customCodec

public final ImmutableInstanceField.Builder customCodec(boolean customCodec)

Initializes value for customCodec.

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

Parameters:

customCodec - value for customCodec

Returns:

this builder for chained invocation

build

public ImmutableInstanceField build()
                             throws IllegalStateException

Builds new ImmutableInstanceField.

Returns:

immutable instance of InstanceField

Throws:

exception - java.lang.IllegalStateException if any required attributes are missing

IllegalStateException