Module com.io7m.jregions.core

Package com.io7m.jregions.core.parameterized.areas

Class PAreaBI.Builder<S>

java.lang.Object

com.io7m.jregions.core.parameterized.areas.PAreaBI.Builder<S>

Enclosing class:

PAreaBI<S>

public static final class PAreaBI.Builder<S>
extends java.lang.Object

Builds instances of type PAreaBI. 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	Description
PAreaBI<S>	build()	Builds a new PAreaBI.
PAreaBI.Builder<S>	from(PAreaBIType<S> instance)	Fill a builder with attribute values from the provided com.io7m.jregions.core.parameterized.areas.PAreaBIType<S> instance.
PAreaBI.Builder<S>	from(AreaValuesBIType instance)	Fill a builder with attribute values from the provided com.io7m.jregions.core.unparameterized.areas.AreaValuesBIType instance.
PAreaBI.Builder<S>	setMaximumX(java.math.BigInteger maximumX)	Initializes the value for the maximumX attribute.
PAreaBI.Builder<S>	setMaximumY(java.math.BigInteger maximumY)	Initializes the value for the maximumY attribute.
PAreaBI.Builder<S>	setMinimumX(java.math.BigInteger minimumX)	Initializes the value for the minimumX attribute.
PAreaBI.Builder<S>	setMinimumY(java.math.BigInteger 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 PAreaBI.Builder<S> from(PAreaBIType<S> instance)

Fill a builder with attribute values from the provided com.io7m.jregions.core.parameterized.areas.PAreaBIType<S> instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final PAreaBI.Builder<S> from(AreaValuesBIType instance)

Fill a builder with attribute values from the provided com.io7m.jregions.core.unparameterized.areas.AreaValuesBIType instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setMinimumX

public final PAreaBI.Builder<S> setMinimumX(java.math.BigInteger 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 PAreaBI.Builder<S> setMaximumX(java.math.BigInteger 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 PAreaBI.Builder<S> setMinimumY(java.math.BigInteger 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 PAreaBI.Builder<S> setMaximumY(java.math.BigInteger 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 PAreaBI<S> build()

Builds a new PAreaBI.

Returns:

An immutable instance of PAreaBI

Throws:

java.lang.IllegalStateException - if any required attributes are missing