Module com.io7m.junsigned.ranges

Package com.io7m.junsigned.ranges

Class UnsignedRangeInclusiveL

java.lang.Object

com.io7m.junsigned.ranges.UnsignedRangeInclusiveL

All Implemented Interfaces:

UnsignedRangeInclusiveLType

public final class UnsignedRangeInclusiveL
extends Object
implements UnsignedRangeInclusiveLType

An inclusive range with long components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnsignedRangeInclusiveL.Builder	Builds instances of type UnsignedRangeInclusiveL.

Method Summary

Modifier and Type	Method	Description
static UnsignedRangeInclusiveL.Builder	builder()	Creates a builder for UnsignedRangeInclusiveL.
static UnsignedRangeInclusiveL	copyOf(UnsignedRangeInclusiveLType instance)	Creates an immutable copy of a UnsignedRangeInclusiveLType value.
boolean	equals(Object another)	This instance is equal to all instances of UnsignedRangeInclusiveL that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: lower, upper, interval.
long	interval()	Retrieve the number of values in the range [lower, upper].
long	lower()
static UnsignedRangeInclusiveL	of(long lower, long upper)	Construct a new immutable UnsignedRangeInclusiveL instance.
String	toString()	Prints the immutable value UnsignedRangeInclusiveL with attribute values.
long	upper()
UnsignedRangeInclusiveL	withLower(long value)	Copy the current immutable object by setting a value for the lower attribute.
UnsignedRangeInclusiveL	withUpper(long value)	Copy the current immutable object by setting a value for the upper attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.junsigned.ranges.UnsignedRangeInclusiveLType

checkPreconditions, includesValue, isIncludedIn

Method Detail

lower

public long lower()

Specified by:

lower in interface UnsignedRangeInclusiveLType

Returns:

The lower bound of the inclusive range.

upper

public long upper()

Specified by:

upper in interface UnsignedRangeInclusiveLType

Returns:

The upper bound of the inclusive range.

interval

public long interval()

Retrieve the number of values in the range [lower, upper]. That is, (upper - lower) + 1.

Specified by:

interval in interface UnsignedRangeInclusiveLType

Returns:

The number of values in the range

withLower

public final UnsignedRangeInclusiveL withLower(long value)

Copy the current immutable object by setting a value for the lower attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for lower

Returns:

A modified copy of the this object

withUpper

public final UnsignedRangeInclusiveL withUpper(long value)

Copy the current immutable object by setting a value for the upper attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for upper

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of UnsignedRangeInclusiveL that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: lower, upper, interval.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value UnsignedRangeInclusiveL with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static UnsignedRangeInclusiveL of(long lower,
                                         long upper)

Construct a new immutable UnsignedRangeInclusiveL instance.

Parameters:

lower - The value for the lower attribute

upper - The value for the upper attribute

Returns:

An immutable UnsignedRangeInclusiveL instance

copyOf

public static UnsignedRangeInclusiveL copyOf(UnsignedRangeInclusiveLType instance)

Creates an immutable copy of a UnsignedRangeInclusiveLType 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 UnsignedRangeInclusiveL instance

builder

public static UnsignedRangeInclusiveL.Builder builder()

Creates a builder for UnsignedRangeInclusiveL.

Returns:

A new UnsignedRangeInclusiveL builder