ImmutableFieldModel (APT BSON Codec Generator 1.0.3 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 the 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 type ImmutableFieldModel.

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

Method Summary

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

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

fixedArray

idModel

methodNameSet

methodNameGet

withVarEl

withName

withOrder

withCustomCodecName

withCodeGen

withStoreNullValue

withStoreEmptyCollection

withDisableEncodeNullCheck

withDisableDecodeNullCheck

withDisableSetNullStatement

withFixedArray

withIdModel

withMethodNameSet

withMethodNameGet

equals

hashCode

toString

copyOf

builder