Module com.io7m.jregions.core

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

Class PVolumeL<S>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

PVolumeLType<S>, VolumeSizeValuesLType, VolumeValuesLType

public final class PVolumeL<S>
extends java.lang.Object
implements PVolumeLType<S>

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

Method Summary

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

checkPreconditions

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

sizeX, sizeY, sizeZ

Method Detail

minimumX

public long minimumX()

Specified by:

minimumX in interface PVolumeLType<S>

Specified by:

minimumX in interface VolumeValuesLType

Returns:

The value of the minimumX attribute

maximumX

public long maximumX()

Specified by:

maximumX in interface PVolumeLType<S>

Specified by:

maximumX in interface VolumeValuesLType

Returns:

The value of the maximumX attribute

minimumY

public long minimumY()

Specified by:

minimumY in interface PVolumeLType<S>

Specified by:

minimumY in interface VolumeValuesLType

Returns:

The value of the minimumY attribute

maximumY

public long maximumY()

Specified by:

maximumY in interface PVolumeLType<S>

Specified by:

maximumY in interface VolumeValuesLType

Returns:

The value of the maximumY attribute

minimumZ

public long minimumZ()

Specified by:

minimumZ in interface PVolumeLType<S>

Specified by:

minimumZ in interface VolumeValuesLType

Returns:

The value of the minimumZ attribute

maximumZ

public long maximumZ()

Specified by:

maximumZ in interface PVolumeLType<S>

Specified by:

maximumZ in interface VolumeValuesLType

Returns:

The value of the maximumZ attribute

equals

public boolean equals(java.lang.Object another)

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PVolumeL<S> of(long minimumX,
                                 long maximumX,
                                 long minimumY,
                                 long maximumY,
                                 long minimumZ,
                                 long maximumZ)

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

builder

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

Creates a builder for PVolumeL.

Type Parameters:

S - generic parameter S

Returns:

A new PVolumeL builder