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
 @CheckReturnValue
public final class ImmutableIdModel
extends IdModel

Immutable implementation of IdModel.

Use the 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 type ImmutableIdModel.

Method Summary

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

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:

The value of the generatorName attribute

conversion

@Nullable
public Id.IdConversion conversion()

Specified by:

conversion in class IdModel

Returns:

The value of the conversion attribute

codecName

@Nullable
public String codecName()

Specified by:

codecName in class IdModel

Returns:

The value of the codecName attribute

withGeneratorName

public final ImmutableIdModel withGeneratorName(@Nullable
                                                String value)

Copy the current immutable object by setting a value for the generatorName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for generatorName (can be null)

Returns:

A modified copy of the this object

withConversion

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

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

Parameters:

value - A new value for conversion (can be null)

Returns:

A modified copy of the this object

withCodecName

public final ImmutableIdModel withCodecName(@Nullable
                                            String value)

Copy the current immutable object by setting a value for the codecName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for codecName (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value IdModel with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableIdModel copyOf(IdModel instance)

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

builder

public static ImmutableIdModel.Builder builder()

Creates a builder for ImmutableIdModel.

Returns:

A new ImmutableIdModel builder