com.io7m.jboxes.core

Class BoxHorizontalSplit<S>

java.lang.Object

com.io7m.jboxes.core.BoxHorizontalSplit<S>

All Implemented Interfaces:

BoxHorizontalSplitType<S>

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

Immutable implementation of BoxHorizontalSplitType.

Use the builder to create immutable instances: BoxHorizontalSplit.<S>builder(). Use the static factory method to create immutable instances: BoxHorizontalSplit.<S>of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxHorizontalSplit.Builder<S> Builds instances of type BoxHorizontalSplit.

Method Summary

Modifier and Type	Method and Description
static <S> BoxHorizontalSplit.Builder<S>	builder() Creates a builder for BoxHorizontalSplit.
static <S> BoxHorizontalSplit<S>	copyOf(BoxHorizontalSplitType<S> instance) Creates an immutable copy of a BoxHorizontalSplitType value.
boolean	equals(Object another) This instance is equal to all instances of BoxHorizontalSplit that have equal attribute values.
int	hashCode() Computes a hash code from attributes: upper, lower.
BoxType<S>	lower()
static <S> BoxHorizontalSplit<S>	of(BoxType<S> upper, BoxType<S> lower) Construct a new immutable BoxHorizontalSplit instance.
String	toString() Prints the immutable value BoxHorizontalSplit with attribute values.
BoxType<S>	upper()
BoxHorizontalSplit<S>	withLower(BoxType<S> lower) Copy the current immutable object by setting a value for the lower attribute.
BoxHorizontalSplit<S>	withUpper(BoxType<S> upper) Copy the current immutable object by setting a value for the upper attribute.

Methods inherited from class java.lang.Object

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

Method Detail

upper

public BoxType<S> upper()

Specified by:

upper in interface BoxHorizontalSplitType<S>

Returns:

The upper half

lower

public BoxType<S> lower()

Specified by:

lower in interface BoxHorizontalSplitType<S>

Returns:

The lower half

withUpper

public final BoxHorizontalSplit<S> withUpper(BoxType<S> upper)

Copy the current immutable object by setting a value for the upper attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

upper - A new value for upper

Returns:

A modified copy of the this object

withLower

public final BoxHorizontalSplit<S> withLower(BoxType<S> lower)

Copy the current immutable object by setting a value for the lower attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

lower - A new value for lower

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BoxHorizontalSplit with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <S> BoxHorizontalSplit<S> of(BoxType<S> upper,
                                           BoxType<S> lower)

Construct a new immutable BoxHorizontalSplit instance.

Parameters:

upper - The value for the upper attribute

lower - The value for the lower attribute

Returns:

An immutable BoxHorizontalSplit instance

copyOf

public static <S> BoxHorizontalSplit<S> copyOf(BoxHorizontalSplitType<S> instance)

Creates an immutable copy of a BoxHorizontalSplitType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

S - generic parameter S

Parameters:

instance - The instance to copy

Returns:

A copied immutable BoxHorizontalSplit instance

builder

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

Creates a builder for BoxHorizontalSplit.

Type Parameters:

S - generic parameter S

Returns:

A new BoxHorizontalSplit builder