com.io7m.jareas.core

Class AreaInclusiveI

java.lang.Object

com.io7m.jareas.core.AreaInclusiveI

All Implemented Interfaces:

AreaInclusiveIType

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

Immutable implementation of AreaInclusiveIType.

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

Method Summary

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

isIncludedIn

Method Detail

getRangeX

public com.io7m.jranges.RangeInclusiveI getRangeX()

Specified by:

getRangeX in interface AreaInclusiveIType

Returns:

The inclusive range of values on the X axis

getRangeY

public com.io7m.jranges.RangeInclusiveI getRangeY()

Specified by:

getRangeY in interface AreaInclusiveIType

Returns:

The inclusive range of values on the Y axis

withRangeX

public final AreaInclusiveI withRangeX(com.io7m.jranges.RangeInclusiveI value)

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:

value - A new value for rangeX

Returns:

A modified copy of the this object

withRangeY

public final AreaInclusiveI withRangeY(com.io7m.jranges.RangeInclusiveI value)

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:

value - 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 AreaInclusiveI 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 AreaInclusiveI... with all non-generated and non-auxiliary attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static AreaInclusiveI of(com.io7m.jranges.RangeInclusiveI rangeX,
                                com.io7m.jranges.RangeInclusiveI rangeY)

Construct a new immutable AreaInclusiveI instance.

Parameters:

rangeX - The value for the rangeX attribute

rangeY - The value for the rangeY attribute

Returns:

An immutable AreaInclusiveI instance

copyOf

public static AreaInclusiveI copyOf(AreaInclusiveIType instance)

Creates an immutable copy of a AreaInclusiveIType 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 AreaInclusiveI instance