Module com.io7m.jregions.core

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

Class PAreaI.Builder<S>

java.lang.Object

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

Enclosing class:

PAreaI<S>

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

Builds instances of type PAreaI. 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
PAreaI<S>	build()	Builds a new PAreaI.
PAreaI.Builder<S>	from(PAreaIType<S> instance)	Fill a builder with attribute values from the provided com.io7m.jregions.core.parameterized.areas.PAreaIType<S> instance.
PAreaI.Builder<S>	from(AreaValuesIType instance)	Fill a builder with attribute values from the provided com.io7m.jregions.core.unparameterized.areas.AreaValuesIType instance.
PAreaI.Builder<S>	setMaximumX(int maximumX)	Initializes the value for the maximumX attribute.
PAreaI.Builder<S>	setMaximumY(int maximumY)	Initializes the value for the maximumY attribute.
PAreaI.Builder<S>	setMinimumX(int minimumX)	Initializes the value for the minimumX attribute.
PAreaI.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 PAreaI.Builder<S> from(AreaValuesIType instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final PAreaI.Builder<S> from(PAreaIType<S> instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setMinimumX

public final PAreaI.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 PAreaI.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 PAreaI.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 PAreaI.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 PAreaI<S> build()

Builds a new PAreaI.

Returns:

An immutable instance of PAreaI

Throws:

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