ch.rasc.bsoncodec.model

Class ImmutableFieldModel.Builder

java.lang.Object

ch.rasc.bsoncodec.model.ImmutableFieldModel.Builder

Enclosing class:

ImmutableFieldModel

@NotThreadSafe
public static final class ImmutableFieldModel.Builder
extends Object

Builds instances of type ImmutableFieldModel. 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
ImmutableFieldModel	build() Builds a new ImmutableFieldModel.
ImmutableFieldModel.Builder	codeGen(CodeGen codeGen) Initializes the value for the codeGen attribute.
ImmutableFieldModel.Builder	customCodecName(String customCodecName) Initializes the value for the customCodecName attribute.
ImmutableFieldModel.Builder	disableDecodeNullCheck(boolean disableDecodeNullCheck) Initializes the value for the disableDecodeNullCheck attribute.
ImmutableFieldModel.Builder	disableEncodeNullCheck(boolean disableEncodeNullCheck) Initializes the value for the disableEncodeNullCheck attribute.
ImmutableFieldModel.Builder	disableSetNullStatement(boolean disableSetNullStatement) Initializes the value for the disableSetNullStatement attribute.
ImmutableFieldModel.Builder	fixedArray(int fixedArray) Initializes the value for the fixedArray attribute.
ImmutableFieldModel.Builder	from(FieldModel instance) Fill a builder with attribute values from the provided FieldModel instance.
ImmutableFieldModel.Builder	idModel(IdModel idModel) Initializes the value for the idModel attribute.
ImmutableFieldModel.Builder	methodNameGet(String methodNameGet) Initializes the value for the methodNameGet attribute.
ImmutableFieldModel.Builder	methodNameSet(String methodNameSet) Initializes the value for the methodNameSet attribute.
ImmutableFieldModel.Builder	name(String name) Initializes the value for the name attribute.
ImmutableFieldModel.Builder	order(int order) Initializes the value for the order attribute.
ImmutableFieldModel.Builder	storeEmptyCollection(boolean storeEmptyCollection) Initializes the value for the storeEmptyCollection attribute.
ImmutableFieldModel.Builder	storeNullValue(boolean storeNullValue) Initializes the value for the storeNullValue attribute.
ImmutableFieldModel.Builder	varEl(VariableElement varEl) Initializes the value for the varEl 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 ImmutableFieldModel.Builder from(FieldModel instance)

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

varEl

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder varEl(VariableElement varEl)

Initializes the value for the varEl attribute.

Parameters:

varEl - The value for varEl

Returns:

this builder for use in a chained invocation

name

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder name(String name)

Initializes the value for the name attribute.

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

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

order

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder order(int order)

Initializes the value for the order attribute.

Parameters:

order - The value for order

Returns:

this builder for use in a chained invocation

customCodecName

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder customCodecName(@Nullable
                                                                               String customCodecName)

Initializes the value for the customCodecName attribute.

Parameters:

customCodecName - The value for customCodecName (can be null)

Returns:

this builder for use in a chained invocation

codeGen

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder codeGen(CodeGen codeGen)

Initializes the value for the codeGen attribute.

Parameters:

codeGen - The value for codeGen

Returns:

this builder for use in a chained invocation

storeNullValue

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder storeNullValue(boolean storeNullValue)

Initializes the value for the storeNullValue attribute.

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

Parameters:

storeNullValue - The value for storeNullValue

Returns:

this builder for use in a chained invocation

storeEmptyCollection

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder storeEmptyCollection(boolean storeEmptyCollection)

Initializes the value for the storeEmptyCollection attribute.

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

Parameters:

storeEmptyCollection - The value for storeEmptyCollection

Returns:

this builder for use in a chained invocation

disableEncodeNullCheck

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder disableEncodeNullCheck(boolean disableEncodeNullCheck)

Initializes the value for the disableEncodeNullCheck attribute.

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

Parameters:

disableEncodeNullCheck - The value for disableEncodeNullCheck

Returns:

this builder for use in a chained invocation

disableDecodeNullCheck

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder disableDecodeNullCheck(boolean disableDecodeNullCheck)

Initializes the value for the disableDecodeNullCheck attribute.

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

Parameters:

disableDecodeNullCheck - The value for disableDecodeNullCheck

Returns:

this builder for use in a chained invocation

disableSetNullStatement

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder disableSetNullStatement(boolean disableSetNullStatement)

Initializes the value for the disableSetNullStatement attribute.

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

Parameters:

disableSetNullStatement - The value for disableSetNullStatement

Returns:

this builder for use in a chained invocation

fixedArray

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder fixedArray(int fixedArray)

Initializes the value for the fixedArray attribute.

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

Parameters:

fixedArray - The value for fixedArray

Returns:

this builder for use in a chained invocation

idModel

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder idModel(@Nullable
                                                                       IdModel idModel)

Initializes the value for the idModel attribute.

Parameters:

idModel - The value for idModel (can be null)

Returns:

this builder for use in a chained invocation

methodNameSet

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder methodNameSet(String methodNameSet)

Initializes the value for the methodNameSet attribute.

Parameters:

methodNameSet - The value for methodNameSet

Returns:

this builder for use in a chained invocation

methodNameGet

@CanIgnoreReturnValue
public final ImmutableFieldModel.Builder methodNameGet(String methodNameGet)

Initializes the value for the methodNameGet attribute.

Parameters:

methodNameGet - The value for methodNameGet

Returns:

this builder for use in a chained invocation

build

public ImmutableFieldModel build()

Builds a new ImmutableFieldModel.

Returns:

An immutable instance of FieldModel

Throws:

IllegalStateException - if any required attributes are missing