com.io7m.jregions.core.parameterized.areas

Class PAreaF<S>

java.lang.Object

com.io7m.jregions.core.parameterized.areas.PAreaF<S>

Type Parameters:

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

All Implemented Interfaces:

PAreaFType<S>

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

An area with float coordinates.

The coordinates of the area are given in half-closed form. That is, minimumX() refers to the minimum inclusive value on the X axis, and maximumX() refers to the maximum exclusive value on the X axis. Likewise for the Y axis.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jregions.core.parameterized.areas.PAreaFType

checkPreconditions

Method Detail

minimumX

public float minimumX()

Specified by:

minimumX in interface PAreaFType<S>

Returns:

The value on the X axis of the minimum edge of the box (inclusive)

maximumX

public float maximumX()

Specified by:

maximumX in interface PAreaFType<S>

Returns:

The value on the X axis of the maximum edge of the box (exclusive)

minimumY

public float minimumY()

Specified by:

minimumY in interface PAreaFType<S>

Returns:

The value on the Y axis of the minimum edge of the box (inclusive)

maximumY

public float maximumY()

Specified by:

maximumY in interface PAreaFType<S>

Returns:

The value on the Y axis of the maximum edge of the box (exclusive)

equals

public boolean equals(Object another)

This instance is equal to all instances of PAreaF 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: minimumX, maximumX, minimumY, maximumY.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value PAreaF with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

width

public float width()

Returns a lazily initialized value of the width attribute. Initialized once and only once and stored for subsequent access with proper synchronization.

Specified by:

width in interface PAreaFType<S>

Returns:

A lazily initialized value of the l.name attribute

height

public float height()

Returns a lazily initialized value of the height attribute. Initialized once and only once and stored for subsequent access with proper synchronization.

Specified by:

height in interface PAreaFType<S>

Returns:

A lazily initialized value of the l.name attribute

of

public static <S> PAreaF<S> of(float minimumX,
                               float maximumX,
                               float minimumY,
                               float maximumY)

Construct a new immutable PAreaF instance.

Parameters:

minimumX - The value for the minimumX attribute

maximumX - The value for the maximumX attribute

minimumY - The value for the minimumY attribute

maximumY - The value for the maximumY attribute

Returns:

An immutable PAreaF instance

builder

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

Creates a builder for PAreaF.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaF builder