ch.rasc.bsoncodec.model

Class ImmutableInstanceField

java.lang.Object

ch.rasc.bsoncodec.model.InstanceField

ch.rasc.bsoncodec.model.ImmutableInstanceField

All Implemented Interfaces:

Comparable<InstanceField>

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

Immutable implementation of InstanceField.

Use the builder to create immutable instances: ImmutableInstanceField.builder().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableInstanceField.Builder	builder() Creates a builder for ImmutableInstanceField.
com.squareup.javapoet.TypeName	codecForClass()
static ImmutableInstanceField	copyOf(InstanceField instance) Creates an immutable copy of a InstanceField value.
boolean	customCodec()
boolean	equals(Object another) This instance is equal to all instances of ImmutableInstanceField that have equal attribute values.
int	hashCode() Computes a hash code from attributes: type, name, codecForClass, customCodec.
String	name()
String	toString() Prints the immutable value InstanceField with attribute values.
com.squareup.javapoet.TypeName	type()
ImmutableInstanceField	withCodecForClass(com.squareup.javapoet.TypeName codecForClass) Copy the current immutable object by setting a value for the codecForClass attribute.
ImmutableInstanceField	withCustomCodec(boolean customCodec) Copy the current immutable object by setting a value for the customCodec attribute.
ImmutableInstanceField	withName(String name) Copy the current immutable object by setting a value for the name attribute.
ImmutableInstanceField	withType(com.squareup.javapoet.TypeName type) Copy the current immutable object by setting a value for the type attribute.

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

compareTo, isRegistry, isRegistryCodec

Methods inherited from class java.lang.Object

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

Method Detail

type

public com.squareup.javapoet.TypeName type()

Specified by:

type in class InstanceField

Returns:

The value of the type attribute

name

public String name()

Specified by:

name in class InstanceField

Returns:

The value of the name attribute

codecForClass

@Nullable
public com.squareup.javapoet.TypeName codecForClass()

Specified by:

codecForClass in class InstanceField

Returns:

The value of the codecForClass attribute

customCodec

public boolean customCodec()

Overrides:

customCodec in class InstanceField

Returns:

The value of the customCodec attribute

withType

public final ImmutableInstanceField withType(com.squareup.javapoet.TypeName type)

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

Parameters:

type - A new value for type

Returns:

A modified copy of the this object

withName

public final ImmutableInstanceField withName(String name)

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:

name - A new value for name

Returns:

A modified copy of the this object

withCodecForClass

public final ImmutableInstanceField withCodecForClass(@Nullable
                                                      com.squareup.javapoet.TypeName codecForClass)

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

Parameters:

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

Returns:

A modified copy of the this object

withCustomCodec

public final ImmutableInstanceField withCustomCodec(boolean customCodec)

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

Parameters:

customCodec - A new value for customCodec

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableInstanceField 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: type, name, codecForClass, customCodec.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value InstanceField with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableInstanceField copyOf(InstanceField instance)

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

builder

public static ImmutableInstanceField.Builder builder()

Creates a builder for ImmutableInstanceField.

Returns:

A new ImmutableInstanceField builder