Module com.io7m.jregions.core

Package 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>, AreaValuesDType, AreaSizeValuesDType

public final class PAreaD<S>
extends java.lang.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	Description
static class	PAreaD.Builder<S>	Builds instances of type PAreaD.

Method Summary

Modifier and Type	Method	Description
static <S> PAreaD.Builder<S>	builder()	Creates a builder for PAreaD.
boolean	equals(java.lang.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()	Deprecated. Use AreaValuesDType.sizeY()
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.
java.lang.String	toString()	Prints the immutable value PAreaD with attribute values.
double	width()	Deprecated. Use AreaValuesDType.sizeX()

Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaValuesDType

sizeX, sizeY

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 AreaValuesDType

Specified by:

minimumX in interface PAreaDType<S>

Returns:

The value of the minimumX attribute

maximumX

public double maximumX()

Specified by:

maximumX in interface AreaValuesDType

Specified by:

maximumX in interface PAreaDType<S>

Returns:

The value of the maximumX attribute

minimumY

public double minimumY()

Specified by:

minimumY in interface AreaValuesDType

Specified by:

minimumY in interface PAreaDType<S>

Returns:

The value of the minimumY attribute

maximumY

public double maximumY()

Specified by:

maximumY in interface AreaValuesDType

Specified by:

maximumY in interface PAreaDType<S>

Returns:

The value of the maximumY attribute

width

@Deprecated
public double width()

Deprecated. Use AreaValuesDType.sizeX()

Specified by:

width in interface AreaSizeValuesDType

Returns:

The width of the area

height

@Deprecated
public double height()

Deprecated. Use AreaValuesDType.sizeY()

Specified by:

height in interface AreaSizeValuesDType

Returns:

The height of the area

equals

public boolean equals(java.lang.Object another)

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

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value PAreaD with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

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