Module com.io7m.jregions.core

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

Class PVolumeBD.Builder<S>

java.lang.Object

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

Enclosing class:

PVolumeBD<S>

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

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

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final PVolumeBD.Builder<S> from(VolumeValuesBDType instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setMinimumX

public final PVolumeBD.Builder<S> setMinimumX(java.math.BigDecimal 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 PVolumeBD.Builder<S> setMaximumX(java.math.BigDecimal 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 PVolumeBD.Builder<S> setMinimumY(java.math.BigDecimal 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 PVolumeBD.Builder<S> setMaximumY(java.math.BigDecimal 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 PVolumeBD.Builder<S> setMinimumZ(java.math.BigDecimal 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 PVolumeBD.Builder<S> setMaximumZ(java.math.BigDecimal 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 PVolumeBD<S> build()

Builds a new PVolumeBD.

Returns:

An immutable instance of PVolumeBD

Throws:

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