Module com.io7m.jregions.core

Package com.io7m.jregions.core.parameterized.sizes

Class PVolumeSizeL<S>

java.lang.Object

com.io7m.jregions.core.parameterized.sizes.PVolumeSizeL<S>

Type Parameters:

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

All Implemented Interfaces:

PVolumeSizeLType<S>, VolumeSizeValuesLType

public final class PVolumeSizeL<S>
extends java.lang.Object
implements PVolumeSizeLType<S>

The size of a volume with long coordinates.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static <S> PVolumeSizeL.Builder<S>	builder()	Creates a builder for PVolumeSizeL.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of PVolumeSizeL that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: sizeX, sizeY, sizeZ.
static <S> PVolumeSizeL<S>	of(long sizeX, long sizeY, long sizeZ)	Construct a new immutable PVolumeSizeL instance.
long	sizeX()
long	sizeY()
long	sizeZ()
java.lang.String	toString()	Prints the immutable value PVolumeSizeL with attribute values.

Methods inherited from class java.lang.Object

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

Method Detail

sizeX

public long sizeX()

Specified by:

sizeX in interface PVolumeSizeLType<S>

Specified by:

sizeX in interface VolumeSizeValuesLType

Returns:

The value of the sizeX attribute

sizeY

public long sizeY()

Specified by:

sizeY in interface PVolumeSizeLType<S>

Specified by:

sizeY in interface VolumeSizeValuesLType

Returns:

The value of the sizeY attribute

sizeZ

public long sizeZ()

Specified by:

sizeZ in interface PVolumeSizeLType<S>

Specified by:

sizeZ in interface VolumeSizeValuesLType

Returns:

The value of the sizeZ attribute

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of PVolumeSizeL 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: sizeX, sizeY, sizeZ.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value PVolumeSizeL with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PVolumeSizeL<S> of(long sizeX,
                                     long sizeY,
                                     long sizeZ)

Construct a new immutable PVolumeSizeL instance.

Parameters:

sizeX - The value for the sizeX attribute

sizeY - The value for the sizeY attribute

sizeZ - The value for the sizeZ attribute

Returns:

An immutable PVolumeSizeL instance

builder

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

Creates a builder for PVolumeSizeL.

Type Parameters:

S - generic parameter S

Returns:

A new PVolumeSizeL builder