de.flapdoodle.os.common.types

Class ImmutableEither<L,R>

java.lang.Object

de.flapdoodle.os.common.types.Either<L,R>

de.flapdoodle.os.common.types.ImmutableEither<L,R>

public final class ImmutableEither<L,R>
extends Either<L,R>

Immutable implementation of Either.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableEither.Builder<L,R> Builds instances of type ImmutableEither.

Method Summary

Modifier and Type	Method and Description
static <L,R> ImmutableEither.Builder<L,R>	builder() Creates a builder for ImmutableEither.
static <L,R> ImmutableEither<L,R>	copyOf(Either<L,R> instance) Creates an immutable copy of a Either value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableEither that have equal attribute values.
int	hashCode() Computes a hash code from attributes: optLeft, optRight.
protected Optional<L>	optLeft()
protected Optional<R>	optRight()
String	toString() Prints the immutable value Either with attribute values.
ImmutableEither<L,R>	withOptLeft(L value) Copy the current immutable object by setting a present value for the optional optLeft attribute.
ImmutableEither<L,R>	withOptLeft(Optional<? extends L> optional) Copy the current immutable object by setting an optional value for the optLeft attribute.
ImmutableEither<L,R>	withOptRight(Optional<? extends R> optional) Copy the current immutable object by setting an optional value for the optRight attribute.
ImmutableEither<L,R>	withOptRight(R value) Copy the current immutable object by setting a present value for the optional optRight attribute.

Methods inherited from class de.flapdoodle.os.common.types.Either

check, isLeft, left, left, right, right

Methods inherited from class java.lang.Object

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

Method Detail

optLeft

protected Optional<L> optLeft()

Specified by:

optLeft in class Either<L,R>

Returns:

The value of the optLeft attribute

optRight

protected Optional<R> optRight()

Specified by:

optRight in class Either<L,R>

Returns:

The value of the optRight attribute

withOptLeft

public final ImmutableEither<L,R> withOptLeft(L value)

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

Parameters:

value - The value for optLeft

Returns:

A modified copy of this object

withOptLeft

public final ImmutableEither<L,R> withOptLeft(Optional<? extends L> optional)

Copy the current immutable object by setting an optional value for the optLeft attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - A value for optLeft

Returns:

A modified copy of this object

withOptRight

public final ImmutableEither<L,R> withOptRight(R value)

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

Parameters:

value - The value for optRight

Returns:

A modified copy of this object

withOptRight

public final ImmutableEither<L,R> withOptRight(Optional<? extends R> optional)

Copy the current immutable object by setting an optional value for the optRight attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - A value for optRight

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableEither 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: optLeft, optRight.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Either with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static <L,R> ImmutableEither<L,R> copyOf(Either<L,R> instance)

Creates an immutable copy of a Either 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:

L - generic parameter L

R - generic parameter R

Parameters:

instance - The instance to copy

Returns:

A copied immutable Either instance

builder

public static <L,R> ImmutableEither.Builder<L,R> builder()

Creates a builder for ImmutableEither.

 ImmutableEither.<L, R>builder()
    .optLeft(L) // optional optLeft
    .optRight(R) // optional optRight
    .build();
 

Type Parameters:

L - generic parameter L

R - generic parameter R

Returns:

A new ImmutableEither builder