com.io7m.jregions.core.unparameterized.areas

Class AreaI.Builder

java.lang.Object

com.io7m.jregions.core.unparameterized.areas.AreaI.Builder

Enclosing class:

AreaI

public static final class AreaI.Builder
extends Object

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

Fill a builder with attribute values from the provided AreaIType 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 AreaI.Builder 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 AreaI.Builder 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 AreaI.Builder 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 AreaI.Builder 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 AreaI build()

Builds a new AreaI.

Returns:

An immutable instance of AreaI

Throws:

IllegalStateException - if any required attributes are missing