Range (rangefun 1.2.0 API)

java.lang.Object
- xyz.jmburns.rangefun.Range

```
public class Range
extends java.lang.Object
```
This class has no function on its own, but, along with RangeBuilder, serves as the public API for the Range Fun(ctions) library, and is intended to be used in most cases where ranges are created.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static RangeBuilder`	`of(int start)` Returns a new `RangeBuilder` with a 'from' value of `start`, and a default step of 1.
`static java.lang.Iterable<java.lang.Integer>`	`of(int start, int end)` Returns a new `Iterable<Integer>` set to provide a range for the given `start` and `end` values, with a default `step` value of 1.
`static java.lang.Iterable<java.lang.Integer>`	`of(int start, int end, int step)` Returns a new `Iterable<Integer>` set to provide a range for the given values.
`static RangeBuilder`	`of(java.lang.Object array)` Returns a new `RangeBuilder` set to build a range over the length of the array.
`static java.lang.Iterable<java.lang.Integer>`	`range(int start)` Returns a new `RangeBuilder` with a 'from' value of `start`, and a default step of 1.
`static java.lang.Iterable<java.lang.Integer>`	`range(int start, int end)` Returns a new `Iterable<Integer>` set to provide a range for the given `start` and `end` values, with a default `step` value of 1.
`static java.lang.Iterable<java.lang.Integer>`	`range(int start, int end, int step)` Returns a new `Iterable<Integer>` set to provide a range for the given values.
`static RangeBuilder`	`range(java.lang.Object array)` Returns a new `RangeBuilder` set to build a range over the length of the array.
`static RangeBuilder`	`to(int end)` Returns a new `RangeBuilder` with a 'to' value of `end`, a default 'from' value of 1, and a default step of 1.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - of
```
public static java.lang.Iterable<java.lang.Integer> of(int start,
                                                       int end,
                                                       int step)
```
    Returns a new Iterable<Integer> set to provide a range for the given values. Note that if intending to get a descending range (where start is greater than end), the value of step need not be negative.
    
    Parameters:
    
    start - The beginning of the range, the first Integer to be returned by the Iterable's Iterator.
    
    end - The end of the range. This value may or may not be returned by the Iterable's Iterator (depending on the chosen step value), but it is guaranteed to never go beyond this value.
    
    step - The value by which the value returned by the Iterable's Iterator will change upon each successive call to next().
    
    Returns:
    
    A new Iterable<Integer> set to provide a range for the given values.
  - of
```
public static java.lang.Iterable<java.lang.Integer> of(int start,
                                                       int end)
```
    Returns a new Iterable<Integer> set to provide a range for the given start and end values, with a default step value of 1.
    
    Parameters:
    
    start - The beginning of the range, the first Integer to be returned by the Iterable's Iterator.
    
    end - The end of the range. Since a default step value of one is used, this value is guaranteed to be returned by the Iterable's Iterator.
    
    Returns:
    
    A new Iterable<Integer> set to provide a range for the given values.
    
    See Also:
    
    of(int, int, int)
  - of
```
public static RangeBuilder of(int start)
```
    Returns a new RangeBuilder with a 'from' value of start, and a default step of 1. This method is intended to serve as a natural entry point into the 'fluent' API provided by RangeBuilder.
    
    Parameters:
    
    start - The supposed beginning of the range, passed to RangeBuilder. Can be overwritten at a later time through the RangeBuilder object.
    
    Returns:
    
    A new RangeBuilder with a 'from' value of start and a default step of 1.
    
    See Also:
    
    RangeBuilder
  - of
```
public static RangeBuilder of(java.lang.Object array)
```
    Returns a new RangeBuilder set to build a range over the length of the array.
    
    Parameters:
    
    array - The array from which to derive bounds for the returned RangeBuilder. Note that this object MUST be an array, or an IllegalArgumentException will be thrown.
    
    Returns:
    
    A new RangeBuilder set to build a range over the length of the array.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the passed argument is not an array.
    
    Implementation Note:
    
    This method behaves exactly as if chaining Range.of(0).to(array.length - 1).step(1) and is intended to serve as a convenience method. Also, it returns a RangeBuilder to facilitate easy backwards iteration of the array.
  - to
```
public static RangeBuilder to(int end)
```
    Returns a new RangeBuilder with a 'to' value of end, a default 'from' value of 1, and a default step of 1. This method is intended to serve as a natural entry point into the 'fluent' API provided by RangeBuilder.
    
    Parameters:
    
    end - The supposed end of the range, passed to RangeBuilder. Can be overwritten at a later time through the RangeBuilder object.
    
    Returns:
    
    A new RangeBuilder with a 'to' value of end, a default 'from' value of 1, and a default step of 1.
    
    See Also:
    
    RangeBuilder
  - range
```
public static java.lang.Iterable<java.lang.Integer> range(int start,
                                                          int end,
                                                          int step)
```
    Returns a new Iterable<Integer> set to provide a range for the given values. Note that if intending to get a descending range (where start is greater than end), the value of step need not be negative.
    
    Parameters:
    
    start - The beginning of the range, the first Integer to be returned by the Iterable's Iterator.
    
    end - The end of the range. This value may or may not be returned by the Iterable's Iterator (depending on the chosen step value), but it is guaranteed to never go beyond this value.
    
    step - The value by which the value returned by the Iterable's Iterator will change upon each successive call to next().
    
    Returns:
    
    A new Iterable<Integer> set to provide a range for the given values.
    
    See Also:
    
    of(int, int, int)
    
    Implementation Note:
    
    This method behaves exactly as if calling Range.of(start, end, step) and us intended to serve as a convenience method to preserve readability when Range is statically imported.
  - range
```
public static java.lang.Iterable<java.lang.Integer> range(int start,
                                                          int end)
```
    Returns a new Iterable<Integer> set to provide a range for the given start and end values, with a default step value of 1.
    
    Parameters:
    
    start - The beginning of the range, the first Integer to be returned by the Iterable's Iterator.
    
    end - The end of the range. Since a default step value of one is used, this value is guaranteed to be returned by the Iterable's Iterator.
    
    Returns:
    
    A new Iterable<Integer> set to provide a range for the given values.
    
    See Also:
    
    of(int, int, int), of(int, int)
    
    Implementation Note:
    
    This method behaves exactly as if calling Range.of(start, end) and us intended to serve as a convenience method to preserve readability when Range is statically imported.
  - range
```
public static java.lang.Iterable<java.lang.Integer> range(int start)
```
    Returns a new RangeBuilder with a 'from' value of start, and a default step of 1. This method is intended to serve as a natural entry point into the 'fluent' API provided by RangeBuilder.
    
    Parameters:
    
    start - The supposed beginning of the range, passed to RangeBuilder. Can be overwritten at a later time through the RangeBuilder object.
    
    Returns:
    
    A new RangeBuilder with a 'from' value of start and a default step of 1.
    
    See Also:
    
    RangeBuilder, of(int)
    
    Implementation Note:
    
    This method behaves exactly as if calling Range.of(start) and us intended to serve as a convenience method to preserve readability when Range is statically imported.
  - range
```
public static RangeBuilder range(java.lang.Object array)
```
    Returns a new RangeBuilder set to build a range over the length of the array.
    
    Parameters:
    
    array - The array from which to derive bounds for the returned RangeBuilder. Note that this object MUST be an array, or an IllegalArgumentException will be thrown.
    
    Returns:
    
    A new RangeBuilder set to build a range over the length of the array.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the passed argument is not an array.
    
    Implementation Note:
    
    This method behaves exactly as if chaining Range.of(0).to(array.length - 1).step(1) and is intended to serve as a convenience method. Also, it returns a RangeBuilder to facilitate easy backwards iteration of the array., This method also behaves exactly as if calling Range.of(array) and us intended to serve as a convenience method to preserve readability when Range is statically imported.

Class Range

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

of

of

to

range

range

range

range