com.io7m.jregions.core.parameterized.areas

Class PAreaD<S>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

PAreaDType<S>

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

An area with double 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	PAreaD.Builder<S> Builds instances of type PAreaD.

Method Summary

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

checkPreconditions

Method Detail

minimumX

public double minimumX()

Specified by:

minimumX in interface PAreaDType<S>

Returns:

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

maximumX

public double maximumX()

Specified by:

maximumX in interface PAreaDType<S>

Returns:

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

minimumY

public double minimumY()

Specified by:

minimumY in interface PAreaDType<S>

Returns:

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

maximumY

public double maximumY()

Specified by:

maximumY in interface PAreaDType<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 PAreaD 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 PAreaD with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

width

public double 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 PAreaDType<S>

Returns:

A lazily initialized value of the l.name attribute

height

public double 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 PAreaDType<S>

Returns:

A lazily initialized value of the l.name attribute

of

public static <S> PAreaD<S> of(double minimumX,
                               double maximumX,
                               double minimumY,
                               double maximumY)

Construct a new immutable PAreaD 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 PAreaD instance

builder

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

Creates a builder for PAreaD.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaD builder