Range (Apache Commons Functor 1.0-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Type Parameters:
T - the type of elements held by this range.
S - the type of the step of this range.

All Superinterfaces:

Iterable<T>

All Known Implementing Classes:

AbstractRange, CharacterRange, DoubleRange, FloatRange, IntegerRange, LongRange, NumericRange
```
public interface Range<T extends Comparable<?>,S>
extends Iterable<T>
```
Represent an interval of elements that varies from the left limit to the right limit. Each limit in this range is an Endpoint. The left and the right limits can be inclusive (bounded, closed) or exclusive (unbounded, open).
The difference between each element within this range is called step. The step can be positive or negative, displaying whether the range elements are ascending or descending.

Since:

1.0

Version:

$Revision$ $Date$

See Also:
Endpoint

Field Summary

Fields
Modifier and Type Field and Description

static BoundType DEFAULT_LEFT_BOUND_TYPE
Default left bound type.

static BoundType DEFAULT_RIGHT_BOUND_TYPE
Default right bound type.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`contains(T obj)` Returns `true` if this range contains the specified element.
`boolean`	`containsAll(Collection<T> col)` Returns `true` is this range contains all of the elements in the specified collection.
`Endpoint<T>`	`getLeftEndpoint()` Get the left limit of this range.
`Endpoint<T>`	`getRightEndpoint()` Get the right limit of this range.
`S`	`getStep()` Get the step between elements of this range.
`boolean`	`isEmpty()` Returns `true` if this range is empty.

Methods inherited from interface java.lang.Iterable
iterator

- Field Detail
  - DEFAULT_LEFT_BOUND_TYPE
```
static final BoundType DEFAULT_LEFT_BOUND_TYPE
```
    Default left bound type.
  - DEFAULT_RIGHT_BOUND_TYPE
```
static final BoundType DEFAULT_RIGHT_BOUND_TYPE
```
    Default right bound type.
- Method Detail
  - getLeftEndpoint
```
Endpoint<T> getLeftEndpoint()
```
    Get the left limit of this range.
    
    Returns:
    Endpoint
  - getRightEndpoint
```
Endpoint<T> getRightEndpoint()
```
    Get the right limit of this range.
    
    Returns:
    Endpoint
  - getStep
```
S getStep()
```
    Get the step between elements of this range.
    
    Returns:
    Number
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this range is empty.
    
    Returns:
    true if this range is empty
  - contains
```
boolean contains(T obj)
```
    Returns true if this range contains the specified element.
    
    Parameters:
    obj - element whose presence is being tested in this range
    
    Returns:
    true if this range contains the specified element
  - containsAll
```
boolean containsAll(Collection<T> col)
```
    Returns true is this range contains all of the elements in the specified collection.
    
    Parameters:
    col - collection to be checked for the containment in this range
    
    Returns:
    true if this range contains all of the elements in the specified collection

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.