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 type ImmutableIdModel. 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
ImmutableIdModel	build() Builds a new ImmutableIdModel.
ImmutableIdModel.Builder	codecName(String codecName) Initializes the value for the codecName attribute.
ImmutableIdModel.Builder	conversion(ch.rasc.bsoncodec.annotation.Id.IdConversion conversion) Initializes the value for the conversion attribute.
ImmutableIdModel.Builder	from(IdModel instance) Fill a builder with attribute values from the provided IdModel instance.
ImmutableIdModel.Builder	generatorName(String generatorName) Initializes the value for the generatorName attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableIdModel.Builder from(IdModel instance)

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

generatorName

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

Initializes the value for the generatorName attribute.

Parameters:

generatorName - The value for generatorName (can be null)

Returns:

this builder for use in a chained invocation

conversion

@CanIgnoreReturnValue
public final ImmutableIdModel.Builder conversion(@Nullable
                                                                       ch.rasc.bsoncodec.annotation.Id.IdConversion conversion)

Initializes the value for the conversion attribute.

Parameters:

conversion - The value for conversion (can be null)

Returns:

this builder for use in a chained invocation

codecName

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

Initializes the value for the codecName attribute.

Parameters:

codecName - The value for codecName (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableIdModel build()

Builds a new ImmutableIdModel.

Returns:

An immutable instance of IdModel

Throws:

IllegalStateException - if any required attributes are missing