Module com.io7m.jregions.core

Package com.io7m.jregions.core.parameterized.sizes

Class PAreaSizeBI<S>

java.lang.Object

com.io7m.jregions.core.parameterized.sizes.PAreaSizeBI<S>

Type Parameters:

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

All Implemented Interfaces:

PAreaSizeBIType<S>, AreaSizeValuesBIType

public final class PAreaSizeBI<S>
extends java.lang.Object
implements PAreaSizeBIType<S>

The size of an area with BigInteger coordinates.

Nested Class Summary

Nested Classes

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

Method Summary

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

checkPreconditions

Method Detail

sizeX

public java.math.BigInteger sizeX()

Specified by:

sizeX in interface AreaSizeValuesBIType

Specified by:

sizeX in interface PAreaSizeBIType<S>

Returns:

The value of the sizeX attribute

sizeY

public java.math.BigInteger sizeY()

Specified by:

sizeY in interface AreaSizeValuesBIType

Specified by:

sizeY in interface PAreaSizeBIType<S>

Returns:

The value of the sizeY attribute

width

@Deprecated
public java.math.BigInteger width()

Deprecated. Use sizeX()

Specified by:

width in interface AreaSizeValuesBIType

Returns:

The width of the area

height

@Deprecated
public java.math.BigInteger height()

Deprecated. Use 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 PAreaSizeBI 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: sizeX, sizeY.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value PAreaSizeBI with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PAreaSizeBI<S> of(java.math.BigInteger sizeX,
                                    java.math.BigInteger sizeY)

Construct a new immutable PAreaSizeBI instance.

Parameters:

sizeX - The value for the sizeX attribute

sizeY - The value for the sizeY attribute

Returns:

An immutable PAreaSizeBI instance

builder

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

Creates a builder for PAreaSizeBI.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaSizeBI builder