Module com.io7m.jregions.core

Package com.io7m.jregions.core.parameterized.areas

Class PAreaYSplitBD<S,T extends PAreaBDType<S>>

java.lang.Object

com.io7m.jregions.core.parameterized.areas.PAreaYSplitBD<S,T>

Type Parameters:

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

T - The precise type of area

All Implemented Interfaces:

PAreaYSplitBDType<S,T>

public final class PAreaYSplitBD<S,T extends PAreaBDType<S>>
extends java.lang.Object
implements PAreaYSplitBDType<S,T>

An area that has been split via the Y axis.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PAreaYSplitBD.Builder<S,T extends PAreaBDType<S>>	Builds instances of type PAreaYSplitBD.

Method Summary

Modifier and Type	Method	Description
static <S,T extends PAreaBDType<S>> PAreaYSplitBD.Builder<S,T>	builder()	Creates a builder for PAreaYSplitBD.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of PAreaYSplitBD that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: lower, upper.
T	lower()
static <S,T extends PAreaBDType<S>> PAreaYSplitBD<S,T>	of(T lower, T upper)	Construct a new immutable PAreaYSplitBD instance.
java.lang.String	toString()	Prints the immutable value PAreaYSplitBD with attribute values.
T	upper()

Methods inherited from class java.lang.Object

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

Method Detail

lower

public T lower()

Specified by:

lower in interface PAreaYSplitBDType<S,T extends PAreaBDType<S>>

Returns:

The lower half

upper

public T upper()

Specified by:

upper in interface PAreaYSplitBDType<S,T extends PAreaBDType<S>>

Returns:

The upper half

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of PAreaYSplitBD 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: lower, upper.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value PAreaYSplitBD with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S,T extends PAreaBDType<S>> PAreaYSplitBD<S,T> of(T lower,
                                                                 T upper)

Construct a new immutable PAreaYSplitBD instance.

Parameters:

lower - The value for the lower attribute

upper - The value for the upper attribute

Returns:

An immutable PAreaYSplitBD instance

builder

public static <S,T extends PAreaBDType<S>> PAreaYSplitBD.Builder<S,T> builder()

Creates a builder for PAreaYSplitBD.

Type Parameters:

S - generic parameter S

T - generic parameter T

Returns:

A new PAreaYSplitBD builder