org.cactoos.scalar

Class HighestOf<T extends Comparable<T>>

java.lang.Object

org.cactoos.scalar.HighestOf<T>

Type Parameters:

T - Scalar type

All Implemented Interfaces:

Scalar<T>

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

Find the highest item.

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

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

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

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 the UncheckedScalar decorator. Or you may use IoCheckedScalar to wrap it in an IOException.

There is no thread-safety guarantee.

Since:

0.29

See Also:

UncheckedScalar, IoCheckedScalar

Constructor Summary

Constructors

Constructor and Description
HighestOf(Iterable<Scalar<T>> iterable) Ctor.
HighestOf(Scalar<T>... scalars) Ctor.
HighestOf(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

HighestOf

@SafeVarargs
public HighestOf(T... items)

Ctor.

Parameters:

items - The comparable items

HighestOf

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

Ctor.

Parameters:

scalars - The scalars

HighestOf

public HighestOf(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