Module com.io7m.jregions.core

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

Class PAreaSizeF<S>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

PAreaSizeFType<S>, AreaSizeValuesFType

public final class PAreaSizeF<S>
extends java.lang.Object
implements PAreaSizeFType<S>

The size of an area with float coordinates.

Nested Class Summary

Nested Classes

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

Method Summary

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

checkPreconditions

Method Detail

sizeX

public float sizeX()

Specified by:

sizeX in interface AreaSizeValuesFType

Specified by:

sizeX in interface PAreaSizeFType<S>

Returns:

The value of the sizeX attribute

sizeY

public float sizeY()

Specified by:

sizeY in interface AreaSizeValuesFType

Specified by:

sizeY in interface PAreaSizeFType<S>

Returns:

The value of the sizeY attribute

width

@Deprecated
public float width()

Deprecated. Use sizeX()

Specified by:

width in interface AreaSizeValuesFType

Returns:

The width of the area

height

@Deprecated
public float height()

Deprecated. Use sizeY()

Specified by:

height in interface AreaSizeValuesFType

Returns:

The height of the area

equals

public boolean equals(java.lang.Object another)

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PAreaSizeF<S> of(float sizeX,
                                   float sizeY)

Construct a new immutable PAreaSizeF instance.

Parameters:

sizeX - The value for the sizeX attribute

sizeY - The value for the sizeY attribute

Returns:

An immutable PAreaSizeF instance

builder

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

Creates a builder for PAreaSizeF.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaSizeF builder