Module com.io7m.jregions.core

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

Class PVolumeI<S>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

PVolumeIType<S>, VolumeSizeValuesIType, VolumeValuesIType

public final class PVolumeI<S>
extends java.lang.Object
implements PVolumeIType<S>

A volume with int 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	PVolumeI.Builder<S>	Builds instances of type PVolumeI.

Method Summary

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

checkPreconditions

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

sizeX, sizeY, sizeZ

Method Detail

minimumX

public int minimumX()

Specified by:

minimumX in interface PVolumeIType<S>

Specified by:

minimumX in interface VolumeValuesIType

Returns:

The value of the minimumX attribute

maximumX

public int maximumX()

Specified by:

maximumX in interface PVolumeIType<S>

Specified by:

maximumX in interface VolumeValuesIType

Returns:

The value of the maximumX attribute

minimumY

public int minimumY()

Specified by:

minimumY in interface PVolumeIType<S>

Specified by:

minimumY in interface VolumeValuesIType

Returns:

The value of the minimumY attribute

maximumY

public int maximumY()

Specified by:

maximumY in interface PVolumeIType<S>

Specified by:

maximumY in interface VolumeValuesIType

Returns:

The value of the maximumY attribute

minimumZ

public int minimumZ()

Specified by:

minimumZ in interface PVolumeIType<S>

Specified by:

minimumZ in interface VolumeValuesIType

Returns:

The value of the minimumZ attribute

maximumZ

public int maximumZ()

Specified by:

maximumZ in interface PVolumeIType<S>

Specified by:

maximumZ in interface VolumeValuesIType

Returns:

The value of the maximumZ attribute

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of PVolumeI 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 PVolumeI with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PVolumeI<S> of(int minimumX,
                                 int maximumX,
                                 int minimumY,
                                 int maximumY,
                                 int minimumZ,
                                 int maximumZ)

Construct a new immutable PVolumeI 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 PVolumeI instance

builder

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

Creates a builder for PVolumeI.

Type Parameters:

S - generic parameter S

Returns:

A new PVolumeI builder