AbstractIndexedSource (net.markenwerk:commons-collections 1.0.0 API)

java.lang.Object
- net.markenwerk.commons.collections.sources.AbstractSource<Payload>
- - net.markenwerk.commons.collections.sources.AbstractIndexedSource<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterable<Payload>, IndexedSource<Payload>, Source<Payload>, BidirectionalIterable<Payload>, ProtectedBidirectionalIterable<Payload>, ProtectedIterable<Payload>

Direct Known Subclasses:

AbstractSequence, ArraySource, ListSource
```
public abstract class AbstractIndexedSource<Payload>
extends AbstractSource<Payload>
implements IndexedSource<Payload>
```
An AbstractIndexedSource is an abstract base implementation of a IndexedSource.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors
Constructor and Description

AbstractIndexedSource()
Creates a new AbstractIndexedSource.

Constructors
Constructor and Description
`AbstractIndexedSource()` Creates a new `AbstractIndexedSource`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract Payload`	`doGet(int index)` Returns a payload value at the given index.
`protected Payload`	`doGetFirst()` Returns the first (i.e.
`protected abstract ProtectedBidirectionalIterator<Payload>`	`doIterator(boolean reverse)` Returns a `ProtectedBidirectionalIterator`.
`Optional<Integer>`	`firstIndexOf(Payload reference)` Returns index, of the first occurrence, by Object#equals(Object) equality, of the given reference payload value.
`Optional<Integer>`	`firstIndexOfMatch(Predicate<? super Payload> predicate)` Returns index, of the first occurrence of a payload value that satisfies the given `Predicate`.
`Payload`	`get(int index)` Returns the payload value at the given index.
`Payload`	`getLast()` Returns the last payload value.
`Optional<Payload>`	`getLast(Payload reference)` Returns the first occurrences, by `equality`, of the given reference payload value.
`Optional<Payload>`	`getLastMatch(Predicate<? super Payload> predicate)` Returns the last payload value that satisfies the given `Predicate` .
`boolean`	`isFirst(Payload payload)` Returns whether the given payload value is the `first` payload value.
`boolean`	`isLast(Payload payload)` Returns whether the given payload value is the `last` payload value.
`ProtectedBidirectionalIterator<Payload>`	`iterator()` Returns a `ProtectedIterator`.
`ProtectedBidirectionalIterator<Payload>`	`iterator(boolean reverse)` Returns a `ProtectedBidirectionalIterator`.
`Optional<Integer>`	`lastIndexOf(Payload reference)` Returns index, of the last occurrence, by Object#equals(Object) equality, of the given reference payload value.
`Optional<Integer>`	`lastIndexOfMatch(Predicate<? super Payload> predicate)` Returns index, of the last occurrence of a payload value that satisfies the given `Predicate`.

Methods inherited from class net.markenwerk.commons.collections.sources.AbstractSource
contains, containsAll, containsAll, containsMatch, createPredicate, firstIndexOf, getAll, getAllMatches, getFirst, getFirst, getFirstMatch, isEmpty, toString

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

Methods inherited from interface net.markenwerk.commons.collections.sources.IndexedSource
getFirst, getFirst, getFirstMatch

Methods inherited from interface net.markenwerk.commons.collections.sources.Source
contains, containsAll, containsAll, containsMatch, getAll, getAllMatches, isEmpty, size

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - AbstractIndexedSource
```
public AbstractIndexedSource()
```
    Creates a new AbstractIndexedSource.
- Method Detail
  - get
```
public final Payload get(int index)
                  throws IndexOutOfBoundsException
```
    Description copied from interface: IndexedSource
    
    Returns the payload value at the given index.
    
    Specified by:
    
    get in interface IndexedSource<Payload>
    
    Parameters:
    
    index - The index to be used.
    
    Returns:
    
    The payload value.
    
    Throws:
    
    IndexOutOfBoundsException - If the given index is negative or if the given index is larger or equal to the size of this IndexedSource.
  - doGet
```
protected abstract Payload doGet(int index)
```
    Returns a payload value at the given index.
    
    Parameters:
    
    index - The index to be used, which is guaranteed to be not negative and not larger then or equal to the size of this AbstractIndexedSource.
    
    Returns:
    
    The payload value.
  - isFirst
```
public final boolean isFirst(Payload payload)
                      throws NoSuchElementException
```
    Description copied from interface: IndexedSource
    
    Returns whether the given payload value is the first payload value.
    
    Specified by:
    
    isFirst in interface IndexedSource<Payload>
    
    Parameters:
    
    payload - The payload value to be used.
    
    Returns:
    
    Whether the given payload value is the first payload value.
    
    Throws:
    
    NoSuchElementException - If the given payload value is not contained in this IndexedSource.
  - doGetFirst
```
protected final Payload doGetFirst()
```
    Description copied from class: AbstractSource
    
    Returns the first (i.e. first payload value in an iterator) payload value, which is guaranteed to exist.
    
    Overrides:
    
    doGetFirst in class AbstractSource<Payload>
    
    Returns:
    
    The payload value.
  - isLast
```
public final boolean isLast(Payload payload)
                     throws NoSuchElementException
```
    Description copied from interface: IndexedSource
    
    Returns whether the given payload value is the last payload value.
    
    Specified by:
    
    isLast in interface IndexedSource<Payload>
    
    Parameters:
    
    payload - The payload value to be used.
    
    Returns:
    
    Whether the given payload value is the first payload value.
    
    Throws:
    
    NoSuchElementException - If the given payload value is not contained in this IndexedSource.
  - getLast
```
public final Payload getLast()
                      throws NoSuchElementException
```
    Description copied from interface: IndexedSource
    
    Returns the last payload value.
    
    Specified by:
    
    getLast in interface IndexedSource<Payload>
    
    Returns:
    
    The payload value.
    
    Throws:
    
    NoSuchElementException - If this IndexedSource is empty.
  - getLast
```
public final Optional<Payload> getLast(Payload reference)
```
    Description copied from interface: IndexedSource
    
    Returns the first occurrences, by equality, of the given reference payload value.
    
    Specified by:
    
    getLast in interface IndexedSource<Payload>
    
    Parameters:
    
    reference - The reference payload to be used.
    
    Returns:
    
    An Optional yielding the payload value.
  - getLastMatch
```
public final Optional<Payload> getLastMatch(Predicate<? super Payload> predicate)
                                     throws IllegalArgumentException
```
    Description copied from interface: IndexedSource
    
    Returns the last payload value that satisfies the given Predicate .
    
    Specified by:
    
    getLastMatch in interface IndexedSource<Payload>
    
    Parameters:
    
    predicate - The Predicate to be used.
    
    Returns:
    
    An Optional yielding the payload value.
    
    Throws:
    
    IllegalArgumentException - If the given Predicate is null.
  - firstIndexOf
```
public final Optional<Integer> firstIndexOf(Payload reference)
                                     throws NoSuchElementException
```
    Description copied from interface: IndexedSource
    
    Returns index, of the first occurrence, by Object#equals(Object) equality, of the given reference payload value.
    
    Specified by:
    
    firstIndexOf in interface IndexedSource<Payload>
    
    Parameters:
    
    reference - The payload value to be used.
    
    Returns:
    
    An Optional yielding the index.
    
    Throws:
    
    NoSuchElementException
  - firstIndexOfMatch
```
public final Optional<Integer> firstIndexOfMatch(Predicate<? super Payload> predicate)
                                          throws IllegalArgumentException,
                                                 NoSuchElementException
```
    Description copied from interface: IndexedSource
    
    Returns index, of the first occurrence of a payload value that satisfies the given Predicate.
    
    Specified by:
    
    firstIndexOfMatch in interface IndexedSource<Payload>
    
    Parameters:
    
    predicate - The Predicate value to be used.
    
    Returns:
    
    An Optional yielding the index.
    
    Throws:
    
    IllegalArgumentException - If the given Predicate is null.
    
    NoSuchElementException
  - lastIndexOf
```
public final Optional<Integer> lastIndexOf(Payload reference)
                                    throws NoSuchElementException
```
    Description copied from interface: IndexedSource
    
    Returns index, of the last occurrence, by Object#equals(Object) equality, of the given reference payload value.
    
    Specified by:
    
    lastIndexOf in interface IndexedSource<Payload>
    
    Parameters:
    
    reference - The payload value to be used.
    
    Returns:
    
    An Optional yielding the index.
    
    Throws:
    
    NoSuchElementException
  - lastIndexOfMatch
```
public final Optional<Integer> lastIndexOfMatch(Predicate<? super Payload> predicate)
                                         throws IllegalArgumentException,
                                                NoSuchElementException
```
    Description copied from interface: IndexedSource
    
    Returns index, of the last occurrence of a payload value that satisfies the given Predicate.
    
    Specified by:
    
    lastIndexOfMatch in interface IndexedSource<Payload>
    
    Parameters:
    
    predicate - The Predicate value to be used.
    
    Returns:
    
    An Optional yielding the index.
    
    Throws:
    
    IllegalArgumentException - If the given Predicate is null.
    
    NoSuchElementException
  - iterator
```
public final ProtectedBidirectionalIterator<Payload> iterator()
```
    Description copied from interface: ProtectedIterable
    
    Returns a ProtectedIterator.
    
    Specified by:
    
    iterator in interface Iterable<Payload>
    
    Specified by:
    
    iterator in interface BidirectionalIterable<Payload>
    
    Specified by:
    
    iterator in interface ProtectedBidirectionalIterable<Payload>
    
    Specified by:
    
    iterator in interface ProtectedIterable<Payload>
    
    Returns:
    
    A ProtectedIterator.
  - iterator
```
public final ProtectedBidirectionalIterator<Payload> iterator(boolean reverse)
```
    Description copied from interface: IndexedSource
    
    Returns a ProtectedBidirectionalIterator.
    
    Specified by:
    
    iterator in interface IndexedSource<Payload>
    
    Parameters:
    
    reverse - Whether to return a ProtectedBidirectionalIterator that iterates this indexed source in reverse.
    
    Returns:
    
    A ProtectedBidirectionalIterator.
  - doIterator
```
protected abstract ProtectedBidirectionalIterator<Payload> doIterator(boolean reverse)
```
    Returns a ProtectedBidirectionalIterator.
    
    Parameters:
    
    reverse - The initial index to be used. Whether to return a ProtectedBidirectionalIterator that iterates this indexed source in reverse.
    
    Returns:
    
    A ProtectedBidirectionalIterator.

Class AbstractIndexedSource<Payload>

Constructor Summary

Method Summary

Methods inherited from class net.markenwerk.commons.collections.sources.AbstractSource

Methods inherited from class java.lang.Object

Methods inherited from interface net.markenwerk.commons.collections.sources.IndexedSource

Methods inherited from interface net.markenwerk.commons.collections.sources.Source

Methods inherited from interface java.lang.Iterable

Constructor Detail

AbstractIndexedSource

Method Detail

get

doGet

isFirst

doGetFirst

isLast

getLast

getLast

getLastMatch

firstIndexOf

firstIndexOfMatch

lastIndexOf

lastIndexOfMatch

iterator

iterator

doIterator