com.io7m.jboxes.core

Class BoxVerticalSplit<S>

java.lang.Object

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

All Implemented Interfaces:

BoxVerticalSplitType<S>

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

Immutable implementation of BoxVerticalSplitType.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

left

public BoxType<S> left()

Specified by:

left in interface BoxVerticalSplitType<S>

Returns:

The left half

right

public BoxType<S> right()

Specified by:

right in interface BoxVerticalSplitType<S>

Returns:

The right half

withLeft

public final BoxVerticalSplit<S> withLeft(BoxType<S> left)

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

Parameters:

left - A new value for left

Returns:

A modified copy of the this object

withRight

public final BoxVerticalSplit<S> withRight(BoxType<S> right)

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

Parameters:

right - A new value for right

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of BoxVerticalSplit 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: left, right.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BoxVerticalSplit with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <S> BoxVerticalSplit<S> of(BoxType<S> left,
                                         BoxType<S> right)

Construct a new immutable BoxVerticalSplit instance.

Parameters:

left - The value for the left attribute

right - The value for the right attribute

Returns:

An immutable BoxVerticalSplit instance

copyOf

public static <S> BoxVerticalSplit<S> copyOf(BoxVerticalSplitType<S> instance)

Creates an immutable copy of a BoxVerticalSplitType 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 BoxVerticalSplit instance

builder

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

Creates a builder for BoxVerticalSplit.

Type Parameters:

S - generic parameter S

Returns:

A new BoxVerticalSplit builder