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
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
-
Method Summary
Modifier and TypeMethodDescriptionstatic <S> PVolumeI.Builder<S>
builder()
Creates a builder forPVolumeI
.static <S> PVolumeI<S>
copyOf
(PVolumeIType<S> instance) Creates an immutable copy of aPVolumeIType
value.boolean
This instance is equal to all instances ofPVolumeI
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 immutablePVolumeI
instance.toString()
Prints the immutable valuePVolumeI
with attribute values.withMaximumX
(int value) Copy the current immutable object by setting a value for themaximumX
attribute.withMaximumY
(int value) Copy the current immutable object by setting a value for themaximumY
attribute.withMaximumZ
(int value) Copy the current immutable object by setting a value for themaximumZ
attribute.withMinimumX
(int value) Copy the current immutable object by setting a value for theminimumX
attribute.withMinimumY
(int value) Copy the current immutable object by setting a value for theminimumY
attribute.withMinimumZ
(int value) Copy the current immutable object by setting a value for theminimumZ
attribute.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 Details
-
minimumX
public int minimumX()- Specified by:
minimumX
in interfacePVolumeIType<S>
- Specified by:
minimumX
in interfaceVolumeValuesIType
- Returns:
- The value of the
minimumX
attribute
-
maximumX
public int maximumX()- Specified by:
maximumX
in interfacePVolumeIType<S>
- Specified by:
maximumX
in interfaceVolumeValuesIType
- Returns:
- The value of the
maximumX
attribute
-
minimumY
public int minimumY()- Specified by:
minimumY
in interfacePVolumeIType<S>
- Specified by:
minimumY
in interfaceVolumeValuesIType
- Returns:
- The value of the
minimumY
attribute
-
maximumY
public int maximumY()- Specified by:
maximumY
in interfacePVolumeIType<S>
- Specified by:
maximumY
in interfaceVolumeValuesIType
- Returns:
- The value of the
maximumY
attribute
-
minimumZ
public int minimumZ()- Specified by:
minimumZ
in interfacePVolumeIType<S>
- Specified by:
minimumZ
in interfaceVolumeValuesIType
- Returns:
- The value of the
minimumZ
attribute
-
maximumZ
public int maximumZ()- Specified by:
maximumZ
in interfacePVolumeIType<S>
- Specified by:
maximumZ
in interfaceVolumeValuesIType
- Returns:
- The value of the
maximumZ
attribute
-
withMinimumX
Copy the current immutable object by setting a value for theminimumX
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for minimumX- Returns:
- A modified copy of the
this
object
-
withMaximumX
Copy the current immutable object by setting a value for themaximumX
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for maximumX- Returns:
- A modified copy of the
this
object
-
withMinimumY
Copy the current immutable object by setting a value for theminimumY
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for minimumY- Returns:
- A modified copy of the
this
object
-
withMaximumY
Copy the current immutable object by setting a value for themaximumY
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for maximumY- Returns:
- A modified copy of the
this
object
-
withMinimumZ
Copy the current immutable object by setting a value for theminimumZ
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for minimumZ- Returns:
- A modified copy of the
this
object
-
withMaximumZ
Copy the current immutable object by setting a value for themaximumZ
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for maximumZ- Returns:
- A modified copy of the
this
object
-
equals
This instance is equal to all instances ofPVolumeI
that have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:minimumX
,maximumX
,minimumY
,maximumY
,minimumZ
,maximumZ
. -
toString
Prints the immutable valuePVolumeI
with attribute values. -
of
public static <S> PVolumeI<S> of(int minimumX, int maximumX, int minimumY, int maximumY, int minimumZ, int maximumZ) Construct a new immutablePVolumeI
instance.- Type Parameters:
S
- generic parameter S- Parameters:
minimumX
- The value for theminimumX
attributemaximumX
- The value for themaximumX
attributeminimumY
- The value for theminimumY
attributemaximumY
- The value for themaximumY
attributeminimumZ
- The value for theminimumZ
attributemaximumZ
- The value for themaximumZ
attribute- Returns:
- An immutable PVolumeI instance
-
copyOf
Creates an immutable copy of aPVolumeIType
value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Type Parameters:
S
- generic parameter S- Parameters:
instance
- The instance to copy- Returns:
- A copied immutable PVolumeI instance
-
builder
Creates a builder forPVolumeI
.PVolumeI.<S>builder() .setMinimumX(int) // required
minimumX
.setMaximumX(int) // requiredmaximumX
.setMinimumY(int) // requiredminimumY
.setMaximumY(int) // requiredmaximumY
.setMinimumZ(int) // requiredminimumZ
.setMaximumZ(int) // requiredmaximumZ
.build();- Type Parameters:
S
- generic parameter S- Returns:
- A new PVolumeI builder
-