com.io7m.jareas.core

Class AreaInclusiveUnsignedI

java.lang.Object

com.io7m.jareas.core.AreaInclusiveUnsignedI

All Implemented Interfaces:

AreaInclusiveUnsignedIType

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

Immutable implementation of AreaInclusiveUnsignedIType.

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

Method Summary

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

isIncludedIn

Method Detail

getRangeX

public com.io7m.junsigned.ranges.UnsignedRangeInclusiveI getRangeX()

Specified by:

getRangeX in interface AreaInclusiveUnsignedIType

Returns:

The inclusive range of values on the X axis

getRangeY

public com.io7m.junsigned.ranges.UnsignedRangeInclusiveI getRangeY()

Specified by:

getRangeY in interface AreaInclusiveUnsignedIType

Returns:

The inclusive range of values on the Y axis

withRangeX

public final AreaInclusiveUnsignedI withRangeX(com.io7m.junsigned.ranges.UnsignedRangeInclusiveI 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 AreaInclusiveUnsignedI withRangeY(com.io7m.junsigned.ranges.UnsignedRangeInclusiveI 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 AreaInclusiveUnsignedI 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 AreaInclusiveUnsignedI with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static AreaInclusiveUnsignedI of(com.io7m.junsigned.ranges.UnsignedRangeInclusiveI rangeX,
                                        com.io7m.junsigned.ranges.UnsignedRangeInclusiveI rangeY)

Construct a new immutable AreaInclusiveUnsignedI instance.

Parameters:

rangeX - The value for the rangeX attribute

rangeY - The value for the rangeY attribute

Returns:

An immutable AreaInclusiveUnsignedI instance

copyOf

public static AreaInclusiveUnsignedI copyOf(AreaInclusiveUnsignedIType instance)

Creates an immutable copy of a AreaInclusiveUnsignedIType 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 AreaInclusiveUnsignedI instance