Module com.io7m.junsigned.ranges

Package com.io7m.junsigned.ranges

Class UnsignedRangeInclusiveI

java.lang.Object

com.io7m.junsigned.ranges.UnsignedRangeInclusiveI

All Implemented Interfaces:

UnsignedRangeInclusiveIType

public final class UnsignedRangeInclusiveI
extends Object
implements UnsignedRangeInclusiveIType

An inclusive range with int components.

Nested Class Summary

Nested Classes

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

Method Summary

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

checkPreconditions, includesValue, isIncludedIn

Method Detail

lower

public int lower()

Specified by:

lower in interface UnsignedRangeInclusiveIType

Returns:

The lower bound of the inclusive range.

upper

public int upper()

Specified by:

upper in interface UnsignedRangeInclusiveIType

Returns:

The upper bound of the inclusive range.

interval

public int interval()

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

Specified by:

interval in interface UnsignedRangeInclusiveIType

Returns:

The number of values in the range

withLower

public final UnsignedRangeInclusiveI withLower(int 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 UnsignedRangeInclusiveI withUpper(int 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 UnsignedRangeInclusiveI 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 UnsignedRangeInclusiveI with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static UnsignedRangeInclusiveI of(int lower,
                                         int upper)

Construct a new immutable UnsignedRangeInclusiveI instance.

Parameters:

lower - The value for the lower attribute

upper - The value for the upper attribute

Returns:

An immutable UnsignedRangeInclusiveI instance

copyOf

public static UnsignedRangeInclusiveI copyOf(UnsignedRangeInclusiveIType instance)

Creates an immutable copy of a UnsignedRangeInclusiveIType 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 UnsignedRangeInclusiveI instance

builder

public static UnsignedRangeInclusiveI.Builder builder()

Creates a builder for UnsignedRangeInclusiveI.

Returns:

A new UnsignedRangeInclusiveI builder