Package gw.lang.reflect.interval

Class IterableInterval<E extends java.lang.Comparable<E>,S,U,ME extends IterableInterval<E,S,U,ME>>

java.lang.Object

gw.lang.reflect.interval.AbstractInterval<E,ME>

gw.lang.reflect.interval.IterableInterval<E,S,U,ME>

All Implemented Interfaces:

IInterval<E,ME>, IIterableInterval<E,S,U,ME>, java.lang.Iterable<E>

Direct Known Subclasses:

DateInterval, NumberInterval, SequenceableInterval

public abstract class IterableInterval<E extends java.lang.Comparable<E>,S,U,ME extends IterableInterval<E,S,U,ME>>
extends AbstractInterval<E,ME>
implements IIterableInterval<E,S,U,ME>

Field Summary

Fields

Modifier and Type	Field	Description
private S	_step
private U	_unit

Constructor Summary

Constructors

Constructor	Description
IterableInterval(E left, E right, S step)
IterableInterval(E left, E right, S step, U unit, boolean bLeftClosed, boolean bRightClosed, boolean bReverse)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
S	getStep()
U	getUnit()
int	hashCode()
java.util.Iterator<E>	iterator()
ME	step(S s)
java.lang.String	toString()
ME	unit(U u)

Methods inherited from class gw.lang.reflect.interval.AbstractInterval

contains, contains, getLeftEndpoint, getRightEndpoint, isLeftClosed, isReverse, isRightClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface gw.lang.reflect.interval.IInterval

contains, contains, getLeftEndpoint, getRightEndpoint, isLeftClosed, isReverse, isRightClosed

Methods inherited from interface gw.lang.reflect.interval.IIterableInterval

getFromLeft, getFromRight, iterateFromLeft, iterateFromRight

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

_step

private S _step

_unit

private U _unit

Constructor Detail

IterableInterval

public IterableInterval(E left,
                        E right,
                        S step)

IterableInterval

public IterableInterval(E left,
                        E right,
                        S step,
                        U unit,
                        boolean bLeftClosed,
                        boolean bRightClosed,
                        boolean bReverse)

Method Detail

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface IIterableInterval<E extends java.lang.Comparable<E>,S,U,ME extends IterableInterval<E,S,U,ME>>

Specified by:

iterator in interface java.lang.Iterable<E extends java.lang.Comparable<E>>

Returns:

An iterator that visits the elements in this interval in order, from left to right. Returns null if this interval does not support iteration.

See Also:

IIterableInterval.iterateFromLeft(), IIterableInterval.iterateFromRight()

getStep

public S getStep()

Specified by:

getStep in interface IIterableInterval<E extends java.lang.Comparable<E>,S,U,ME extends IterableInterval<E,S,U,ME>>

Returns:

The step (or increment) by which this interval visits elements in its set. Returns null if this interval cannot iterate its elements.

For instance, if the interval is a set of decimal values, say [1..10], the step might be a decimal increment, say 0.25. Similarly, if the interval is simply a set of integers the step might also be an integer value, typically 1. Considering a date interval, say [4/5/10..5/20/10], the step could be expressed in terms of a unit of time e.g., 10 seconds, 1 minute, 2 weeks, etc.

Note if non-null, the step is a positive (or absolute) increment. To iterate the interval in reverse order use iterateFromRight().

step

public ME step(S s)

Specified by:

step in interface IIterableInterval<E extends java.lang.Comparable<E>,S,U,ME extends IterableInterval<E,S,U,ME>>

getUnit

public U getUnit()

Specified by:

getUnit in interface IIterableInterval<E extends java.lang.Comparable<E>,S,U,ME extends IterableInterval<E,S,U,ME>>

unit

public ME unit(U u)

Specified by:

unit in interface IIterableInterval<E extends java.lang.Comparable<E>,S,U,ME extends IterableInterval<E,S,U,ME>>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractInterval<E extends java.lang.Comparable<E>,ME extends IterableInterval<E,S,U,ME>>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractInterval<E extends java.lang.Comparable<E>,ME extends IterableInterval<E,S,U,ME>>

toString

public java.lang.String toString()

Overrides:

toString in class AbstractInterval<E extends java.lang.Comparable<E>,ME extends IterableInterval<E,S,U,ME>>