org.incava.ijdk.lang

Class Range

java.lang.Object

org.incava.ijdk.lang.Range

All Implemented Interfaces:

java.lang.Comparable<Range>, java.lang.Iterable<java.lang.Integer>

public class Range
extends java.lang.Object
implements java.lang.Comparable<Range>, java.lang.Iterable<java.lang.Integer>

A range of integers, inclusive. Supports iteration and array expansion.

Constructor Summary

Constructors

Constructor and Description
Range(java.lang.Integer first, java.lang.Integer last) Creates a range of first through last (i.e., inclusive).

Method Summary

Modifier and Type	Method and Description
int	compareTo(Range other) Compares this range to the other.
boolean	equals(java.lang.Object obj) Returns whether this range equals the other.
java.lang.Integer	first()
java.lang.Integer	getFirst()
java.lang.Integer	getLast() Returns the last number of the range.
int	hashCode() Returns the hashCode for this range.
boolean	includes(java.lang.Integer n) Returns whether the given number is within the range, or is either the first or last value.
java.util.Iterator<java.lang.Integer>	iterator() Returns an iterator for the range.
java.lang.Integer	last() Returns the last number of the range.
Array<java.lang.Integer>	toArray() Returns the range as a list of elements for each number within the range.
java.lang.String	toString() Returns the range as a string.
java.lang.Iterable<java.lang.Integer>	upTo() Returns an iterator for the range, inclusive of the first value, but exclusive of the last one.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Range

public Range(java.lang.Integer first,
             java.lang.Integer last)

Creates a range of first through last (i.e., inclusive). First can be less than, equal to, or greater than, last.

Method Detail

iterator

public java.util.Iterator<java.lang.Integer> iterator()

Returns an iterator for the range. Usage:

  Range rg = new Range(11, 14);
  for (Integer i : rg) { // block called with 11, 12, 13, 14
  }
 

A range is iterated over only if first <= last.

Specified by:

iterator in interface java.lang.Iterable<java.lang.Integer>

upTo

public java.lang.Iterable<java.lang.Integer> upTo()

Returns an iterator for the range, inclusive of the first value, but exclusive of the last one. Will not execute if first <= last - 1. Usage:

  Range rg = new Range(11, 14);
  for (Integer i : rg.upTo()) { // block called with 11, 12, 13
  }
 

A range is iterated over only if first <= last.

getFirst

public java.lang.Integer getFirst()

first

public java.lang.Integer first()

getLast

public java.lang.Integer getLast()

Returns the last number of the range.

last

public java.lang.Integer last()

Returns the last number of the range.

includes

public boolean includes(java.lang.Integer n)

Returns whether the given number is within the range, or is either the first or last value.

toArray

public Array<java.lang.Integer> toArray()

Returns the range as a list of elements for each number within the range. For example:

  Range rg = new Range(3, 7);
  List<Integer> ary = rg.toExpandedList(); // ary == [ 3, 4, 5, 6, 7 ]
 

equals

public boolean equals(java.lang.Object obj)

Returns whether this range equals the other.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns the hashCode for this range.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

toString

public java.lang.String toString()

Returns the range as a string.

Overrides:

toString in class java.lang.Object

Returns:

a string

compareTo

public int compareTo(Range other)

Compares this range to the other. A range is less than another range if either the first or last elements are less than the other's. A range is greater than another range if either the first or last element are greater than the other's.

Specified by:

compareTo in interface java.lang.Comparable<Range>