Class VolumeBD
java.lang.Object
com.io7m.jregions.core.unparameterized.volumes.VolumeBD
- All Implemented Interfaces:
VolumeSizeValuesBDType
,VolumeBDType
,VolumeValuesBDType
A volume with BigDecimal
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 VolumeBD.Builder
builder()
Creates a builder forVolumeBD
.static VolumeBD
copyOf
(VolumeBDType instance) Creates an immutable copy of aVolumeBDType
value.boolean
This instance is equal to all instances ofVolumeBD
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:minimumX
,maximumX
,minimumY
,maximumY
,minimumZ
,maximumZ
.maximumX()
maximumY()
maximumZ()
minimumX()
minimumY()
minimumZ()
static VolumeBD
of
(BigDecimal minimumX, BigDecimal maximumX, BigDecimal minimumY, BigDecimal maximumY, BigDecimal minimumZ, BigDecimal maximumZ) Construct a new immutableVolumeBD
instance.toString()
Prints the immutable valueVolumeBD
with attribute values.final VolumeBD
withMaximumX
(BigDecimal value) Copy the current immutable object by setting a value for themaximumX
attribute.final VolumeBD
withMaximumY
(BigDecimal value) Copy the current immutable object by setting a value for themaximumY
attribute.final VolumeBD
withMaximumZ
(BigDecimal value) Copy the current immutable object by setting a value for themaximumZ
attribute.final VolumeBD
withMinimumX
(BigDecimal value) Copy the current immutable object by setting a value for theminimumX
attribute.final VolumeBD
withMinimumY
(BigDecimal value) Copy the current immutable object by setting a value for theminimumY
attribute.final VolumeBD
withMinimumZ
(BigDecimal 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.unparameterized.volumes.VolumeBDType
checkPreconditions
Methods inherited from interface com.io7m.jregions.core.unparameterized.volumes.VolumeValuesBDType
sizeX, sizeY, sizeZ
-
Method Details
-
minimumX
- Specified by:
minimumX
in interfaceVolumeBDType
- Specified by:
minimumX
in interfaceVolumeValuesBDType
- Returns:
- The value of the
minimumX
attribute
-
maximumX
- Specified by:
maximumX
in interfaceVolumeBDType
- Specified by:
maximumX
in interfaceVolumeValuesBDType
- Returns:
- The value of the
maximumX
attribute
-
minimumY
- Specified by:
minimumY
in interfaceVolumeBDType
- Specified by:
minimumY
in interfaceVolumeValuesBDType
- Returns:
- The value of the
minimumY
attribute
-
maximumY
- Specified by:
maximumY
in interfaceVolumeBDType
- Specified by:
maximumY
in interfaceVolumeValuesBDType
- Returns:
- The value of the
maximumY
attribute
-
minimumZ
- Specified by:
minimumZ
in interfaceVolumeBDType
- Specified by:
minimumZ
in interfaceVolumeValuesBDType
- Returns:
- The value of the
minimumZ
attribute
-
maximumZ
- Specified by:
maximumZ
in interfaceVolumeBDType
- Specified by:
maximumZ
in interfaceVolumeValuesBDType
- Returns:
- The value of the
maximumZ
attribute
-
withMinimumX
Copy the current immutable object by setting a value for theminimumX
attribute. An equals check 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. An equals check 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. An equals check 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. An equals check 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. An equals check 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. An equals check 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 ofVolumeBD
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 valueVolumeBD
with attribute values. -
of
public static VolumeBD of(BigDecimal minimumX, BigDecimal maximumX, BigDecimal minimumY, BigDecimal maximumY, BigDecimal minimumZ, BigDecimal maximumZ) Construct a new immutableVolumeBD
instance.- 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 VolumeBD instance
-
copyOf
Creates an immutable copy of aVolumeBDType
value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Parameters:
instance
- The instance to copy- Returns:
- A copied immutable VolumeBD instance
-
builder
Creates a builder forVolumeBD
.VolumeBD.builder() .setMinimumX(java.math.BigDecimal) // required
minimumX
.setMaximumX(java.math.BigDecimal) // requiredmaximumX
.setMinimumY(java.math.BigDecimal) // requiredminimumY
.setMaximumY(java.math.BigDecimal) // requiredmaximumY
.setMinimumZ(java.math.BigDecimal) // requiredminimumZ
.setMaximumZ(java.math.BigDecimal) // requiredmaximumZ
.build();- Returns:
- A new VolumeBD builder
-