org.cactoos.scalar

Class LowestOf<T extends Comparable<T>>

java.lang.Object

org.cactoos.scalar.LowestOf<T>

Type Parameters:

T - Scalar type

All Implemented Interfaces:

Scalar<T>

public final class LowestOf<T extends Comparable<T>>
extends Object
implements Scalar<T>

Find the lowest item.

Here is how you can use it to find lowest of Comparable items:

 final String lowest = new LowestOf<String>(
         () -> "Banana", () -> "Apple", () -> "Orange"
     ).value();
 // -> lowest == "Apple"

 final Character lowestChar = new LowestOf<>('B', 'U', 'G').value();
 // -> lowestChar == 'B'
 

This class implements Scalar, which throws a checked Exception. This may not be convenient in many cases. To make it more convenient and get rid of the checked exception you can use UncheckedScalar or IoCheckedScalar decorators.

There is no thread-safety guarantee.

Since:

0.29

See Also:

UncheckedScalar, IoCheckedScalar

Nested Class Summary

Nested classes/interfaces inherited from interface org.cactoos.Scalar

Scalar.NoNulls<T>

Constructor Summary

Constructors

Constructor and Description
LowestOf(Iterable<Scalar<T>> iterable) Ctor.
LowestOf(Scalar<T>... scalars) Ctor.
LowestOf(T... items) Ctor.

Method Summary

Modifier and Type	Method and Description
T	value() Convert it to the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

LowestOf

@SafeVarargs
public LowestOf(T... items)

Ctor.

Parameters:

items - The comparable items

LowestOf

@SafeVarargs
public LowestOf(Scalar<T>... scalars)

Ctor.

Parameters:

scalars - The scalars

LowestOf

public LowestOf(Iterable<Scalar<T>> iterable)

Ctor.

Parameters:

iterable - The items

Method Detail

value

public T value()
        throws Exception

Description copied from interface: Scalar

Convert it to the value.

Specified by:

value in interface Scalar<T extends Comparable<T>>

Returns:

The value

Throws:

Exception - If fails