Module com.io7m.jregions.core

Package com.io7m.jregions.core.unparameterized.volumes

Class VolumeI.Builder

java.lang.Object

com.io7m.jregions.core.unparameterized.volumes.VolumeI.Builder

Enclosing class:

VolumeI

public static final class VolumeI.Builder
extends java.lang.Object

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

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final VolumeI.Builder from(VolumeValuesIType instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setMinimumX

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

setMinimumZ

public final VolumeI.Builder setMinimumZ(int 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 VolumeI.Builder setMaximumZ(int 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 VolumeI build()

Builds a new VolumeI.

Returns:

An immutable instance of VolumeI

Throws:

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