com.io7m.jregions.core.parameterized.areas

Class PAreaBD<S>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

PAreaBDType<S>

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

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

Method Summary

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

checkPreconditions

Method Detail

minimumX

public BigDecimal minimumX()

Specified by:

minimumX in interface PAreaBDType<S>

Returns:

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

maximumX

public BigDecimal maximumX()

Specified by:

maximumX in interface PAreaBDType<S>

Returns:

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

minimumY

public BigDecimal minimumY()

Specified by:

minimumY in interface PAreaBDType<S>

Returns:

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

maximumY

public BigDecimal maximumY()

Specified by:

maximumY in interface PAreaBDType<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 PAreaBD 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 PAreaBD with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

width

public BigDecimal 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 PAreaBDType<S>

Returns:

A lazily initialized value of the l.name attribute

height

public BigDecimal 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 PAreaBDType<S>

Returns:

A lazily initialized value of the l.name attribute

of

public static <S> PAreaBD<S> of(BigDecimal minimumX,
                                BigDecimal maximumX,
                                BigDecimal minimumY,
                                BigDecimal maximumY)

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

builder

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

Creates a builder for PAreaBD.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaBD builder