Module com.io7m.jregions.core

Package com.io7m.jregions.core.unparameterized.areas

Class AreaI

java.lang.Object

com.io7m.jregions.core.unparameterized.areas.AreaI

All Implemented Interfaces:

AreaIType, AreaValuesIType, AreaSizeValuesIType

public final class AreaI
extends java.lang.Object
implements AreaIType

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

Nested Classes

Modifier and Type	Class	Description
static class	AreaI.Builder	Builds instances of type AreaI.

Method Summary

Modifier and Type	Method	Description
static AreaI.Builder	builder()	Creates a builder for AreaI.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of AreaI that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY.
int	height()	Deprecated. Use AreaValuesIType.sizeY()
int	maximumX()
int	maximumY()
int	minimumX()
int	minimumY()
static AreaI	of(int minimumX, int maximumX, int minimumY, int maximumY)	Construct a new immutable AreaI instance.
java.lang.String	toString()	Prints the immutable value AreaI with attribute values.
int	width()	Deprecated. Use AreaValuesIType.sizeX()

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

Methods inherited from class java.lang.Object

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

Method Detail

minimumX

public int minimumX()

Specified by:

minimumX in interface AreaIType

Specified by:

minimumX in interface AreaValuesIType

Returns:

The value of the minimumX attribute

maximumX

public int maximumX()

Specified by:

maximumX in interface AreaIType

Specified by:

maximumX in interface AreaValuesIType

Returns:

The value of the maximumX attribute

minimumY

public int minimumY()

Specified by:

minimumY in interface AreaIType

Specified by:

minimumY in interface AreaValuesIType

Returns:

The value of the minimumY attribute

maximumY

public int maximumY()

Specified by:

maximumY in interface AreaIType

Specified by:

maximumY in interface AreaValuesIType

Returns:

The value of the maximumY attribute

width

@Deprecated
public int width()

Deprecated. Use AreaValuesIType.sizeX()

Specified by:

width in interface AreaSizeValuesIType

Returns:

The width of the area

height

@Deprecated
public int height()

Deprecated. Use AreaValuesIType.sizeY()

Specified by:

height in interface AreaSizeValuesIType

Returns:

The height of the area

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of AreaI 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: minimumX, maximumX, minimumY, maximumY.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value AreaI with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static AreaI of(int minimumX,
                       int maximumX,
                       int minimumY,
                       int maximumY)

Construct a new immutable AreaI instance.

Parameters:

minimumX - The value for the minimumX attribute

maximumX - The value for the maximumX attribute

minimumY - The value for the minimumY attribute

maximumY - The value for the maximumY attribute

Returns:

An immutable AreaI instance

builder

public static AreaI.Builder builder()

Creates a builder for AreaI.

Returns:

A new AreaI builder