com.io7m.jareas.core

Class AreaInclusiveUnsignedL

java.lang.Object

com.io7m.jareas.core.AreaInclusiveUnsignedL

All Implemented Interfaces:

AreaInclusiveUnsignedLType

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

Immutable implementation of AreaInclusiveUnsignedLType.

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

Method Summary

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

isIncludedIn

Method Detail

getRangeX

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

Specified by:

getRangeX in interface AreaInclusiveUnsignedLType

Returns:

The inclusive range of values on the X axis

getRangeY

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

Specified by:

getRangeY in interface AreaInclusiveUnsignedLType

Returns:

The inclusive range of values on the Y axis

withRangeX

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

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static AreaInclusiveUnsignedL of(com.io7m.junsigned.ranges.UnsignedRangeInclusiveL rangeX,
                                        com.io7m.junsigned.ranges.UnsignedRangeInclusiveL rangeY)

Construct a new immutable AreaInclusiveUnsignedL instance.

Parameters:

rangeX - The value for the rangeX attribute

rangeY - The value for the rangeY attribute

Returns:

An immutable AreaInclusiveUnsignedL instance

copyOf

public static AreaInclusiveUnsignedL copyOf(AreaInclusiveUnsignedLType instance)

Creates an immutable copy of a AreaInclusiveUnsignedLType 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 AreaInclusiveUnsignedL instance