Ranges (Apache Commons Functor 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.functor.range.Ranges

```
public final class Ranges
extends Object
```
Range factory.

Since:

1.0

Version:

$Revision$ $Date$

Method Summary

Methods
Modifier and Type	Method and Description
`static CharacterRange`	`characterRange(char from, BoundType leftBoundType, char to, BoundType rightBoundType)` Create a new CharacterRange.
`static CharacterRange`	`characterRange(char from, BoundType leftBoundType, char to, BoundType rightBoundType, int step)` Create a new CharacterRange.
`static CharacterRange`	`characterRange(char from, char to)` Create a new CharacterRange.
`static CharacterRange`	`characterRange(char from, char to, int step)` Create a new CharacterRange.
`static CharacterRange`	`characterRange(Endpoint<Character> leftEndpoint, Endpoint<Character> rightEndpoint, int step)` Create a new CharacterRange.
`static DoubleRange`	`doubleRange(double from, BoundType leftBoundType, double to, BoundType rightBoundType)` Create a new DoubleRange.
`static DoubleRange`	`doubleRange(double from, BoundType leftBoundType, double to, BoundType rightBoundType, double step)` Create a new DoubleRange.
`static DoubleRange`	`doubleRange(double from, double to)` Create a new DoubleRange.
`static DoubleRange`	`doubleRange(double from, double to, double step)` Create a new DoubleRange.
`static DoubleRange`	`doubleRange(Endpoint<Double> leftEndpoint, Endpoint<Double> rightEndpoint, double step)` Create a new DoubleRange.
`static DoubleRange`	`doubleRange(Number from, Number to)` Create a new DoubleRange.
`static DoubleRange`	`doubleRange(Number from, Number to, Number step)` Create a new DoubleRange.
`static FloatRange`	`floatRange(Endpoint<Float> leftEndpoint, Endpoint<Float> rightEndpoint, float step)` Create a new FloatRange.
`static FloatRange`	`floatRange(float from, BoundType leftBoundType, float to, BoundType rightBoundType)` Create a new FloatRange.
`static FloatRange`	`floatRange(float from, BoundType leftBoundType, float to, BoundType rightBoundType, float step)` Create a new FloatRange.
`static FloatRange`	`floatRange(float from, float to)` Create a new FloatRange.
`static FloatRange`	`floatRange(float from, float to, float step)` Create a new FloatRange.
`static FloatRange`	`floatRange(Number from, Number to)` Create a new FloatRange.
`static FloatRange`	`floatRange(Number from, Number to, Number step)` Create a new FloatRange.
`static IntegerRange`	`integerRange(Endpoint<Integer> leftEndpoint, Endpoint<Integer> rightEndpoint, int step)` Create a new IntegerRange.
`static IntegerRange`	`integerRange(int from, BoundType leftBoundType, int to, BoundType rightBoundType)` Create a new IntegerRange.
`static IntegerRange`	`integerRange(int from, BoundType leftBoundType, int to, BoundType rightBoundType, int step)` Create a new IntegerRange.
`static IntegerRange`	`integerRange(int from, int to)` Create a new IntegerRange.
`static IntegerRange`	`integerRange(int from, int to, int step)` Create a new IntegerRange.
`static IntegerRange`	`integerRange(Number from, Number to)` Create a new IntegerRange.
`static IntegerRange`	`integerRange(Number from, Number to, Number step)` Create a new IntegerRange.
`static LongRange`	`longRange(Endpoint<Long> leftEndpoint, Endpoint<Long> rightEndpoint, long step)` Create a new LongRange.
`static LongRange`	`longRange(long from, BoundType leftBoundType, long to, BoundType rightBoundType)` Create a new LongRange.
`static LongRange`	`longRange(long from, BoundType leftBoundType, long to, BoundType rightBoundType, long step)` Create a new LongRange.
`static LongRange`	`longRange(long from, long to)` Create a new LongRange.
`static LongRange`	`longRange(long from, long to, long step)` Create a new LongRange.
`static LongRange`	`longRange(Number from, Number to)` Create a new LongRange.
`static LongRange`	`longRange(Number from, Number to, Number step)` Create a new IntegerRange.

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

Method Detail

integerRange

public static IntegerRange integerRange(Number from,
                        Number to)

Create a new IntegerRange.

Parameters:: from - start; to - end
Returns:: IntegerRange

integerRange

public static IntegerRange integerRange(Number from,
                        Number to,
                        Number step)

Create a new IntegerRange.

Parameters:: from - start; to - end; step - increment
Returns:: IntegerRange

integerRange

public static IntegerRange integerRange(int from,
                        int to)

Create a new IntegerRange.

Parameters:: from - start; to - end
Returns:: IntegerRange

integerRange

public static IntegerRange integerRange(int from,
                        int to,
                        int step)

Create a new IntegerRange.

Parameters:: from - start; to - end; step - increment
Returns:: IntegerRange

integerRange

public static IntegerRange integerRange(int from,
                        BoundType leftBoundType,
                        int to,
                        BoundType rightBoundType)

Create a new IntegerRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound
Returns:: IntegerRange

integerRange

public static IntegerRange integerRange(int from,
                        BoundType leftBoundType,
                        int to,
                        BoundType rightBoundType,
                        int step)

Create a new IntegerRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound; step - increment
Returns:: IntegerRange

integerRange

public static IntegerRange integerRange(Endpoint<Integer> leftEndpoint,
                        Endpoint<Integer> rightEndpoint,
                        int step)

Create a new IntegerRange.

Parameters:: leftEndpoint - start; rightEndpoint - end; step - increment
Returns:: IntegerRange

longRange

public static LongRange longRange(Number from,
                  Number to)

Create a new LongRange.

Parameters:: from - start; to - end
Returns:: LongRange

longRange

public static LongRange longRange(Number from,
                  Number to,
                  Number step)

Create a new IntegerRange.

Parameters:: from - start; to - end; step - increment
Returns:: LongRange

longRange

public static LongRange longRange(long from,
                  long to)

Create a new LongRange.

Parameters:: from - start; to - end
Returns:: LongRange

longRange

public static LongRange longRange(long from,
                  long to,
                  long step)

Create a new LongRange.

Parameters:: from - start; to - end; step - increment
Returns:: LongRange

longRange

public static LongRange longRange(long from,
                  BoundType leftBoundType,
                  long to,
                  BoundType rightBoundType)

Create a new LongRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound
Returns:: LongRange

longRange

public static LongRange longRange(long from,
                  BoundType leftBoundType,
                  long to,
                  BoundType rightBoundType,
                  long step)

Create a new LongRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound; step - increment
Returns:: LongRange

longRange

public static LongRange longRange(Endpoint<Long> leftEndpoint,
                  Endpoint<Long> rightEndpoint,
                  long step)

Create a new LongRange.

Parameters:: leftEndpoint - start; rightEndpoint - end; step - increment
Returns:: LongRange

floatRange

public static FloatRange floatRange(Number from,
                    Number to)

Create a new FloatRange.

Parameters:: from - start; to - end
Returns:: FloatRange

floatRange

public static FloatRange floatRange(Number from,
                    Number to,
                    Number step)

Create a new FloatRange.

Parameters:: from - start; to - end; step - increment
Returns:: FloatRange

floatRange

public static FloatRange floatRange(float from,
                    float to)

Create a new FloatRange.

Parameters:: from - start; to - end
Returns:: FloatRange

floatRange

public static FloatRange floatRange(float from,
                    float to,
                    float step)

Create a new FloatRange.

Parameters:: from - start; to - end; step - increment
Returns:: FloatRange

floatRange

public static FloatRange floatRange(float from,
                    BoundType leftBoundType,
                    float to,
                    BoundType rightBoundType)

Create a new FloatRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound
Returns:: FloatRange

floatRange

public static FloatRange floatRange(float from,
                    BoundType leftBoundType,
                    float to,
                    BoundType rightBoundType,
                    float step)

Create a new FloatRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound; step - increment
Returns:: FloatRange

floatRange

public static FloatRange floatRange(Endpoint<Float> leftEndpoint,
                    Endpoint<Float> rightEndpoint,
                    float step)

Create a new FloatRange.

Parameters:: leftEndpoint - start; rightEndpoint - end; step - increment
Returns:: FloatRange

doubleRange

public static DoubleRange doubleRange(Number from,
                      Number to)

Create a new DoubleRange.

Parameters:: from - start; to - end
Returns:: DoubleRange

doubleRange

public static DoubleRange doubleRange(Number from,
                      Number to,
                      Number step)

Create a new DoubleRange.

Parameters:: from - start; to - end; step - increment
Returns:: DoubleRange

doubleRange

public static DoubleRange doubleRange(double from,
                      double to)

Create a new DoubleRange.

Parameters:: from - start; to - end
Returns:: DoubleRange

doubleRange

public static DoubleRange doubleRange(double from,
                      double to,
                      double step)

Create a new DoubleRange.

Parameters:: from - start; to - end; step - increment
Returns:: DoubleRange

doubleRange

public static DoubleRange doubleRange(double from,
                      BoundType leftBoundType,
                      double to,
                      BoundType rightBoundType,
                      double step)

Create a new DoubleRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound; step - increment
Returns:: DoubleRange

doubleRange

public static DoubleRange doubleRange(double from,
                      BoundType leftBoundType,
                      double to,
                      BoundType rightBoundType)

Create a new DoubleRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound
Returns:: DoubleRange

doubleRange

public static DoubleRange doubleRange(Endpoint<Double> leftEndpoint,
                      Endpoint<Double> rightEndpoint,
                      double step)

Create a new DoubleRange.

Parameters:: leftEndpoint - start; rightEndpoint - end; step - increment
Returns:: DoubleRange

characterRange

public static CharacterRange characterRange(char from,
                            char to)

Create a new CharacterRange.

Parameters:: from - start; to - end
Returns:: CharacterRange

characterRange

public static CharacterRange characterRange(char from,
                            char to,
                            int step)

Create a new CharacterRange.

Parameters:: from - start; to - end; step - increment
Returns:: CharacterRange

characterRange

public static CharacterRange characterRange(char from,
                            BoundType leftBoundType,
                            char to,
                            BoundType rightBoundType)

Create a new CharacterRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound
Returns:: CharacterRange

characterRange

public static CharacterRange characterRange(char from,
                            BoundType leftBoundType,
                            char to,
                            BoundType rightBoundType,
                            int step)

Create a new CharacterRange.

Parameters:: from - start; leftBoundType - type of left bound; to - end; rightBoundType - type of right bound; step - increment
Returns:: CharacterRange

characterRange

public static CharacterRange characterRange(Endpoint<Character> leftEndpoint,
                            Endpoint<Character> rightEndpoint,
                            int step)

Create a new CharacterRange.

Parameters:: leftEndpoint - start; rightEndpoint - end; step - increment
Returns:: CharacterRange

Class Ranges

Method Summary

Methods inherited from class java.lang.Object

Method Detail

integerRange

integerRange

integerRange

integerRange

integerRange

integerRange

integerRange

longRange

longRange

longRange

longRange

longRange

longRange

longRange

floatRange

floatRange

floatRange

floatRange

floatRange

floatRange

floatRange

doubleRange

doubleRange

doubleRange

doubleRange

doubleRange

doubleRange

doubleRange

characterRange

characterRange

characterRange

characterRange

characterRange