com.io7m.jareas.core

Class AreaInclusiveL

java.lang.Object

com.io7m.jareas.core.AreaInclusiveL

All Implemented Interfaces:

AreaInclusiveLType

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

Immutable implementation of AreaInclusiveLType.

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

Method Summary

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

isIncludedIn

Method Detail

getRangeX

public com.io7m.jranges.RangeInclusiveL getRangeX()

Specified by:

getRangeX in interface AreaInclusiveLType

Returns:

The inclusive range of values on the X axis

getRangeY

public com.io7m.jranges.RangeInclusiveL getRangeY()

Specified by:

getRangeY in interface AreaInclusiveLType

Returns:

The inclusive range of values on the Y axis

withRangeX

public final AreaInclusiveL withRangeX(com.io7m.jranges.RangeInclusiveL 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 AreaInclusiveL withRangeY(com.io7m.jranges.RangeInclusiveL 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 AreaInclusiveL 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 AreaInclusiveL with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static AreaInclusiveL of(com.io7m.jranges.RangeInclusiveL rangeX,
                                com.io7m.jranges.RangeInclusiveL rangeY)

Construct a new immutable AreaInclusiveL instance.

Parameters:

rangeX - The value for the rangeX attribute

rangeY - The value for the rangeY attribute

Returns:

An immutable AreaInclusiveL instance

copyOf

public static AreaInclusiveL copyOf(AreaInclusiveLType instance)

Creates an immutable copy of a AreaInclusiveLType 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 AreaInclusiveL instance