de.flapdoodle.types

Class ImmutablePair<FIRST,SECOND>

java.lang.Object

de.flapdoodle.types.Pair<FIRST,SECOND>

de.flapdoodle.types.ImmutablePair<FIRST,SECOND>

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutablePair<FIRST,SECOND>
extends Pair<FIRST,SECOND>

Immutable implementation of Pair.

Use the builder to create immutable instances: ImmutablePair.builder(). Use the static factory method to create immutable instances: ImmutablePair.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutablePair.Builder<FIRST,SECOND> Builds instances of type ImmutablePair.

Method Summary

Modifier and Type	Method and Description
static <FIRST,SECOND> ImmutablePair.Builder<FIRST,SECOND>	builder() Creates a builder for ImmutablePair.
static <FIRST,SECOND> ImmutablePair<FIRST,SECOND>	copyOf(Pair<FIRST,SECOND> instance) Creates an immutable copy of a Pair value.
boolean	equals(Object another) This instance is equal to all instances of ImmutablePair that have equal attribute values.
FIRST	first()
int	hashCode() Computes a hash code from attributes: first, second.
static <FIRST,SECOND> ImmutablePair<FIRST,SECOND>	of(FIRST first, SECOND second) Construct a new immutable Pair instance.
SECOND	second()
String	toString() Prints the immutable value Pair with attribute values.
ImmutablePair<FIRST,SECOND>	withFirst(FIRST value) Copy the current immutable object by setting a value for the first attribute.
ImmutablePair<FIRST,SECOND>	withSecond(SECOND value) Copy the current immutable object by setting a value for the second attribute.

Methods inherited from class de.flapdoodle.types.Pair

map, mapFirst, mapSecond

Methods inherited from class java.lang.Object

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

Method Detail

first

public FIRST first()

Specified by:

first in class Pair<FIRST,SECOND>

Returns:

The value of the first attribute

second

public SECOND second()

Specified by:

second in class Pair<FIRST,SECOND>

Returns:

The value of the second attribute

withFirst

public final ImmutablePair<FIRST,SECOND> withFirst(FIRST value)

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

Parameters:

value - A new value for first

Returns:

A modified copy of the this object

withSecond

public final ImmutablePair<FIRST,SECOND> withSecond(SECOND value)

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

Parameters:

value - A new value for second

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutablePair 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: first, second.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Pair with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <FIRST,SECOND> ImmutablePair<FIRST,SECOND> of(FIRST first,
                                                            SECOND second)

Construct a new immutable Pair instance.

Type Parameters:

FIRST - generic parameter FIRST

SECOND - generic parameter SECOND

Parameters:

first - The value for the first attribute

second - The value for the second attribute

Returns:

An immutable Pair instance

copyOf

public static <FIRST,SECOND> ImmutablePair<FIRST,SECOND> copyOf(Pair<FIRST,SECOND> instance)

Creates an immutable copy of a Pair value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

FIRST - generic parameter FIRST

SECOND - generic parameter SECOND

Parameters:

instance - The instance to copy

Returns:

A copied immutable Pair instance

builder

public static <FIRST,SECOND> ImmutablePair.Builder<FIRST,SECOND> builder()

Creates a builder for ImmutablePair.

 ImmutablePair.<FIRST, SECOND>builder()
    .first(FIRST) // required first
    .second(SECOND) // required second
    .build();
 

Type Parameters:

FIRST - generic parameter FIRST

SECOND - generic parameter SECOND

Returns:

A new ImmutablePair builder