Class AreaBI
java.lang.Object
com.io7m.jregions.core.unparameterized.areas.AreaBI
- All Implemented Interfaces:
AreaBIType
,AreaValuesBIType
,AreaSizeValuesBIType
An area with BigInteger
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 axis.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AreaBI.Builder
builder()
Creates a builder forAreaBI
.static AreaBI
copyOf
(AreaBIType instance) Creates an immutable copy of aAreaBIType
value.boolean
This instance is equal to all instances ofAreaBI
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:minimumX
,maximumX
,minimumY
,maximumY
.height()
Deprecated.maximumX()
maximumY()
minimumX()
minimumY()
static AreaBI
of
(BigInteger minimumX, BigInteger maximumX, BigInteger minimumY, BigInteger maximumY) Construct a new immutableAreaBI
instance.toString()
Prints the immutable valueAreaBI
with attribute values.width()
Deprecated.final AreaBI
withMaximumX
(BigInteger value) Copy the current immutable object by setting a value for themaximumX
attribute.final AreaBI
withMaximumY
(BigInteger value) Copy the current immutable object by setting a value for themaximumY
attribute.final AreaBI
withMinimumX
(BigInteger value) Copy the current immutable object by setting a value for theminimumX
attribute.final AreaBI
withMinimumY
(BigInteger value) Copy the current immutable object by setting a value for theminimumY
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.areas.AreaBIType
checkPreconditions
Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaValuesBIType
sizeX, sizeY
-
Method Details
-
width
Deprecated.- Specified by:
width
in interfaceAreaSizeValuesBIType
- Returns:
- The width of the area
-
height
Deprecated.- Specified by:
height
in interfaceAreaSizeValuesBIType
- Returns:
- The height of the area
-
minimumX
- Specified by:
minimumX
in interfaceAreaBIType
- Specified by:
minimumX
in interfaceAreaValuesBIType
- Returns:
- The value of the
minimumX
attribute
-
maximumX
- Specified by:
maximumX
in interfaceAreaBIType
- Specified by:
maximumX
in interfaceAreaValuesBIType
- Returns:
- The value of the
maximumX
attribute
-
minimumY
- Specified by:
minimumY
in interfaceAreaBIType
- Specified by:
minimumY
in interfaceAreaValuesBIType
- Returns:
- The value of the
minimumY
attribute
-
maximumY
- Specified by:
maximumY
in interfaceAreaBIType
- Specified by:
maximumY
in interfaceAreaValuesBIType
- Returns:
- The value of the
maximumY
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
-
equals
This instance is equal to all instances ofAreaBI
that have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:minimumX
,maximumX
,minimumY
,maximumY
. -
toString
Prints the immutable valueAreaBI
with attribute values. -
of
public static AreaBI of(BigInteger minimumX, BigInteger maximumX, BigInteger minimumY, BigInteger maximumY) Construct a new immutableAreaBI
instance.- Parameters:
minimumX
- The value for theminimumX
attributemaximumX
- The value for themaximumX
attributeminimumY
- The value for theminimumY
attributemaximumY
- The value for themaximumY
attribute- Returns:
- An immutable AreaBI instance
-
copyOf
Creates an immutable copy of aAreaBIType
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 AreaBI instance
-
builder
Creates a builder forAreaBI
.AreaBI.builder() .setMinimumX(java.math.BigInteger) // required
minimumX
.setMaximumX(java.math.BigInteger) // requiredmaximumX
.setMinimumY(java.math.BigInteger) // requiredminimumY
.setMaximumY(java.math.BigInteger) // requiredmaximumY
.build();- Returns:
- A new AreaBI builder
-
AreaValuesBIType.sizeY()