Module com.io7m.jranges.core

Package com.io7m.jranges

Class RangeInclusiveD

java.lang.Object

com.io7m.jranges.RangeInclusiveD

All Implemented Interfaces:

RangeInclusiveDType

public final class RangeInclusiveD
extends Object
implements RangeInclusiveDType

An inclusive range with double components.

Nested Class Summary

Nested Classes

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

Method Summary

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

checkPreconditions, includesValue, isIncludedIn

Method Detail

lower

public double lower()

Specified by:

lower in interface RangeInclusiveDType

Returns:

The lower bound of the inclusive range.

upper

public double upper()

Specified by:

upper in interface RangeInclusiveDType

Returns:

The upper bound of the inclusive range.

interval

public double interval()

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

Specified by:

interval in interface RangeInclusiveDType

Returns:

The number of values in the range

withLower

public final RangeInclusiveD withLower(double value)

Copy the current immutable object by setting a value for the lower attribute. A value strict bits equality 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 RangeInclusiveD withUpper(double value)

Copy the current immutable object by setting a value for the upper attribute. A value strict bits equality 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 RangeInclusiveD 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 RangeInclusiveD with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static RangeInclusiveD of(double lower,
                                 double upper)

Construct a new immutable RangeInclusiveD instance.

Parameters:

lower - The value for the lower attribute

upper - The value for the upper attribute

Returns:

An immutable RangeInclusiveD instance

copyOf

public static RangeInclusiveD copyOf(RangeInclusiveDType instance)

Creates an immutable copy of a RangeInclusiveDType 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 RangeInclusiveD instance

builder

public static RangeInclusiveD.Builder builder()

Creates a builder for RangeInclusiveD.

Returns:

A new RangeInclusiveD builder