TransformSpliterator (Helenus Common Utilities 1.0.14 API)

java.lang.Object
- org.helenus.commons.collections.iterators.TransformSpliterator<I,O>

Type Parameters:

I - the type of element being iterated on input

O - the type of element returned on output

All Implemented Interfaces:

Spliterator<O>
```
public class TransformSpliterator<I,O>
extends Object
implements Spliterator<O>
```
The TransformSpliterator class provides a useful extension to the Spliterator interface in cases where a transforming function needs to be applied to the split-iterator before returning any elements.
The implementation provided here creates a split iterator which wraps around the given split iterator. The original split iterator is iterated as this split iterator is being accessed.

Since:

1.0

Version:

1 - Sep 9, 2016 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2016 The Helenus Driver Project Authors

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Spliterator
  Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary
- Fields inherited from interface java.util.Spliterator
  CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors
Constructor and Description
`TransformSpliterator(Spliterator<? extends I> i)` Constructs a transforming split iterator using an input split iterator.
`TransformSpliterator(Spliterator<? extends I> i, Transformer<? super I,? extends O> transformer)` Constructs a transforming split iterator using an input split iterator and the specified transformer.
`TransformSpliterator(Spliterator<? extends I> i, Transformer<? super I,? extends O> transformer, Transformer<? super O,? extends I> reverseTransformer)` Constructs a transforming split iterator using an input split iterator and the specified transformer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`characteristics()`
`long`	`estimateSize()`
`void`	`forEachRemaining(java.util.function.Consumer<? super O> action)`
`Comparator<? super O>`	`getComparator()`
`long`	`getExactSizeIfKnown()`
`Transformer<? super O,? extends I>`	`getReverseTransformer()` Gets the optional reverse transformer this split iterator needs if the source is `SORTED` with a non-natural order.
`Spliterator<? extends I>`	`getSpliterator()` Gets the split iterator this split iterator is using.
`Transformer<? super I,? extends O>`	`getTransformer()` Gets the transformer this split iterator is using.
`boolean`	`hasCharacteristics(int characteristics)`
`void`	`setReverseTransformer(Transformer<? super O,? extends I> reverseTransformer)` Sets the reverse transformer this split iterator needs if the source is `SORTED` with a non-natural order.
`void`	`setSpliterator(Spliterator<? extends I> iterator)` Sets the split iterator for this split iterator to use.
`void`	`setTransformer(Transformer<? super I,? extends O> transformer)` Sets the transformer this split iterator will use.
`protected O`	`transform(I source)` Transforms the given object using the transformer.
`boolean`	`tryAdvance(java.util.function.Consumer<? super O> action)`
`Spliterator<O>`	`trySplit()`

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

- Constructor Detail
  - TransformSpliterator
```
public TransformSpliterator(Spliterator<? extends I> i)
```
    Constructs a transforming split iterator using an input split iterator.
    
    Parameters:
    
    i - a split iterator to be transformed
  - TransformSpliterator
```
public TransformSpliterator(Spliterator<? extends I> i,
                            Transformer<? super I,? extends O> transformer)
```
    Constructs a transforming split iterator using an input split iterator and the specified transformer.
    
    Parameters:
    
    i - a split iterator to be transformed
    
    transformer - a transformer object
  - TransformSpliterator
```
public TransformSpliterator(Spliterator<? extends I> i,
                            Transformer<? super I,? extends O> transformer,
                            Transformer<? super O,? extends I> reverseTransformer)
```
    Constructs a transforming split iterator using an input split iterator and the specified transformer.
    
    Parameters:
    
    i - a list iterator to be transformed
    
    transformer - a transformer object
    
    reverseTransformer - a reverse transformer object
- Method Detail
  - transform
```
protected O transform(I source)
```
    Transforms the given object using the transformer.
    
    Parameters:
    
    source - the object to transform
    
    Returns:
    
    the transformed object
  - tryAdvance
```
public boolean tryAdvance(java.util.function.Consumer<? super O> action)
```
    Specified by:
    
    tryAdvance in interface Spliterator<O>
    
    See Also:
    
    Spliterator.tryAdvance(java.util.function.Consumer)
  - forEachRemaining
```
public void forEachRemaining(java.util.function.Consumer<? super O> action)
```
    Specified by:
    
    forEachRemaining in interface Spliterator<O>
    
    See Also:
    
    Spliterator.forEachRemaining(java.util.function.Consumer)
  - trySplit
```
public Spliterator<O> trySplit()
```
    Specified by:
    
    trySplit in interface Spliterator<O>
    
    See Also:
    
    Spliterator.trySplit()
  - estimateSize
```
public long estimateSize()
```
    Specified by:
    
    estimateSize in interface Spliterator<O>
    
    See Also:
    
    Spliterator.estimateSize()
  - getExactSizeIfKnown
```
public long getExactSizeIfKnown()
```
    Specified by:
    
    getExactSizeIfKnown in interface Spliterator<O>
    
    See Also:
    
    Spliterator.getExactSizeIfKnown()
  - characteristics
```
public int characteristics()
```
    Specified by:
    
    characteristics in interface Spliterator<O>
    
    See Also:
    
    Spliterator.characteristics()
  - hasCharacteristics
```
public boolean hasCharacteristics(int characteristics)
```
    Specified by:
    
    hasCharacteristics in interface Spliterator<O>
    
    See Also:
    
    Spliterator.hasCharacteristics(int)
  - getComparator
```
public Comparator<? super O> getComparator()
```
    Note: If the underlying split iterator is SORTED in a non-natural order, this method will be unable to return a transformed comparator as it would require
    
    Specified by:
    
    getComparator in interface Spliterator<O>
    
    See Also:
    
    Spliterator.getComparator()
  - getSpliterator
```
public Spliterator<? extends I> getSpliterator()
```
    Gets the split iterator this split iterator is using.
    
    Returns:
    
    the split iterator
  - setSpliterator
```
public void setSpliterator(Spliterator<? extends I> iterator)
```
    Sets the split iterator for this split iterator to use. If iteration has started, this effectively resets the split iterator.
    
    Parameters:
    
    iterator - the split iterator to use
  - getTransformer
```
public Transformer<? super I,? extends O> getTransformer()
```
    Gets the transformer this split iterator is using.
    
    Returns:
    
    the transformer
  - setTransformer
```
public void setTransformer(Transformer<? super I,? extends O> transformer)
```
    Sets the transformer this split iterator will use.
    
    Parameters:
    
    transformer - the transformer to use
  - getReverseTransformer
```
public Transformer<? super O,? extends I> getReverseTransformer()
```
    Gets the optional reverse transformer this split iterator needs if the source is SORTED with a non-natural order.
    
    Returns:
    
    the reverse transformer to use in comparisons
  - setReverseTransformer
```
public void setReverseTransformer(Transformer<? super O,? extends I> reverseTransformer)
```
    Sets the reverse transformer this split iterator needs if the source is SORTED with a non-natural order.
    
    Parameters:
    
    reverseTransformer - the reverse transformer to use in comparisons

Class TransformSpliterator<I,O>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Field Summary

Fields inherited from interface java.util.Spliterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransformSpliterator

TransformSpliterator

TransformSpliterator

Method Detail

transform

tryAdvance

forEachRemaining

trySplit

estimateSize

getExactSizeIfKnown

characteristics

hasCharacteristics

getComparator

getSpliterator

setSpliterator

getTransformer

setTransformer

getReverseTransformer

setReverseTransformer