org.unix4j.util

Class Range

java.lang.Object

org.unix4j.util.Range

public class Range
extends Object

Range offers ways of specifying a range of numbers. USAGE:
There are no public constructors in this object. The user should use one of the static factory methods to create a Range.
e.g. The following will create a range of numbers from 1 to 5

Range.between(1,5);

Chaining can be used to specify multiple range "elements"
e.g. The following will create a range of numbers from 1 to 5, and all numbers above 10

Range.between(1,5).andToEndFrom(10);

Field Summary

Fields

Modifier and Type	Field and Description
(package private) CompositeRange	compositeRange

Method Summary

Methods

Modifier and Type	Method and Description
Range	andBetween(int from, int to) Adds a range element to include all indexes between (and including) the given indexes.
Range	andFromStartTo(int to) Adds a range element to include all indexes from 1 to and inclusive of the given index.
Range	andOf(int... indexes)
Range	andToEndFrom(int from) Adds a range element to include all indexes from (and including) the given index to any greater index.
static Range	between(int from, int to) Creates a range element to include all elements between (and including) the given indexes.
static Range	fromStartTo(int to) Creates a range element to include all indexes from 1 to (and inclusive of) the given index.
boolean	isWithinRange(int index)
static Range	of(int... indexes)
static Range	toEndFrom(int from) Creates a range element to include all elements from (and including) the given index to any greater index.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

compositeRange

final CompositeRange compositeRange

Method Detail

isWithinRange

public boolean isWithinRange(int index)

Parameters:

index -

Returns:

whether the given index is within this range

andOf

public Range andOf(int... indexes)

Parameters:

indexes - a list of indexes to include in the range

Returns:

a range object consisting of this range, and all previous range elements in the chain so far.

andFromStartTo

public Range andFromStartTo(int to)

Adds a range element to include all indexes from 1 to and inclusive of the given index.

Parameters:

to -

Returns:

A range object consisting of this range, and all previous range elements in the chain so far.

andToEndFrom

public Range andToEndFrom(int from)

Adds a range element to include all indexes from (and including) the given index to any greater index.

Parameters:

from -

Returns:

A range object consisting of this range, and all previous range elements in the chain so far.

andBetween

public Range andBetween(int from,
               int to)

Adds a range element to include all indexes between (and including) the given indexes.

Parameters:

from -

to -

Returns:

A range object consisting of this range, and all previous range elements in the chain so far.

toString

public String toString()

Overrides:

toString in class Object

of

public static Range of(int... indexes)

Parameters:

indexes - a list of indexes to include in the range

Returns:

A new range object consisting of this range.

fromStartTo

public static Range fromStartTo(int to)

Creates a range element to include all indexes from 1 to (and inclusive of) the given index.

Parameters:

to -

Returns:

A range object consisting of this range, and all previous range elements in the chain so far.

toEndFrom

public static Range toEndFrom(int from)

Creates a range element to include all elements from (and including) the given index to any greater index.

Parameters:

from -

Returns:

A range object consisting of this range.

between

public static Range between(int from,
            int to)

Creates a range element to include all elements between (and including) the given indexes.

Parameters:

from -

to -

Returns:

A new range object consisting of this range.