com.io7m.jboxes.core

Class Box<S>

java.lang.Object

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

All Implemented Interfaces:

BoxType<S>

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

Immutable implementation of BoxType.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jboxes.core.BoxType

checkPreconditions, height, width

Method Detail

minimumX

public int minimumX()

Specified by:

minimumX in interface BoxType<S>

Returns:

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

maximumX

public int maximumX()

Specified by:

maximumX in interface BoxType<S>

Returns:

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

minimumY

public int minimumY()

Specified by:

minimumY in interface BoxType<S>

Returns:

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

maximumY

public int maximumY()

Specified by:

maximumY in interface BoxType<S>

Returns:

The value on the Y axis of the bottom edge of the box (exclusive)

withMinimumX

public final Box<S> withMinimumX(int minimumX)

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

Parameters:

minimumX - A new value for minimumX

Returns:

A modified copy of the this object

withMaximumX

public final Box<S> withMaximumX(int maximumX)

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

Parameters:

maximumX - A new value for maximumX

Returns:

A modified copy of the this object

withMinimumY

public final Box<S> withMinimumY(int minimumY)

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

Parameters:

minimumY - A new value for minimumY

Returns:

A modified copy of the this object

withMaximumY

public final Box<S> withMaximumY(int maximumY)

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

Parameters:

maximumY - A new value for maximumY

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

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

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <S> Box<S> of(int minimumX,
                            int maximumX,
                            int minimumY,
                            int maximumY)

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

copyOf

public static <S> Box<S> copyOf(BoxType<S> instance)

Creates an immutable copy of a BoxType 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 Box instance

builder

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

Creates a builder for Box.

Type Parameters:

S - generic parameter S

Returns:

A new Box builder