Module com.io7m.jregions.core

Package com.io7m.jregions.core.parameterized.areas

Class PAreaBI<S>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

PAreaBIType<S>, AreaValuesBIType, AreaSizeValuesBIType

public final class PAreaBI<S>
extends java.lang.Object
implements PAreaBIType<S>

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

Nested Classes

Modifier and Type	Class	Description
static class	PAreaBI.Builder<S>	Builds instances of type PAreaBI.

Method Summary

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

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

sizeX, sizeY

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.PAreaBIType

checkPreconditions

Method Detail

minimumX

public java.math.BigInteger minimumX()

Specified by:

minimumX in interface AreaValuesBIType

Specified by:

minimumX in interface PAreaBIType<S>

Returns:

The value of the minimumX attribute

maximumX

public java.math.BigInteger maximumX()

Specified by:

maximumX in interface AreaValuesBIType

Specified by:

maximumX in interface PAreaBIType<S>

Returns:

The value of the maximumX attribute

minimumY

public java.math.BigInteger minimumY()

Specified by:

minimumY in interface AreaValuesBIType

Specified by:

minimumY in interface PAreaBIType<S>

Returns:

The value of the minimumY attribute

maximumY

public java.math.BigInteger maximumY()

Specified by:

maximumY in interface AreaValuesBIType

Specified by:

maximumY in interface PAreaBIType<S>

Returns:

The value of the maximumY attribute

width

@Deprecated
public java.math.BigInteger width()

Deprecated. Use AreaValuesBIType.sizeX()

Specified by:

width in interface AreaSizeValuesBIType

Returns:

The width of the area

height

@Deprecated
public java.math.BigInteger height()

Deprecated. Use AreaValuesBIType.sizeY()

Specified by:

height in interface AreaSizeValuesBIType

Returns:

The height of the area

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of PAreaBI 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 PAreaBI with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PAreaBI<S> of(java.math.BigInteger minimumX,
                                java.math.BigInteger maximumX,
                                java.math.BigInteger minimumY,
                                java.math.BigInteger maximumY)

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

builder

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

Creates a builder for PAreaBI.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaBI builder