Module com.io7m.jregions.core

Package com.io7m.jregions.core.unparameterized.sizes

Class AreaSizeI

java.lang.Object

com.io7m.jregions.core.unparameterized.sizes.AreaSizeI

All Implemented Interfaces:

AreaSizeIType, AreaSizeValuesIType

public final class AreaSizeI
extends java.lang.Object
implements AreaSizeIType

The size of an area with int coordinates.

Nested Class Summary

Nested Classes

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

Method Summary

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

Specified by:

sizeX in interface AreaSizeValuesIType

Returns:

The value of the sizeX attribute

sizeY

public int sizeY()

Specified by:

sizeY in interface AreaSizeIType

Specified by:

sizeY in interface AreaSizeValuesIType

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 AreaSizeI 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 AreaSizeI with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static AreaSizeI of(int sizeX,
                           int sizeY)

Construct a new immutable AreaSizeI instance.

Parameters:

sizeX - The value for the sizeX attribute

sizeY - The value for the sizeY attribute

Returns:

An immutable AreaSizeI instance

builder

public static AreaSizeI.Builder builder()

Creates a builder for AreaSizeI.

Returns:

A new AreaSizeI builder