com.io7m.jareas.core

Class AreaInclusiveB

java.lang.Object

com.io7m.jareas.core.AreaInclusiveB

All Implemented Interfaces:

AreaInclusiveBType

@Generated(value={"Immutables.generator","AreaInclusiveBType"})
public final class AreaInclusiveB
extends Object
implements AreaInclusiveBType

Immutable implementation of AreaInclusiveBType.

Use the static factory method to create immutable instances: AreaInclusiveB.of().

Method Summary

Modifier and Type	Method and Description
static AreaInclusiveB	copyOf(AreaInclusiveBType instance) Creates an immutable copy of a AreaInclusiveBType value.
boolean	equals(Object another) This instance is equal to all instances of AreaInclusiveB that have equal attribute values.
com.io7m.jranges.RangeInclusiveB	getRangeX()
com.io7m.jranges.RangeInclusiveB	getRangeY()
int	hashCode() Returns a precomputed-on-construction hash code from attributes: rangeX, rangeY.
static AreaInclusiveB	of(com.io7m.jranges.RangeInclusiveB rangeX, com.io7m.jranges.RangeInclusiveB rangeY) Construct a new immutable AreaInclusiveB instance.
String	toString() Prints the immutable value AreaInclusiveB with attribute values.
AreaInclusiveB	withRangeX(com.io7m.jranges.RangeInclusiveB rangeX) Copy the current immutable object by setting a value for the rangeX attribute.
AreaInclusiveB	withRangeY(com.io7m.jranges.RangeInclusiveB rangeY) Copy the current immutable object by setting a value for the rangeY attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.jareas.core.AreaInclusiveBType

isIncludedIn

Method Detail

getRangeX

public com.io7m.jranges.RangeInclusiveB getRangeX()

Specified by:

getRangeX in interface AreaInclusiveBType

Returns:

The inclusive range of values on the X axis

getRangeY

public com.io7m.jranges.RangeInclusiveB getRangeY()

Specified by:

getRangeY in interface AreaInclusiveBType

Returns:

The inclusive range of values on the Y axis

withRangeX

public final AreaInclusiveB withRangeX(com.io7m.jranges.RangeInclusiveB rangeX)

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

Parameters:

rangeX - A new value for rangeX

Returns:

A modified copy of the this object

withRangeY

public final AreaInclusiveB withRangeY(com.io7m.jranges.RangeInclusiveB rangeY)

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

Parameters:

rangeY - A new value for rangeY

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of AreaInclusiveB that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Returns a precomputed-on-construction hash code from attributes: rangeX, rangeY.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AreaInclusiveB with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static AreaInclusiveB of(com.io7m.jranges.RangeInclusiveB rangeX,
                                com.io7m.jranges.RangeInclusiveB rangeY)

Construct a new immutable AreaInclusiveB instance.

Parameters:

rangeX - The value for the rangeX attribute

rangeY - The value for the rangeY attribute

Returns:

An immutable AreaInclusiveB instance

copyOf

public static AreaInclusiveB copyOf(AreaInclusiveBType instance)

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

Parameters:

instance - The instance to copy

Returns:

A copied immutable AreaInclusiveB instance