com.io7m.jregions.core.parameterized.areas

Class PAreaI<S>

java.lang.Object

com.io7m.jregions.core.parameterized.areas.PAreaI<S>

Type Parameters:

S - A phantom type parameter indicating the coordinate space of the area

All Implemented Interfaces:

PAreaIType<S>, AreaValuesIType, AreaSizeValuesIType

@Generated(value={"Immutables.generator","PAreaIType<S>"})
public final class PAreaI<S>
extends Object
implements PAreaIType<S>

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 and Description
static class	PAreaI.Builder<S> Builds instances of type PAreaI.

Method Summary

Modifier and Type	Method and Description
static <S> PAreaI.Builder<S>	builder() Creates a builder for PAreaI.
boolean	equals(Object another) This instance is equal to all instances of PAreaI 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 <S> PAreaI<S>	of(int minimumX, int maximumX, int minimumY, int maximumY) Construct a new immutable PAreaI instance.
String	toString() Prints the immutable value PAreaI with attribute values.
int	width() Deprecated. Use AreaValuesIType.sizeX()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jregions.core.parameterized.areas.PAreaIType

checkPreconditions

Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaValuesIType

sizeX, sizeY

Method Detail

minimumX

public int minimumX()

Specified by:

minimumX in interface PAreaIType<S>

Specified by:

minimumX in interface AreaValuesIType

Returns:

The value of the minimumX attribute

maximumX

public int maximumX()

Specified by:

maximumX in interface PAreaIType<S>

Specified by:

maximumX in interface AreaValuesIType

Returns:

The value of the maximumX attribute

minimumY

public int minimumY()

Specified by:

minimumY in interface PAreaIType<S>

Specified by:

minimumY in interface AreaValuesIType

Returns:

The value of the minimumY attribute

maximumY

public int maximumY()

Specified by:

maximumY in interface PAreaIType<S>

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(Object another)

This instance is equal to all instances of PAreaI that have equal attribute values.

Overrides:

equals in class 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 Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value PAreaI with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <S> PAreaI<S> of(int minimumX,
                               int maximumX,
                               int minimumY,
                               int maximumY)

Construct a new immutable PAreaI 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 PAreaI instance

builder

public static <S> PAreaI.Builder<S> builder()

Creates a builder for PAreaI.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaI builder