org.dmfs.jems.optional.adapters

Class First<T>

java.lang.Object

org.dmfs.jems.optional.adapters.First<T>

All Implemented Interfaces:

Optional<T>

public final class First<T>
extends java.lang.Object
implements Optional<T>

The first value of an Iterable.

Constructor Summary

Constructors

Constructor and Description
First(java.lang.Iterable<T> iterable) Creates the Optional first value of the given Iterable.
First(java.lang.Iterable<T> iterable, Filter<T> filter) Creates an Optional of the first value of the given Iterable which matches the given Filter.
First(java.lang.Iterable<T> iterable, Predicate<T> predicate) Creates an Optional of the first value of the given Iterable which matches the given Predicate.

Method Summary

Modifier and Type	Method and Description
boolean	isPresent() Returns whether the optional value is present.
T	value() Returns the optional value.

Methods inherited from class java.lang.Object

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

Constructor Detail

First

public First(java.lang.Iterable<T> iterable,
             Predicate<T> predicate)

Creates an Optional of the first value of the given Iterable which matches the given Predicate.

Parameters:

iterable - The Iterable

predicate - The Predicate

First

public First(java.lang.Iterable<T> iterable,
             Filter<T> filter)

Creates an Optional of the first value of the given Iterable which matches the given Filter.

Parameters:

iterable - The Iterable

filter - The Filter

First

public First(java.lang.Iterable<T> iterable)

Creates the Optional first value of the given Iterable.

Parameters:

iterable - A Iterable.

Method Detail

isPresent

public boolean isPresent()

Description copied from interface: Optional

Returns whether the optional value is present.

Specified by:

isPresent in interface Optional<T>

Returns:

true if the value is present, false otherwise.

value

public T value()
        throws java.util.NoSuchElementException

Description copied from interface: Optional

Returns the optional value.

Specified by:

value in interface Optional<T>

Returns:

The value.

Throws:

java.util.NoSuchElementException - if the optional value is not present.