com.aol.cyclops2.types.stream

Class HeadAndTail<T>

java.lang.Object

com.aol.cyclops2.types.stream.HeadAndTail<T>

Type Parameters:

T - Data type of elements in this Head and Tail

public class HeadAndTail<T>
extends java.lang.Object

A class that represents a lazily constructed Head and Tail from a non-scalar data type

Constructor Summary

Constructors

Constructor and Description
HeadAndTail(java.util.Iterator<T> it) Construct a HeadAndTail from an Iterator

Method Summary

Modifier and Type	Method and Description
T	head()
Maybe<T>	headMaybe()
java.util.Optional<T>	headOptional()
ReactiveSeq<T>	headStream()
boolean	isHeadPresent()
ReactiveSeq<T>	tail()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeadAndTail

public HeadAndTail(java.util.Iterator<T> it)

Construct a HeadAndTail from an Iterator

Parameters:

it - Iterator to construct head and tail from

Method Detail

isHeadPresent

public boolean isHeadPresent()

Returns:

true if the head is present

head

public T head()

Returns:

Head (first) value, will throw an exception if the head is not present

headOptional

public java.util.Optional<T> headOptional()

Returns:

Optional.empty if the head is not present, otherwise an Optional containing the head

headMaybe

public Maybe<T> headMaybe()

Returns:

Maybe.none if the head is not present, otherwise a Maybe.some containing the first value

headStream

public ReactiveSeq<T> headStream()

Returns:

A Stream containing the Head if present

tail

public ReactiveSeq<T> tail()

Returns:

The tail