com.io7m.jregions.core.unparameterized.areas

Class AreaBD

java.lang.Object

com.io7m.jregions.core.unparameterized.areas.AreaBD

All Implemented Interfaces:

AreaBDType, AreaValuesBDType, AreaSizeValuesBDType

@Generated(value={"Immutables.generator","AreaBDType"})
public final class AreaBD
extends Object
implements AreaBDType

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	AreaBD.Builder Builds instances of type AreaBD.

Method Summary

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

Methods inherited from class java.lang.Object

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

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

checkPreconditions

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

sizeX, sizeY

Method Detail

minimumX

public BigDecimal minimumX()

Specified by:

minimumX in interface AreaBDType

Specified by:

minimumX in interface AreaValuesBDType

Returns:

The value of the minimumX attribute

maximumX

public BigDecimal maximumX()

Specified by:

maximumX in interface AreaBDType

Specified by:

maximumX in interface AreaValuesBDType

Returns:

The value of the maximumX attribute

minimumY

public BigDecimal minimumY()

Specified by:

minimumY in interface AreaBDType

Specified by:

minimumY in interface AreaValuesBDType

Returns:

The value of the minimumY attribute

maximumY

public BigDecimal maximumY()

Specified by:

maximumY in interface AreaBDType

Specified by:

maximumY in interface AreaValuesBDType

Returns:

The value of the maximumY attribute

width

@Deprecated
public BigDecimal width()

Deprecated. Use AreaValuesBDType.sizeX()

Specified by:

width in interface AreaSizeValuesBDType

Returns:

The width of the area

height

@Deprecated
public BigDecimal height()

Deprecated. Use AreaValuesBDType.sizeY()

Specified by:

height in interface AreaSizeValuesBDType

Returns:

The height of the area

equals

public boolean equals(Object another)

This instance is equal to all instances of AreaBD 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 AreaBD with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static AreaBD of(BigDecimal minimumX,
                        BigDecimal maximumX,
                        BigDecimal minimumY,
                        BigDecimal maximumY)

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

builder

public static AreaBD.Builder builder()

Creates a builder for AreaBD.

Returns:

A new AreaBD builder