filterIndexed()

Filter a stream according to a given predicate, which takes both the item being examined and its index.

Implementation Notes

Signature

filterIndexed(BiPredicate<Long, INPUT> predicate)

predicate - A non-null BiPredicate<Long,INPUT> where the Long is the zero-based index of the element being filtered, and the INPUT is the element itself.

Examples

Keep the even-numbered elements, and anything that equals “T”

Stream
    .of("A", "B", "C", "T")
    .gather(Gatherers4j.filterWithIndex((index, element) -> index % 2 == 0 || element.equals("T")))
    .toList();

// ["A", "C", "T"]