Module com.io7m.jregions.core

Package com.io7m.jregions.core.parameterized.volumes

Class PVolumeBI.Builder<S>

java.lang.Object

com.io7m.jregions.core.parameterized.volumes.PVolumeBI.Builder<S>

Enclosing class:

PVolumeBI<S>

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

Builds instances of type PVolumeBI. 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
PVolumeBI<S>	build()	Builds a new PVolumeBI.
PVolumeBI.Builder<S>	from(PVolumeBIType<S> instance)	Fill a builder with attribute values from the provided com.io7m.jregions.core.parameterized.volumes.PVolumeBIType<S> instance.
PVolumeBI.Builder<S>	from(VolumeValuesBIType instance)	Fill a builder with attribute values from the provided com.io7m.jregions.core.unparameterized.volumes.VolumeValuesBIType instance.
PVolumeBI.Builder<S>	setMaximumX(java.math.BigInteger maximumX)	Initializes the value for the maximumX attribute.
PVolumeBI.Builder<S>	setMaximumY(java.math.BigInteger maximumY)	Initializes the value for the maximumY attribute.
PVolumeBI.Builder<S>	setMaximumZ(java.math.BigInteger maximumZ)	Initializes the value for the maximumZ attribute.
PVolumeBI.Builder<S>	setMinimumX(java.math.BigInteger minimumX)	Initializes the value for the minimumX attribute.
PVolumeBI.Builder<S>	setMinimumY(java.math.BigInteger minimumY)	Initializes the value for the minimumY attribute.
PVolumeBI.Builder<S>	setMinimumZ(java.math.BigInteger minimumZ)	Initializes the value for the minimumZ attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final PVolumeBI.Builder<S> from(PVolumeBIType<S> instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final PVolumeBI.Builder<S> from(VolumeValuesBIType instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setMinimumX

public final PVolumeBI.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 PVolumeBI.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 PVolumeBI.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 PVolumeBI.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

setMinimumZ

public final PVolumeBI.Builder<S> setMinimumZ(java.math.BigInteger minimumZ)

Initializes the value for the minimumZ attribute.

Parameters:

minimumZ - The value for minimumZ

Returns:

this builder for use in a chained invocation

setMaximumZ

public final PVolumeBI.Builder<S> setMaximumZ(java.math.BigInteger maximumZ)

Initializes the value for the maximumZ attribute.

Parameters:

maximumZ - The value for maximumZ

Returns:

this builder for use in a chained invocation

build

public PVolumeBI<S> build()

Builds a new PVolumeBI.

Returns:

An immutable instance of PVolumeBI

Throws:

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