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>

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

The size of an area with int coordinates.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

width

public int width()

Specified by:

width in interface PAreaSizeIType<S>

Returns:

The width of an area

height

public int height()

Specified by:

height in interface PAreaSizeIType<S>

Returns:

The height of an area

equals

public boolean equals(Object another)

This instance is equal to all instances of PAreaSizeI 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: width, height.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value PAreaSizeI with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <S> PAreaSizeI<S> of(int width,
                                   int height)

Construct a new immutable PAreaSizeI instance.

Parameters:

width - The value for the width attribute

height - The value for the height 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