org.nuiton.db.meta

Class ImmutableColumnRef

java.lang.Object

org.nuiton.db.meta.ImmutableColumnRef

All Implemented Interfaces:

ColumnRef

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableColumnRef
extends Object
implements ColumnRef

Immutable implementation of ColumnRef.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableColumnRef.Builder	builder() Creates a builder for ImmutableColumnRef.
static ImmutableColumnRef	copyOf(ColumnRef instance) Creates an immutable copy of a ColumnRef value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableColumnRef that have equal attribute values.
Optional<String>	getColumn()
String	getTable()
int	hashCode() Computes a hash code from attributes: table, column.
String	toString() Prints the immutable value ColumnRef with attribute values.
ImmutableColumnRef	withColumn(Optional<String> optional) Copy the current immutable object by setting an optional value for the column attribute.
ImmutableColumnRef	withColumn(String value) Copy the current immutable object by setting a present value for the optional column attribute.
ImmutableColumnRef	withTable(String value) Copy the current immutable object by setting a value for the table attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuiton.db.meta.ColumnRef

forColumn, forTable, pretty

Method Detail

getTable

public String getTable()

Specified by:

getTable in interface ColumnRef

Returns:

The value of the table attribute

getColumn

public Optional<String> getColumn()

Specified by:

getColumn in interface ColumnRef

Returns:

The value of the column attribute

withTable

public final ImmutableColumnRef withTable(String value)

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

Parameters:

value - A new value for table

Returns:

A modified copy of the this object

withColumn

public final ImmutableColumnRef withColumn(String value)

Copy the current immutable object by setting a present value for the optional column attribute.

Parameters:

value - The value for column

Returns:

A modified copy of this object

withColumn

public final ImmutableColumnRef withColumn(Optional<String> optional)

Copy the current immutable object by setting an optional value for the column attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for column

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableColumnRef 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: table, column.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ColumnRef with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableColumnRef copyOf(ColumnRef instance)

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

builder

public static ImmutableColumnRef.Builder builder()

Creates a builder for ImmutableColumnRef.

 ImmutableColumnRef.builder()
    .table(String) // required table
    .column(String) // optional column
    .build();
 

Returns:

A new ImmutableColumnRef builder