ImmutableFieldModel (APT BSON Codec Generator 1.0.0 API)

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

All Implemented Interfaces:: Comparable<FieldModel>

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","FieldModel"})
 @Immutable
public final class ImmutableFieldModel
extends FieldModel

Immutable implementation of FieldModel.

Use builder to create immutable instances: ImmutableFieldModel.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableFieldModel.Builder
Builds instances of ImmutableFieldModel.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableFieldModel.Builder` Builds instances of `ImmutableFieldModel`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableFieldModel.Builder`	`builder()` Creates builder for `ImmutableFieldModel`.
`CodeGen`	`codeGen()`
`static ImmutableFieldModel`	`copyOf(FieldModel instance)` Creates immutable copy of `FieldModel`.
`String`	`customCodecName()`
`boolean`	`disableDecodeNullCheck()`
`boolean`	`disableEncodeNullCheck()`
`boolean`	`disableSetNullStatement()`
`boolean`	`equals(Object another)` This instance is equal to instances of `ImmutableFieldModel` with equal attribute values.
`int`	`hashCode()` Computes hash code from attributes: `varEl`, `name`, `order`, `customCodecName`, `codeGen`, `storeNullValue`, `storeEmptyCollection`, `disableEncodeNullCheck`, `disableDecodeNullCheck`, `disableSetNullStatement`, `idModel`, `methodNameSet`, `methodNameGet`.
`IdModel`	`idModel()`
`String`	`methodNameGet()`
`String`	`methodNameSet()`
`String`	`name()`
`int`	`order()`
`boolean`	`storeEmptyCollection()`
`boolean`	`storeNullValue()`
`String`	`toString()` Prints immutable value `FieldModel...` with attribute values, excluding any non-generated and auxiliary attributes.
`VariableElement`	`varEl()`
`ImmutableFieldModel`	`withCodeGen(CodeGen value)` Copy current immutable object by setting value for `codeGen`.
`ImmutableFieldModel`	`withCustomCodecName(String value)` Copy current immutable object by setting value for `customCodecName`.
`ImmutableFieldModel`	`withDisableDecodeNullCheck(boolean value)` Copy current immutable object by setting value for `disableDecodeNullCheck`.
`ImmutableFieldModel`	`withDisableEncodeNullCheck(boolean value)` Copy current immutable object by setting value for `disableEncodeNullCheck`.
`ImmutableFieldModel`	`withDisableSetNullStatement(boolean value)` Copy current immutable object by setting value for `disableSetNullStatement`.
`ImmutableFieldModel`	`withIdModel(IdModel value)` Copy current immutable object by setting value for `idModel`.
`ImmutableFieldModel`	`withMethodNameGet(String value)` Copy current immutable object by setting value for `methodNameGet`.
`ImmutableFieldModel`	`withMethodNameSet(String value)` Copy current immutable object by setting value for `methodNameSet`.
`ImmutableFieldModel`	`withName(String value)` Copy current immutable object by setting value for `name`.
`ImmutableFieldModel`	`withOrder(int value)` Copy current immutable object by setting value for `order`.
`ImmutableFieldModel`	`withStoreEmptyCollection(boolean value)` Copy current immutable object by setting value for `storeEmptyCollection`.
`ImmutableFieldModel`	`withStoreNullValue(boolean value)` Copy current immutable object by setting value for `storeNullValue`.
`ImmutableFieldModel`	`withVarEl(VariableElement value)` Copy current immutable object by setting value for `varEl`.

Methods inherited from class ch.rasc.bsoncodec.model.FieldModel
compareTo

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

- Method Detail
  - varEl
```
public VariableElement varEl()
```
    Specified by:
    
    varEl in class FieldModel
    
    Returns:
    
    value of varEl attribute
  - name
```
public String name()
```
    Overrides:
    
    name in class FieldModel
    
    Returns:
    
    value of name attribute
  - order
```
public int order()
```
    Specified by:
    
    order in class FieldModel
    
    Returns:
    
    value of order attribute
  - customCodecName
```
@Nullable
public String customCodecName()
```
    Specified by:
    
    customCodecName in class FieldModel
    
    Returns:
    
    value of customCodecName attribute
  - codeGen
```
public CodeGen codeGen()
```
    Specified by:
    
    codeGen in class FieldModel
    
    Returns:
    
    value of codeGen attribute
  - storeNullValue
```
public boolean storeNullValue()
```
    Overrides:
    
    storeNullValue in class FieldModel
    
    Returns:
    
    value of storeNullValue attribute
  - storeEmptyCollection
```
public boolean storeEmptyCollection()
```
    Overrides:
    
    storeEmptyCollection in class FieldModel
    
    Returns:
    
    value of storeEmptyCollection attribute
  - disableEncodeNullCheck
```
public boolean disableEncodeNullCheck()
```
    Overrides:
    
    disableEncodeNullCheck in class FieldModel
    
    Returns:
    
    value of disableEncodeNullCheck attribute
  - disableDecodeNullCheck
```
public boolean disableDecodeNullCheck()
```
    Overrides:
    
    disableDecodeNullCheck in class FieldModel
    
    Returns:
    
    value of disableDecodeNullCheck attribute
  - disableSetNullStatement
```
public boolean disableSetNullStatement()
```
    Overrides:
    
    disableSetNullStatement in class FieldModel
    
    Returns:
    
    value of disableSetNullStatement attribute
  - idModel
```
@Nullable
public IdModel idModel()
```
    Specified by:
    
    idModel in class FieldModel
    
    Returns:
    
    value of idModel attribute
  - methodNameSet
```
public String methodNameSet()
```
    Specified by:
    
    methodNameSet in class FieldModel
    
    Returns:
    
    value of methodNameSet attribute
  - methodNameGet
```
public String methodNameGet()
```
    Specified by:
    
    methodNameGet in class FieldModel
    
    Returns:
    
    value of methodNameGet attribute
  - withVarEl
```
public final ImmutableFieldModel withVarEl(VariableElement value)
```
    Copy current immutable object by setting value for varEl. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for varEl
    
    Returns:
    
    modified copy of the this object
  - withName
```
public final ImmutableFieldModel withName(String value)
```
    Copy current immutable object by setting value for name. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for name
    
    Returns:
    
    modified copy of the this object
  - withOrder
```
public final ImmutableFieldModel withOrder(int value)
```
    Copy current immutable object by setting value for order. Value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for order
    
    Returns:
    
    modified copy of the this object
  - withCustomCodecName
```
public final ImmutableFieldModel withCustomCodecName(@Nullable
                                                     String value)
```
    Copy current immutable object by setting value for customCodecName. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for customCodecName, can be null
    
    Returns:
    
    modified copy of the this object
  - withCodeGen
```
public final ImmutableFieldModel withCodeGen(CodeGen value)
```
    Copy current immutable object by setting value for codeGen. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for codeGen
    
    Returns:
    
    modified copy of the this object
  - withStoreNullValue
```
public final ImmutableFieldModel withStoreNullValue(boolean value)
```
    Copy current immutable object by setting value for storeNullValue. Value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for storeNullValue
    
    Returns:
    
    modified copy of the this object
  - withStoreEmptyCollection
```
public final ImmutableFieldModel withStoreEmptyCollection(boolean value)
```
    Copy current immutable object by setting value for storeEmptyCollection. Value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for storeEmptyCollection
    
    Returns:
    
    modified copy of the this object
  - withDisableEncodeNullCheck
```
public final ImmutableFieldModel withDisableEncodeNullCheck(boolean value)
```
    Copy current immutable object by setting value for disableEncodeNullCheck. Value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for disableEncodeNullCheck
    
    Returns:
    
    modified copy of the this object
  - withDisableDecodeNullCheck
```
public final ImmutableFieldModel withDisableDecodeNullCheck(boolean value)
```
    Copy current immutable object by setting value for disableDecodeNullCheck. Value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for disableDecodeNullCheck
    
    Returns:
    
    modified copy of the this object
  - withDisableSetNullStatement
```
public final ImmutableFieldModel withDisableSetNullStatement(boolean value)
```
    Copy current immutable object by setting value for disableSetNullStatement. Value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for disableSetNullStatement
    
    Returns:
    
    modified copy of the this object
  - withIdModel
```
public final ImmutableFieldModel withIdModel(@Nullable
                                             IdModel value)
```
    Copy current immutable object by setting value for idModel. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for idModel, can be null
    
    Returns:
    
    modified copy of the this object
  - withMethodNameSet
```
public final ImmutableFieldModel withMethodNameSet(String value)
```
    Copy current immutable object by setting value for methodNameSet. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for methodNameSet
    
    Returns:
    
    modified copy of the this object
  - withMethodNameGet
```
public final ImmutableFieldModel withMethodNameGet(String value)
```
    Copy current immutable object by setting value for methodNameGet. Shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - new value for methodNameGet
    
    Returns:
    
    modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to instances of ImmutableFieldModel with equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes hash code from attributes: varEl, name, order, customCodecName, codeGen, storeNullValue, storeEmptyCollection, disableEncodeNullCheck, disableDecodeNullCheck, disableSetNullStatement, idModel, methodNameSet, methodNameGet.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints immutable value FieldModel... with attribute values, excluding any non-generated and auxiliary attributes.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of value
  - copyOf
```
public static ImmutableFieldModel copyOf(FieldModel instance)
```
    Creates immutable copy of FieldModel. Uses accessors to get values to initialize immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - instance to copy
    
    Returns:
    
    copied immutable FieldModel instance
  - builder
```
public static ImmutableFieldModel.Builder builder()
```
    Creates builder for ImmutableFieldModel.
    
    Returns:
    
    new ImmutableFieldModel builder

Class ImmutableFieldModel

Nested Class Summary

Method Summary

Methods inherited from class ch.rasc.bsoncodec.model.FieldModel

Methods inherited from class java.lang.Object

Method Detail

varEl

name

order

customCodecName

codeGen

storeNullValue

storeEmptyCollection

disableEncodeNullCheck

disableDecodeNullCheck

disableSetNullStatement

idModel

methodNameSet

methodNameGet

withVarEl

withName

withOrder

withCustomCodecName

withCodeGen

withStoreNullValue

withStoreEmptyCollection

withDisableEncodeNullCheck

withDisableDecodeNullCheck

withDisableSetNullStatement

withIdModel

withMethodNameSet

withMethodNameGet

equals

hashCode

toString

copyOf

builder