Class AreaI
java.lang.Object
com.io7m.jregions.core.unparameterized.areas.AreaI
- All Implemented Interfaces:
AreaIType
,AreaValuesIType
,AreaSizeValuesIType
An area 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 axis.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AreaI.Builder
builder()
Creates a builder forAreaI
.static AreaI
Creates an immutable copy of aAreaIType
value.boolean
This instance is equal to all instances ofAreaI
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:minimumX
,maximumX
,minimumY
,maximumY
.int
height()
Deprecated.int
maximumX()
int
maximumY()
int
minimumX()
int
minimumY()
static AreaI
of
(int minimumX, int maximumX, int minimumY, int maximumY) Construct a new immutableAreaI
instance.toString()
Prints the immutable valueAreaI
with attribute values.int
width()
Deprecated.final AreaI
withMaximumX
(int value) Copy the current immutable object by setting a value for themaximumX
attribute.final AreaI
withMaximumY
(int value) Copy the current immutable object by setting a value for themaximumY
attribute.final AreaI
withMinimumX
(int value) Copy the current immutable object by setting a value for theminimumX
attribute.final AreaI
withMinimumY
(int 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.AreaIType
checkPreconditions
Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaValuesIType
sizeX, sizeY
-
Method Details
-
width
Deprecated.- Specified by:
width
in interfaceAreaSizeValuesIType
- Returns:
- The width of the area
-
height
Deprecated.- Specified by:
height
in interfaceAreaSizeValuesIType
- Returns:
- The height of the area
-
minimumX
public int minimumX()- Specified by:
minimumX
in interfaceAreaIType
- Specified by:
minimumX
in interfaceAreaValuesIType
- Returns:
- The value of the
minimumX
attribute
-
maximumX
public int maximumX()- Specified by:
maximumX
in interfaceAreaIType
- Specified by:
maximumX
in interfaceAreaValuesIType
- Returns:
- The value of the
maximumX
attribute
-
minimumY
public int minimumY()- Specified by:
minimumY
in interfaceAreaIType
- Specified by:
minimumY
in interfaceAreaValuesIType
- Returns:
- The value of the
minimumY
attribute
-
maximumY
public int maximumY()- Specified by:
maximumY
in interfaceAreaIType
- Specified by:
maximumY
in interfaceAreaValuesIType
- Returns:
- The value of the
maximumY
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
-
equals
This instance is equal to all instances ofAreaI
that have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:minimumX
,maximumX
,minimumY
,maximumY
. -
toString
Prints the immutable valueAreaI
with attribute values. -
of
Construct a new immutableAreaI
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 AreaI instance
-
copyOf
Creates an immutable copy of aAreaIType
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 AreaI instance
-
builder
Creates a builder forAreaI
.AreaI.builder() .setMinimumX(int) // required
minimumX
.setMaximumX(int) // requiredmaximumX
.setMinimumY(int) // requiredminimumY
.setMaximumY(int) // requiredmaximumY
.build();- Returns:
- A new AreaI builder
-
AreaValuesIType.sizeY()