ch.rasc.bsoncodec.model

Class ImmutableIdModel

java.lang.Object

ch.rasc.bsoncodec.model.IdModel

ch.rasc.bsoncodec.model.ImmutableIdModel

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

Immutable implementation of IdModel.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableIdModel.Builder Builds instances of ImmutableIdModel.

Method Summary

Modifier and Type	Method and Description
static ImmutableIdModel.Builder	builder() Creates builder for ImmutableIdModel.
String	codecName()
Id.IdConversion	conversion()
static ImmutableIdModel	copyOf(IdModel instance) Creates immutable copy of IdModel.
boolean	equals(Object another) This instance is equal to instances of ImmutableIdModel with equal attribute values.
String	generatorName()
int	hashCode() Computes hash code from attributes: generatorName, conversion, codecName.
String	toString() Prints immutable value IdModel... with attribute values, excluding any non-generated and auxiliary attributes.
ImmutableIdModel	withCodecName(String value) Copy current immutable object by setting value for codecName.
ImmutableIdModel	withConversion(Id.IdConversion value) Copy current immutable object by setting value for conversion.
ImmutableIdModel	withGeneratorName(String value) Copy current immutable object by setting value for generatorName.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

generatorName

@Nullable
public String generatorName()

Specified by:

generatorName in class IdModel

Returns:

value of generatorName attribute

conversion

@Nullable
public Id.IdConversion conversion()

Specified by:

conversion in class IdModel

Returns:

value of conversion attribute

codecName

@Nullable
public String codecName()

Specified by:

codecName in class IdModel

Returns:

value of codecName attribute

withGeneratorName

public final ImmutableIdModel withGeneratorName(@Nullable
                                                String value)

Copy current immutable object by setting value for generatorName. Shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - new value for generatorName, can be null

Returns:

modified copy of the this object

withConversion

public final ImmutableIdModel withConversion(@Nullable
                                             Id.IdConversion value)

Copy current immutable object by setting value for conversion. Shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - new value for conversion, can be null

Returns:

modified copy of the this object

withCodecName

public final ImmutableIdModel withCodecName(@Nullable
                                            String value)

Copy current immutable object by setting value for codecName. Shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - new value for codecName, can be null

Returns:

modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to instances of ImmutableIdModel 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: generatorName, conversion, codecName.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints immutable value IdModel... with attribute values, excluding any non-generated and auxiliary attributes.

Overrides:

toString in class Object

Returns:

string representation of value

copyOf

public static ImmutableIdModel copyOf(IdModel instance)

Creates immutable copy of IdModel. 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 IdModel instance

builder

public static ImmutableIdModel.Builder builder()

Creates builder for ImmutableIdModel.

Returns:

new ImmutableIdModel builder