com.io7m.jboxes.core

Class Box.Builder<S>

java.lang.Object

com.io7m.jboxes.core.Box.Builder<S>

Enclosing class:

Box<S>

public static final class Box.Builder<S>
extends Object

Builds instances of type Box. 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
Box<S>	build() Builds a new Box.
Box.Builder<S>	from(BoxType<S> instance) Fill a builder with attribute values from the provided BoxType instance.
Box.Builder<S>	setMaximumX(int maximumX) Initializes the value for the maximumX attribute.
Box.Builder<S>	setMaximumY(int maximumY) Initializes the value for the maximumY attribute.
Box.Builder<S>	setMinimumX(int minimumX) Initializes the value for the minimumX attribute.
Box.Builder<S>	setMinimumY(int minimumY) Initializes the value for the minimumY attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Box.Builder<S> from(BoxType<S> instance)

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

setMinimumX

public final Box.Builder<S> setMinimumX(int minimumX)

Initializes the value for the minimumX attribute.

Parameters:

minimumX - The value for minimumX

Returns:

this builder for use in a chained invocation

setMaximumX

public final Box.Builder<S> setMaximumX(int maximumX)

Initializes the value for the maximumX attribute.

Parameters:

maximumX - The value for maximumX

Returns:

this builder for use in a chained invocation

setMinimumY

public final Box.Builder<S> setMinimumY(int minimumY)

Initializes the value for the minimumY attribute.

Parameters:

minimumY - The value for minimumY

Returns:

this builder for use in a chained invocation

setMaximumY

public final Box.Builder<S> setMaximumY(int maximumY)

Initializes the value for the maximumY attribute.

Parameters:

maximumY - The value for maximumY

Returns:

this builder for use in a chained invocation

build

public Box<S> build()

Builds a new Box.

Returns:

An immutable instance of Box

Throws:

IllegalStateException - if any required attributes are missing