de.flapdoodle.os.common.types

Class ImmutableEither.Builder<L,R>

java.lang.Object

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

Enclosing class:

ImmutableEither<L,R>

public static final class ImmutableEither.Builder<L,R>
extends Object

Builds instances of type ImmutableEither. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
ImmutableEither<L,R>	build() Builds a new ImmutableEither.
ImmutableEither.Builder<L,R>	from(Either<L,R> instance) Fill a builder with attribute values from the provided Either instance.
ImmutableEither.Builder<L,R>	optLeft(L optLeft) Initializes the optional value optLeft to optLeft.
ImmutableEither.Builder<L,R>	optLeft(Optional<? extends L> optLeft) Initializes the optional value optLeft to optLeft.
ImmutableEither.Builder<L,R>	optRight(Optional<? extends R> optRight) Initializes the optional value optRight to optRight.
ImmutableEither.Builder<L,R>	optRight(R optRight) Initializes the optional value optRight to optRight.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final ImmutableEither.Builder<L,R> from(Either<L,R> instance)

Fill a builder with attribute values from the provided Either instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

optLeft

public final ImmutableEither.Builder<L,R> optLeft(L optLeft)

Initializes the optional value optLeft to optLeft.

Parameters:

optLeft - The value for optLeft

Returns:

this builder for chained invocation

optLeft

public final ImmutableEither.Builder<L,R> optLeft(Optional<? extends L> optLeft)

Initializes the optional value optLeft to optLeft.

Parameters:

optLeft - The value for optLeft

Returns:

this builder for use in a chained invocation

optRight

public final ImmutableEither.Builder<L,R> optRight(R optRight)

Initializes the optional value optRight to optRight.

Parameters:

optRight - The value for optRight

Returns:

this builder for chained invocation

optRight

public final ImmutableEither.Builder<L,R> optRight(Optional<? extends R> optRight)

Initializes the optional value optRight to optRight.

Parameters:

optRight - The value for optRight

Returns:

this builder for use in a chained invocation

build

public ImmutableEither<L,R> build()

Builds a new ImmutableEither.

Returns:

An immutable instance of Either

Throws:

IllegalStateException - if any required attributes are missing