com.io7m.jareas.core

Class AreaInclusiveD

java.lang.Object

com.io7m.jareas.core.AreaInclusiveD

All Implemented Interfaces:

AreaInclusiveDType

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

Immutable implementation of AreaInclusiveDType.

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

Method Summary

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

isIncludedIn

Method Detail

getRangeX

public com.io7m.jranges.RangeInclusiveD getRangeX()

Specified by:

getRangeX in interface AreaInclusiveDType

Returns:

The inclusive range of values on the X axis

getRangeY

public com.io7m.jranges.RangeInclusiveD getRangeY()

Specified by:

getRangeY in interface AreaInclusiveDType

Returns:

The inclusive range of values on the Y axis

withRangeX

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

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static AreaInclusiveD of(com.io7m.jranges.RangeInclusiveD rangeX,
                                com.io7m.jranges.RangeInclusiveD rangeY)

Construct a new immutable AreaInclusiveD instance.

Parameters:

rangeX - The value for the rangeX attribute

rangeY - The value for the rangeY attribute

Returns:

An immutable AreaInclusiveD instance

copyOf

public static AreaInclusiveD copyOf(AreaInclusiveDType instance)

Creates an immutable copy of a AreaInclusiveDType 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 AreaInclusiveD instance