Module com.io7m.jregions.core

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

Class PVolumeBI<S>

java.lang.Object

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

Type Parameters:

S - A phantom type parameter indicating the coordinate space of the volume

All Implemented Interfaces:

PVolumeBIType<S>, VolumeSizeValuesBIType, VolumeValuesBIType

public final class PVolumeBI<S>
extends java.lang.Object
implements PVolumeBIType<S>

A volume with BigInteger coordinates.

The coordinates of the area are given in half-closed form. That is, minimumX() refers to the minimum inclusive value on the X axis, and maximumX() refers to the maximum exclusive value on the X axis. Likewise for the Y and Z axes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PVolumeBI.Builder<S>	Builds instances of type PVolumeBI.

Method Summary

Modifier and Type	Method	Description
static <S> PVolumeBI.Builder<S>	builder()	Creates a builder for PVolumeBI.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of PVolumeBI that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ.
java.math.BigInteger	maximumX()
java.math.BigInteger	maximumY()
java.math.BigInteger	maximumZ()
java.math.BigInteger	minimumX()
java.math.BigInteger	minimumY()
java.math.BigInteger	minimumZ()
static <S> PVolumeBI<S>	of(java.math.BigInteger minimumX, java.math.BigInteger maximumX, java.math.BigInteger minimumY, java.math.BigInteger maximumY, java.math.BigInteger minimumZ, java.math.BigInteger maximumZ)	Construct a new immutable PVolumeBI instance.
java.lang.String	toString()	Prints the immutable value PVolumeBI with attribute values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.jregions.core.parameterized.volumes.PVolumeBIType

checkPreconditions

Methods inherited from interface com.io7m.jregions.core.unparameterized.volumes.VolumeValuesBIType

sizeX, sizeY, sizeZ

Method Detail

minimumX

public java.math.BigInteger minimumX()

Specified by:

minimumX in interface PVolumeBIType<S>

Specified by:

minimumX in interface VolumeValuesBIType

Returns:

The value of the minimumX attribute

maximumX

public java.math.BigInteger maximumX()

Specified by:

maximumX in interface PVolumeBIType<S>

Specified by:

maximumX in interface VolumeValuesBIType

Returns:

The value of the maximumX attribute

minimumY

public java.math.BigInteger minimumY()

Specified by:

minimumY in interface PVolumeBIType<S>

Specified by:

minimumY in interface VolumeValuesBIType

Returns:

The value of the minimumY attribute

maximumY

public java.math.BigInteger maximumY()

Specified by:

maximumY in interface PVolumeBIType<S>

Specified by:

maximumY in interface VolumeValuesBIType

Returns:

The value of the maximumY attribute

minimumZ

public java.math.BigInteger minimumZ()

Specified by:

minimumZ in interface PVolumeBIType<S>

Specified by:

minimumZ in interface VolumeValuesBIType

Returns:

The value of the minimumZ attribute

maximumZ

public java.math.BigInteger maximumZ()

Specified by:

maximumZ in interface PVolumeBIType<S>

Specified by:

maximumZ in interface VolumeValuesBIType

Returns:

The value of the maximumZ attribute

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of PVolumeBI that have equal attribute values.

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value PVolumeBI with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PVolumeBI<S> of(java.math.BigInteger minimumX,
                                  java.math.BigInteger maximumX,
                                  java.math.BigInteger minimumY,
                                  java.math.BigInteger maximumY,
                                  java.math.BigInteger minimumZ,
                                  java.math.BigInteger maximumZ)

Construct a new immutable PVolumeBI instance.

Parameters:

minimumX - The value for the minimumX attribute

maximumX - The value for the maximumX attribute

minimumY - The value for the minimumY attribute

maximumY - The value for the maximumY attribute

minimumZ - The value for the minimumZ attribute

maximumZ - The value for the maximumZ attribute

Returns:

An immutable PVolumeBI instance

builder

public static <S> PVolumeBI.Builder<S> builder()

Creates a builder for PVolumeBI.

Type Parameters:

S - generic parameter S

Returns:

A new PVolumeBI builder