Module com.io7m.jranges.core

Package com.io7m.jranges

Class RangeInclusiveL

java.lang.Object

com.io7m.jranges.RangeInclusiveL

All Implemented Interfaces:

RangeInclusiveLType

public final class RangeInclusiveL
extends Object
implements RangeInclusiveLType

An inclusive range with long components.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RangeInclusiveL.Builder	builder()	Creates a builder for RangeInclusiveL.
static RangeInclusiveL	copyOf(RangeInclusiveLType instance)	Creates an immutable copy of a RangeInclusiveLType value.
boolean	equals(Object another)	This instance is equal to all instances of RangeInclusiveL 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 RangeInclusiveL	of(long lower, long upper)	Construct a new immutable RangeInclusiveL instance.
String	toString()	Prints the immutable value RangeInclusiveL with attribute values.
long	upper()
RangeInclusiveL	withLower(long value)	Copy the current immutable object by setting a value for the lower attribute.
RangeInclusiveL	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.jranges.RangeInclusiveLType

checkPreconditions, includesValue, isIncludedIn

Method Detail

lower

public long lower()

Specified by:

lower in interface RangeInclusiveLType

Returns:

The lower bound of the inclusive range.

upper

public long upper()

Specified by:

upper in interface RangeInclusiveLType

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 RangeInclusiveLType

Returns:

The number of values in the range

withLower

public final RangeInclusiveL 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 RangeInclusiveL 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 RangeInclusiveL 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 RangeInclusiveL with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static RangeInclusiveL of(long lower,
                                 long upper)

Construct a new immutable RangeInclusiveL instance.

Parameters:

lower - The value for the lower attribute

upper - The value for the upper attribute

Returns:

An immutable RangeInclusiveL instance

copyOf

public static RangeInclusiveL copyOf(RangeInclusiveLType instance)

Creates an immutable copy of a RangeInclusiveLType 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 RangeInclusiveL instance

builder

public static RangeInclusiveL.Builder builder()

Creates a builder for RangeInclusiveL.

Returns:

A new RangeInclusiveL builder