org.cactoos.scalar

Class AndWithIndex

java.lang.Object

org.cactoos.scalar.AndWithIndex

All Implemented Interfaces:

Scalar<Boolean>

public final class AndWithIndex
extends Object
implements Scalar<Boolean>

Logical conjunction, with index.

This class can be effectively used to iterate through a collection, just like Stream.forEach(java.util.function.Consumer) works, but with an index provided for each item:

 new UncheckedScalar<>(
     new AndWithIndex(
         new IterableOf<>("Mary", "John", "William", "Napkin"),
         new BiFuncOf<>((text, index) ->
             System.out.printf("| idx #%d: name: %s ", index, text), true)
     )
 ).value();
 // will print "| idx #0: name: Mary | idx #1: name: John |
 // idx #2: name: William | idx #3: name: Napkin " to console
 

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.20

Constructor Summary

Constructors

Constructor and Description
AndWithIndex(BiFunc<X,Integer,Boolean> func, Iterable<X> src) Ctor.
AndWithIndex(BiFunc<X,Integer,Boolean> func, X... src) Ctor.
AndWithIndex(BiProc<X,Integer> proc, Iterable<X> src) Ctor.
AndWithIndex(Func<Integer,Boolean>... src) Ctor.
AndWithIndex(Iterable<Func<Integer,Boolean>> src) Ctor.
AndWithIndex(Iterator<Func<Integer,Boolean>> src) Ctor.
AndWithIndex(Proc<X> proc, X... src) Ctor.

Method Summary

Modifier and Type	Method and Description
Boolean	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

AndWithIndex

@SafeVarargs
public AndWithIndex(Proc<X> proc,
                                 X... src)

Ctor.

Type Parameters:

X - Type of items in the iterable

Parameters:

proc - Proc to map

src - The iterable

AndWithIndex

@SafeVarargs
public AndWithIndex(BiFunc<X,Integer,Boolean> func,
                                 X... src)

Ctor.

Type Parameters:

X - Type of items in the iterable

Parameters:

func - Func to map

src - The iterable

AndWithIndex

public AndWithIndex(BiProc<X,Integer> proc,
                    Iterable<X> src)

Ctor.

Type Parameters:

X - Type of items in the iterable

Parameters:

src - The iterable

proc - Proc to use

Since:

0.24

AndWithIndex

public AndWithIndex(BiFunc<X,Integer,Boolean> func,
                    Iterable<X> src)

Ctor.

Type Parameters:

X - Type of items in the iterable

Parameters:

src - The iterable

func - Func to map

Since:

0.24

AndWithIndex

@SafeVarargs
public AndWithIndex(Func<Integer,Boolean>... src)

Ctor.

Parameters:

src - The iterable

AndWithIndex

public AndWithIndex(Iterator<Func<Integer,Boolean>> src)

Ctor.

Parameters:

src - The iterator

Since:

0.24

AndWithIndex

public AndWithIndex(Iterable<Func<Integer,Boolean>> src)

Ctor.

Parameters:

src - The iterable

Method Detail

value

public Boolean value()
              throws Exception

Description copied from interface: Scalar

Convert it to the value.

Specified by:

value in interface Scalar<Boolean>

Returns:

The value

Throws:

Exception - If fails