Module com.io7m.jregions.core

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

Class AreaSizeF

java.lang.Object

com.io7m.jregions.core.unparameterized.sizes.AreaSizeF

All Implemented Interfaces:

AreaSizeFType, AreaSizeValuesFType

public final class AreaSizeF
extends java.lang.Object
implements AreaSizeFType

The size of an area with float coordinates.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface com.io7m.jregions.core.unparameterized.sizes.AreaSizeFType

checkPreconditions

Methods inherited from class java.lang.Object

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

Method Detail

sizeX

public float sizeX()

Specified by:

sizeX in interface AreaSizeFType

Specified by:

sizeX in interface AreaSizeValuesFType

Returns:

The value of the sizeX attribute

sizeY

public float sizeY()

Specified by:

sizeY in interface AreaSizeFType

Specified by:

sizeY in interface AreaSizeValuesFType

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static AreaSizeF of(float sizeX,
                           float sizeY)

Construct a new immutable AreaSizeF instance.

Parameters:

sizeX - The value for the sizeX attribute

sizeY - The value for the sizeY attribute

Returns:

An immutable AreaSizeF instance

builder

public static AreaSizeF.Builder builder()

Creates a builder for AreaSizeF.

Returns:

A new AreaSizeF builder