org.omnaest.utils.operation.foreach
Class Range

java.lang.Object
  org.omnaest.utils.operation.foreach.Range

All Implemented Interfaces:

Iterable<Long>

public class Range
extends Object
implements Iterable<Long>

Represents a Range for Long values which can be used as Iterable. The number limits are always included.

Example:

 for ( long counter : new Range( 1, 1000 ) )
 {
   //do something
 }
 

Author:

Omnaest

Constructor Summary

Range(int numberFrom, int numberTo)

Range(long numberFrom, long numberTo)

Range(Long numberFrom, Long numberTo)

Range(Long numberFrom, Long numberTo, Long step)

Range(String rangeExpression)
Allows to specify a Range with a given String expression.

Method Summary

Long	getNumberFrom()
Long	getNumberTo()
Long	getStep()
boolean	isWithinRange(long number) Returns true if the given number is within the Range
Iterator<Long>	iterator()
int[]	toIntArray() Returns an int array with all number between the given ranges

Methods inherited from class java.lang.Object

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

Constructor Detail

Range

public Range(Long numberFrom,
             Long numberTo,
             Long step)

Parameters:

numberFrom -

numberTo -

step -

See Also:

Range

Range

public Range(long numberFrom,
             long numberTo)

Parameters:

numberFrom -

numberTo -

See Also:

Range

Range

public Range(Long numberFrom,
             Long numberTo)

Parameters:

numberFrom -

numberTo -

See Also:

Range

Range

public Range(int numberFrom,
             int numberTo)

Parameters:

numberFrom -

numberTo -

See Also:

Range

Range

public Range(String rangeExpression)

Allows to specify a Range with a given String expression.

The expression format is:

 new Range( "1-5" );
 

Parameters:

rangeExpression -

See Also:

Range

Method Detail

isWithinRange

public boolean isWithinRange(long number)

Returns true if the given number is within the Range

Parameters:

number -

Returns:

iterator

public Iterator<Long> iterator()

Specified by:

iterator in interface Iterable<Long>

getNumberFrom

public Long getNumberFrom()

getNumberTo

public Long getNumberTo()

getStep

public Long getStep()

toIntArray

public int[] toIntArray()

Returns an int array with all number between the given ranges

Returns: