Module com.io7m.jranges.core

Package com.io7m.jranges

Class RangeInclusiveB

java.lang.Object

com.io7m.jranges.RangeInclusiveB

All Implemented Interfaces:

RangeInclusiveBType

public final class RangeInclusiveB
extends Object
implements RangeInclusiveBType

An inclusive range with BigInteger components.

Nested Class Summary

Nested Classes

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

Method Summary

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

checkPreconditions, includesValue, isIncludedIn

Method Detail

lower

public BigInteger lower()

Specified by:

lower in interface RangeInclusiveBType

Returns:

The lower bound of the inclusive range.

upper

public BigInteger upper()

Specified by:

upper in interface RangeInclusiveBType

Returns:

The upper bound of the inclusive range.

interval

public BigInteger interval()

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

Specified by:

interval in interface RangeInclusiveBType

Returns:

The number of values in the range

withLower

public final RangeInclusiveB withLower(BigInteger value)

Copy the current immutable object by setting a value for the lower attribute. An equals check 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 RangeInclusiveB withUpper(BigInteger value)

Copy the current immutable object by setting a value for the upper attribute. An equals check 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 RangeInclusiveB 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 RangeInclusiveB with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static RangeInclusiveB of(BigInteger lower,
                                 BigInteger upper)

Construct a new immutable RangeInclusiveB instance.

Parameters:

lower - The value for the lower attribute

upper - The value for the upper attribute

Returns:

An immutable RangeInclusiveB instance

copyOf

public static RangeInclusiveB copyOf(RangeInclusiveBType instance)

Creates an immutable copy of a RangeInclusiveBType 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 RangeInclusiveB instance

builder

public static RangeInclusiveB.Builder builder()

Creates a builder for RangeInclusiveB.

Returns:

A new RangeInclusiveB builder