Module com.io7m.jregions.core

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

Class PAreaSizeI<S>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

PAreaSizeIType<S>, AreaSizeValuesIType

public final class PAreaSizeI<S>
extends java.lang.Object
implements PAreaSizeIType<S>

The size of an area with int coordinates.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

sizeX

public int sizeX()

Specified by:

sizeX in interface AreaSizeValuesIType

Specified by:

sizeX in interface PAreaSizeIType<S>

Returns:

The value of the sizeX attribute

sizeY

public int sizeY()

Specified by:

sizeY in interface AreaSizeValuesIType

Specified by:

sizeY in interface PAreaSizeIType<S>

Returns:

The value of the sizeY attribute

width

@Deprecated
public int width()

Deprecated. Use sizeX()

Specified by:

width in interface AreaSizeValuesIType

Returns:

The width of the area

height

@Deprecated
public int height()

Deprecated. Use 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 PAreaSizeI 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 PAreaSizeI with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PAreaSizeI<S> of(int sizeX,
                                   int sizeY)

Construct a new immutable PAreaSizeI instance.

Parameters:

sizeX - The value for the sizeX attribute

sizeY - The value for the sizeY attribute

Returns:

An immutable PAreaSizeI instance

builder

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

Creates a builder for PAreaSizeI.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaSizeI builder