RubyRange

java.lang.Object
- net.sf.rubycollect4j.RubyEnumerable<E>
- - net.sf.rubycollect4j.RubyRange<E>

Type Parameters:
E - the type of elements

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, Ruby.Enumerable<E>, RubyContract.Enumerable<E,Ruby.Enumerator<?>,RubyArray<?>>
```
public final class RubyRange<E>
extends RubyEnumerable<E>
implements java.io.Serializable
```
RubyRange is inspired by the Range class of Ruby. It does not exactly follow the implementation of Ruby, especially on the range of alphanumeric strings. All objects can use the RubyRange to create a range of interval. As long as it provides the corresponding Successive object.
RubyRange is also a Ruby.Enumerable.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

RubyRange(Successive<E> successive, E startPoint, E endPoint)
Creates a RubyRange of given elements.

Constructors
Constructor and Description
`RubyRange(Successive<E> successive, E startPoint, E endPoint)` Creates a `RubyRange` of given elements.

Method Summary

Methods
Modifier and Type	Method and Description
`E`	`begin()` Returns the beginning of this `RubyRange`.
`boolean`	`coverʔ(E item)` Check if an item is within this `RubyRange`.
`RubyRange<E>`	`each(Block<? super E> block)` Yields each element to the block.
`E`	`end()` Returns the end of this `RubyRange`.
`boolean`	`eqlʔ(java.lang.Object o)` Equivalent to `equals(Object)`.
`boolean`	`equals(java.lang.Object o)`
`protected java.lang.Iterable<E>`	`getIterable()` Returns an Iterable of elements.
`int`	`hash()` Equivalent to `hashCode()`.
`int`	`hashCode()`
`boolean`	`includeʔ(E item)` Checks if target element is included.
`java.lang.String`	`inspect()` Equivalent to `toString()`.
`E`	`last()` Returns the end of this `RubyRange`.
`RubyArray<E>`	`last(int n)` Returns the last n elements of this `RubyRange`.
`boolean`	`memberʔ(E item)` Equivalent to `RubyContract.Enumerable.includeʔ(Object)`.
`RubyEnumerator<E>`	`step(int n)` Creates a `RubyEnumerator` by all nth elements of the range.
`RubyRange<E>`	`step(int n, Block<E> block)` Iterates over this `RubyRange` and yields each nth element to the block.
`java.lang.String`	`toS()` Equivalent to `toString()`.
`java.lang.String`	`toString()`

Methods inherited from class net.sf.rubycollect4j.RubyEnumerable
allʔ, allʔ, anyʔ, anyʔ, chunk, chunk, collect, collect, collect, collectConcat, collectConcat, count, count, cycle, cycle, cycle, cycle, detect, detect, drop, dropWhile, dropWhile, each, eachCons, eachCons, eachEntry, eachEntry, eachSlice, eachSlice, eachWithIndex, eachWithIndex, eachWithObject, eachWithObject, entries, find, find, findAll, findAll, findIndex, findIndex, findIndex, first, first, flatMap, flatMap, grep, grep, grep, groupBy, groupBy, groupBy, inject, inject, inject, inject, iterator, lazy, map, map, map, max, max, maxBy, maxBy, maxBy, maxBy, min, min, minBy, minBy, minBy, minBy, minmax, minmax, minmaxBy, minmaxBy, minmaxBy, minmaxBy, noneʔ, noneʔ, oneʔ, oneʔ, partition, partition, reduce, reduce, reduce, reduce, reject, reject, reverseEach, reverseEach, select, select, sliceBefore, sliceBefore, sort, sortBy, sortBy, sortBy, sortBy, sortBy, take, takeWhile, takeWhile, toA, zip, zip, zip

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

- Constructor Detail
  - RubyRange
```
public RubyRange(Successive<E> successive,
         E startPoint,
         E endPoint)
```
    Creates a RubyRange of given elements.
    
    Parameters:
    successive - a Successive object to provide the successor of elements
    startPoint - where the range begins
    endPoint - where the range ends
    
    Throws:
    
    java.lang.NullPointerException - if successive is null
    
    java.lang.IllegalArgumentException - if startPoint or endPoint is null
- Method Detail
  - getIterable
```
protected java.lang.Iterable<E> getIterable()
```
    Description copied from class: RubyEnumerable
    
    Returns an Iterable of elements.
    
    Specified by:
    
    getIterable in class RubyEnumerable<E>
    
    Returns:
    Iterable
  - begin
```
public E begin()
```
    Returns the beginning of this RubyRange.
    
    Returns:
    the beginning of this RubyRange
  - coverʔ
```
public boolean coverʔ(E item)
```
    Check if an item is within this RubyRange.
    
    Parameters:
    item - to be checked
    
    Returns:
    true if item is within this range, false otherwise
  - each
```
public RubyRange<E> each(Block<? super E> block)
```
    Yields each element to the block.
    
    Specified by:
    
    each in interface Ruby.Enumerable<E>
    
    Specified by:
    
    each in interface RubyContract.Enumerable<E,Ruby.Enumerator<?>,RubyArray<?>>
    
    Overrides:
    
    each in class RubyEnumerable<E>
    
    Parameters:
    block - to yield each element
    
    Returns:
    this RubyRange
  - end
```
public E end()
```
    Returns the end of this RubyRange.
    
    Returns:
    the end of this RubyRange
  - eqlʔ
```
public boolean eqlʔ(java.lang.Object o)
```
    Equivalent to equals(Object).
    
    Parameters:
    o - any Object
    
    Returns:
    true if 2 objects are equal, false otherwise
  - hash
```
public int hash()
```
    Equivalent to hashCode().
    
    Returns:
    the hash code
  - includeʔ
```
public boolean includeʔ(E item)
```
    Description copied from interface: RubyContract.Enumerable
    
    Checks if target element is included.
    
    Specified by:
    
    includeʔ in interface RubyContract.Enumerable<E,Ruby.Enumerator<?>,RubyArray<?>>
    
    Overrides:
    
    includeʔ in class RubyEnumerable<E>
    
    Parameters:
    item - to be searched
    
    Returns:
    true if target is found,false otherwise
  - inspect
```
public java.lang.String inspect()
```
    Equivalent to toString().
    
    Returns:
    a String
  - last
```
public E last()
```
    Returns the end of this RubyRange.
    
    Returns:
    the end of this RubyRange
  - last
```
public RubyArray<E> last(int n)
```
    Returns the last n elements of this RubyRange.
    
    Parameters:
    n - number of elements
    
    Returns:
    a RubyArray
  - memberʔ
```
public boolean memberʔ(E item)
```
    Description copied from interface: RubyContract.Enumerable
    
    Equivalent to RubyContract.Enumerable.includeʔ(Object).
    
    Specified by:
    
    memberʔ in interface RubyContract.Enumerable<E,Ruby.Enumerator<?>,RubyArray<?>>
    
    Overrides:
    
    memberʔ in class RubyEnumerable<E>
    
    Parameters:
    item - to be found
    
    Returns:
    element or null
  - step
```
public RubyEnumerator<E> step(int n)
```
    Creates a RubyEnumerator by all nth elements of the range.
    
    Parameters:
    n - interval to step
    
    Returns:
    a RubyEnumerator
  - step
```
public RubyRange<E> step(int n,
                Block<E> block)
```
    Iterates over this RubyRange and yields each nth element to the block.
    
    Parameters:
    n - interval to step
    block - to yield each element
    
    Returns:
    this RubyRange
  - toS
```
public java.lang.String toS()
```
    Equivalent to toString().
    
    Returns:
    a String
  - 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
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class RubyEnumerable<E>

Class RubyRange<E>

Constructor Summary

Method Summary

Methods inherited from class net.sf.rubycollect4j.RubyEnumerable

Methods inherited from class java.lang.Object

Constructor Detail

RubyRange

Method Detail

getIterable

begin

coverʔ

each

end

eqlʔ

hash

includeʔ

inspect

last

last

memberʔ

step

step

toS

equals

hashCode

toString