CountableFilterIterator

Class
extends FilterIterator
implements Countable
uses CountableIteratorIteratorTrait
Abstract: Yes

Provides a filter iterator implementation that is also countable.

Description

This abstract class SHALL extend FilterIterator so that concrete implementations MAY filter elements from an inner iterator while also exposing count semantics. The counting behavior MUST be provided through the composed trait and SHALL operate according to the characteristics of the wrapped inner iterator. Implementations SHOULD ensure that their filtering logic remains consistent with the sequence being counted.

Table of Contents

Interfaces

Countable

Methods

count()

Counts the number of elements exposed by the inner iterator.

 : int
Methods

count()

Public

Counts the number of elements exposed by the inner iterator.

public count() : int

Description

If the inner iterator implements Countable, this method SHALL return the value provided by that implementation. Otherwise, it MUST count elements by iterating over the iterator. If the inner iterator is not cloneable, this method SHALL wrap the current object in an IteratorIterator instance and count through that wrapper to avoid performing an invalid clone operation. If the inner iterator is cloneable, this method SHOULD count over a clone so that the original iterator state is preserved as much as possible.

Return values
int

Description

the total number of elements available from the inner iterator