de.flapdoodle.types

Class ImmutablePair.Builder<FIRST,SECOND>

java.lang.Object

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

Enclosing class:

ImmutablePair<FIRST,SECOND>

public static final class ImmutablePair.Builder<FIRST,SECOND>
extends Object

Builds instances of type ImmutablePair. 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
ImmutablePair<FIRST,SECOND>	build() Builds a new ImmutablePair.
ImmutablePair.Builder<FIRST,SECOND>	first(FIRST first) Initializes the value for the first attribute.
ImmutablePair.Builder<FIRST,SECOND>	from(Pair<FIRST,SECOND> instance) Fill a builder with attribute values from the provided Pair instance.
ImmutablePair.Builder<FIRST,SECOND>	second(SECOND second) Initializes the value for the second attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutablePair.Builder<FIRST,SECOND> from(Pair<FIRST,SECOND> instance)

Fill a builder with attribute values from the provided Pair 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

first

public final ImmutablePair.Builder<FIRST,SECOND> first(FIRST first)

Initializes the value for the first attribute.

Parameters:

first - The value for first

Returns:

this builder for use in a chained invocation

second

public final ImmutablePair.Builder<FIRST,SECOND> second(SECOND second)

Initializes the value for the second attribute.

Parameters:

second - The value for second

Returns:

this builder for use in a chained invocation

build

public ImmutablePair<FIRST,SECOND> build()

Builds a new ImmutablePair.

Returns:

An immutable instance of Pair

Throws:

IllegalStateException - if any required attributes are missing