com.io7m.jregions.core.parameterized.areas

Class PAreaL<S>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

PAreaLType<S>

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

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

Method Summary

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

checkPreconditions

Method Detail

minimumX

public long minimumX()

Specified by:

minimumX in interface PAreaLType<S>

Returns:

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

maximumX

public long maximumX()

Specified by:

maximumX in interface PAreaLType<S>

Returns:

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

minimumY

public long minimumY()

Specified by:

minimumY in interface PAreaLType<S>

Returns:

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

maximumY

public long maximumY()

Specified by:

maximumY in interface PAreaLType<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 PAreaL 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 PAreaL with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

width

public long 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 PAreaLType<S>

Returns:

A lazily initialized value of the l.name attribute

height

public long 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 PAreaLType<S>

Returns:

A lazily initialized value of the l.name attribute

of

public static <S> PAreaL<S> of(long minimumX,
                               long maximumX,
                               long minimumY,
                               long maximumY)

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

builder

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

Creates a builder for PAreaL.

Type Parameters:

S - generic parameter S

Returns:

A new PAreaL builder