ImmutableFieldModel.Builder (APT BSON Codec Generator 1.0.0 API)

java.lang.Object
- ch.rasc.bsoncodec.model.ImmutableFieldModel.Builder

Enclosing class:

ImmutableFieldModel
```
@NotThreadSafe
public static final class ImmutableFieldModel.Builder
extends Object
```
Builds instances of ImmutableFieldModel. 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImmutableFieldModel`	`build()` Builds new `ImmutableFieldModel`.
`ImmutableFieldModel.Builder`	`codeGen(CodeGen codeGen)` Initializes value for `codeGen`.
`ImmutableFieldModel.Builder`	`customCodecName(String customCodecName)` Initializes value for `customCodecName`.
`ImmutableFieldModel.Builder`	`disableDecodeNullCheck(boolean disableDecodeNullCheck)` Initializes value for `disableDecodeNullCheck`.
`ImmutableFieldModel.Builder`	`disableEncodeNullCheck(boolean disableEncodeNullCheck)` Initializes value for `disableEncodeNullCheck`.
`ImmutableFieldModel.Builder`	`disableSetNullStatement(boolean disableSetNullStatement)` Initializes value for `disableSetNullStatement`.
`ImmutableFieldModel.Builder`	`from(FieldModel instance)` Fill builder with attribute values from provided `FieldModel` instance.
`ImmutableFieldModel.Builder`	`idModel(IdModel idModel)` Initializes value for `idModel`.
`ImmutableFieldModel.Builder`	`methodNameGet(String methodNameGet)` Initializes value for `methodNameGet`.
`ImmutableFieldModel.Builder`	`methodNameSet(String methodNameSet)` Initializes value for `methodNameSet`.
`ImmutableFieldModel.Builder`	`name(String name)` Initializes value for `name`.
`ImmutableFieldModel.Builder`	`order(int order)` Initializes value for `order`.
`ImmutableFieldModel.Builder`	`storeEmptyCollection(boolean storeEmptyCollection)` Initializes value for `storeEmptyCollection`.
`ImmutableFieldModel.Builder`	`storeNullValue(boolean storeNullValue)` Initializes value for `storeNullValue`.
`ImmutableFieldModel.Builder`	`varEl(VariableElement varEl)` Initializes value for `varEl`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - from
```
public final ImmutableFieldModel.Builder from(FieldModel instance)
```
    Fill builder with attribute values from provided FieldModel 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
  - varEl
```
public final ImmutableFieldModel.Builder varEl(VariableElement varEl)
```
    Initializes value for varEl.
    
    Parameters:
    
    varEl - value for varEl
    
    Returns:
    
    this builder for chained invocation
  - name
```
public final ImmutableFieldModel.Builder name(String name)
```
    Initializes value for name.
    If not set, this attribute will have default value returned by initializer of name.
    
    Parameters:
    
    name - value for name
    
    Returns:
    
    this builder for chained invocation
  - order
```
public final ImmutableFieldModel.Builder order(int order)
```
    Initializes value for order.
    
    Parameters:
    
    order - value for order
    
    Returns:
    
    this builder for chained invocation
  - customCodecName
```
public final ImmutableFieldModel.Builder customCodecName(@Nullable
                                                         String customCodecName)
```
    Initializes value for customCodecName.
    
    Parameters:
    
    customCodecName - value for customCodecName, can be null
    
    Returns:
    
    this builder for chained invocation
  - codeGen
```
public final ImmutableFieldModel.Builder codeGen(CodeGen codeGen)
```
    Initializes value for codeGen.
    
    Parameters:
    
    codeGen - value for codeGen
    
    Returns:
    
    this builder for chained invocation
  - storeNullValue
```
public final ImmutableFieldModel.Builder storeNullValue(boolean storeNullValue)
```
    Initializes value for storeNullValue.
    If not set, this attribute will have default value returned by initializer of storeNullValue.
    
    Parameters:
    
    storeNullValue - value for storeNullValue
    
    Returns:
    
    this builder for chained invocation
  - storeEmptyCollection
```
public final ImmutableFieldModel.Builder storeEmptyCollection(boolean storeEmptyCollection)
```
    Initializes value for storeEmptyCollection.
    If not set, this attribute will have default value returned by initializer of storeEmptyCollection.
    
    Parameters:
    
    storeEmptyCollection - value for storeEmptyCollection
    
    Returns:
    
    this builder for chained invocation
  - disableEncodeNullCheck
```
public final ImmutableFieldModel.Builder disableEncodeNullCheck(boolean disableEncodeNullCheck)
```
    Initializes value for disableEncodeNullCheck.
    If not set, this attribute will have default value returned by initializer of disableEncodeNullCheck.
    
    Parameters:
    
    disableEncodeNullCheck - value for disableEncodeNullCheck
    
    Returns:
    
    this builder for chained invocation
  - disableDecodeNullCheck
```
public final ImmutableFieldModel.Builder disableDecodeNullCheck(boolean disableDecodeNullCheck)
```
    Initializes value for disableDecodeNullCheck.
    If not set, this attribute will have default value returned by initializer of disableDecodeNullCheck.
    
    Parameters:
    
    disableDecodeNullCheck - value for disableDecodeNullCheck
    
    Returns:
    
    this builder for chained invocation
  - disableSetNullStatement
```
public final ImmutableFieldModel.Builder disableSetNullStatement(boolean disableSetNullStatement)
```
    Initializes value for disableSetNullStatement.
    If not set, this attribute will have default value returned by initializer of disableSetNullStatement.
    
    Parameters:
    
    disableSetNullStatement - value for disableSetNullStatement
    
    Returns:
    
    this builder for chained invocation
  - idModel
```
public final ImmutableFieldModel.Builder idModel(@Nullable
                                                 IdModel idModel)
```
    Initializes value for idModel.
    
    Parameters:
    
    idModel - value for idModel, can be null
    
    Returns:
    
    this builder for chained invocation
  - methodNameSet
```
public final ImmutableFieldModel.Builder methodNameSet(String methodNameSet)
```
    Initializes value for methodNameSet.
    
    Parameters:
    
    methodNameSet - value for methodNameSet
    
    Returns:
    
    this builder for chained invocation
  - methodNameGet
```
public final ImmutableFieldModel.Builder methodNameGet(String methodNameGet)
```
    Initializes value for methodNameGet.
    
    Parameters:
    
    methodNameGet - value for methodNameGet
    
    Returns:
    
    this builder for chained invocation
  - build
```
public ImmutableFieldModel build()
                          throws IllegalStateException
```
    Builds new ImmutableFieldModel.
    
    Returns:
    
    immutable instance of FieldModel
    
    Throws:
    
    exception - java.lang.IllegalStateException if any required attributes are missing
    
    IllegalStateException

Class ImmutableFieldModel.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

from

varEl

name

order

customCodecName

codeGen

storeNullValue

storeEmptyCollection

disableEncodeNullCheck

disableDecodeNullCheck

disableSetNullStatement

idModel

methodNameSet

methodNameGet

build