ch.rasc.bsoncodec.model

Class ImmutableIdModel.Builder

java.lang.Object

ch.rasc.bsoncodec.model.ImmutableIdModel.Builder

Enclosing class:

ImmutableIdModel

@NotThreadSafe
public static final class ImmutableIdModel.Builder
extends Object

Builds instances of ImmutableIdModel. 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
ImmutableIdModel	build() Builds new ImmutableIdModel.
ImmutableIdModel.Builder	codecName(String codecName) Initializes value for codecName.
ImmutableIdModel.Builder	conversion(Id.IdConversion conversion) Initializes value for conversion.
ImmutableIdModel.Builder	from(IdModel instance) Fill builder with attribute values from provided IdModel instance.
ImmutableIdModel.Builder	generatorName(String generatorName) Initializes value for generatorName.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableIdModel.Builder from(IdModel instance)

Fill builder with attribute values from provided IdModel 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

generatorName

public final ImmutableIdModel.Builder generatorName(@Nullable
                                                    String generatorName)

Initializes value for generatorName.

Parameters:

generatorName - value for generatorName, can be null

Returns:

this builder for chained invocation

conversion

public final ImmutableIdModel.Builder conversion(@Nullable
                                                 Id.IdConversion conversion)

Initializes value for conversion.

Parameters:

conversion - value for conversion, can be null

Returns:

this builder for chained invocation

codecName

public final ImmutableIdModel.Builder codecName(@Nullable
                                                String codecName)

Initializes value for codecName.

Parameters:

codecName - value for codecName, can be null

Returns:

this builder for chained invocation

build

public ImmutableIdModel build()
                       throws IllegalStateException

Builds new ImmutableIdModel.

Returns:

immutable instance of IdModel

Throws:

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

IllegalStateException