xyz.jmburns.rangefun

Class RangeBuilder

java.lang.Object

xyz.jmburns.rangefun.RangeBuilder

All Implemented Interfaces:

java.lang.Iterable<java.lang.Integer>

public class RangeBuilder
extends java.lang.Object
implements java.lang.Iterable<java.lang.Integer>

The other half of the public API, this class provides a 'fluent' way to create and customise ranges.

Constructor Summary

Constructors

Constructor and Description
RangeBuilder() Creates a new RangeBuilder with 'from', 'to', and 'step' value of 0.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.lang.Integer>	build() Builds the range, whose Iterator will generate Integer values as set by calls to RangeBuilder's methods.
boolean	equals(java.lang.Object o)
RangeBuilder	from(int start) Sets the beginning of the range to be built.
int	hashCode()
java.util.PrimitiveIterator.OfInt	iterator() Returns an Iterator for a range built using the current values set for this RangeBuilder.
RangeBuilder	reverse() Reverses the range to be built, so that its Iterator will iterate from the given 'to' value, to the given 'from' value.
RangeBuilder	step(int step) Sets the 'step' of the range to be built.
RangeBuilder	to(int end) Sets the end of the range to be built.
java.lang.String	toString()
RangeBuilder	until(int end) Sets the end of the half-closed range to be built.

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

RangeBuilder

public RangeBuilder()

Creates a new RangeBuilder with 'from', 'to', and 'step' value of 0.

Method Detail

from

public RangeBuilder from(int start)

Sets the beginning of the range to be built.

Parameters:

start - The beginning of the range to be built, and the first Integer to be returned by the built range's Iterator.

Returns:

The same RangeBuilder object on which this method was called.

to

public RangeBuilder to(int end)

Sets the end of the range to be built.

Parameters:

end - The end of the range. This value may or may not be returned by the built range's Iterator (depending on the chosen 'step' value), but it is guaranteed to never go beyond this value.

Returns:

The same RangeBuilder object on which this method was called.

until

public RangeBuilder until(int end)

Sets the end of the half-closed range to be built. The given value will NOT be returned by the built range's Iterator.

Parameters:

end - The end of the range. This value will not be returned by the built range's Iterator.

Returns:

The same RangeBuilder object on which this method was called.

Since:

1.2.0

step

public RangeBuilder step(int step)

Sets the 'step' of the range to be built. Note that if intending to build a descending range (where the 'from' value is greater than the 'to' value), the value of step need not be negative, and a negative or positive step will have no impact on the function of the range, either way.

Parameters:

step - The value by which the value returned by the Iterable's Iterator will change upon each successive call to next().

Returns:

The same RangeBuilder object on which this method was called.

reverse

public RangeBuilder reverse()

Reverses the range to be built, so that its Iterator will iterate from the given 'to' value, to the given 'from' value.

Returns:

The same RangeBuilder object on which this method was called.

Implementation Note:

Successive calls to reverse() will cancel each other out, so calling rangeBuilder.reverse().reverse() will be the same as never calling it, and calling rangeBuilder.reverse().reverse().reverse() will be the same as only calling it once, and so on.

build

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

Builds the range, whose Iterator will generate Integer values as set by calls to RangeBuilder's methods. Be aware that there is no functionality in place to ensure that the 'step' value is not 0, and, if it is, the built range's Iterator might iterate indefinitely.

Returns:

A new Iterable<Integer>, whose Iterator will generate Integer values as set by calls to RangeBuilder's methods.

iterator

public java.util.PrimitiveIterator.OfInt iterator()

Returns an Iterator for a range built using the current values set for this RangeBuilder.

Specified by:

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

Returns:

A new Iterator for a range built using the current values set for this RangeBuilder.

Implementation Note:

This method behaves exactly as if calling build().iterator() on this RangeBuilder, and is included for convenience, when storing the built range is not important. Be aware that there is no functionality in place to ensure that the 'step' value is not 0, and, if it is, the built range's Iterator might iterate indefinitely.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object