Package io.deephaven.engine.primitive.value.iterator

Interface ValueIteratorOfChar

All Superinterfaces:

AutoCloseable, CloseableIterator<Character>, CloseablePrimitiveIterator<Character,CharConsumer>, CloseablePrimitiveIteratorOfChar, Iterator<Character>, PrimitiveIterator<Character,CharConsumer>, ValueIterator<Character>

All Known Subinterfaces:

CharacterColumnIterator

All Known Implementing Classes:

ChunkedCharacterColumnIterator, SerialCharacterColumnIterator

public interface ValueIteratorOfChar
extends CloseablePrimitiveIteratorOfChar, ValueIterator<Character>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.PrimitiveIterator

PrimitiveIterator.OfDouble, PrimitiveIterator.OfInt, PrimitiveIterator.OfLong

Field Summary

Fields

Modifier and Type	Field	Description
static final ValueIteratorOfChar	EMPTY	A re-usable, immutable ValueIteratorOfChar with no elements.

Method Summary

Modifier and Type	Method	Description
static ValueIteratorOfChar	empty()	Get a ValueIteratorOfChar with no elements.
default void	forEachRemaining(@NotNull Consumer<? super Character> action)
default Character	next()
static ValueIteratorOfChar	of(@org.jetbrains.annotations.NotNull char... values)	Create a ValueIteratorOfChar over an array of char.
default IntStream	streamAsInt()	Create an unboxed IntStream over the remaining elements of this ValueIteratorOfChar by casting each element to int with the appropriate adjustment of NULL_CHAR to NULL_INT.
default IntStream	streamAsInt(@NotNull CharToIntFunction adapter)	Create an IntStream over the remaining elements of this ValueIteratorOfChar by applying adapter to each element.
static ValueIteratorOfChar	wrapWithNulls(@Nullable ValueIteratorOfChar iterator, long prefixNulls, long postfixNulls)	Wraps a ValueIteratorOfChar with set number of prefix nulls, postfix nulls, or both.

Methods inherited from interface io.deephaven.engine.primitive.iterator.CloseableIterator

close

Methods inherited from interface io.deephaven.engine.primitive.iterator.CloseablePrimitiveIteratorOfChar

adaptToOfInt, forEachRemaining, nextChar

Methods inherited from interface java.util.Iterator

hasNext, remove

Methods inherited from interface io.deephaven.engine.primitive.value.iterator.ValueIterator

remaining, stream

Field Details

EMPTY

static final ValueIteratorOfChar EMPTY

A re-usable, immutable ValueIteratorOfChar with no elements.

Method Details

next

@FinalDefault
default Character next()

Specified by:

next in interface CloseablePrimitiveIteratorOfChar

Specified by:

next in interface Iterator<Character>

forEachRemaining

@FinalDefault
default void forEachRemaining(@NotNull
 @NotNull Consumer<? super Character> action)

Specified by:

forEachRemaining in interface CloseablePrimitiveIteratorOfChar

Specified by:

forEachRemaining in interface Iterator<Character>

streamAsInt

@FinalDefault
default IntStream streamAsInt()

Create an unboxed IntStream over the remaining elements of this ValueIteratorOfChar by casting each element to int with the appropriate adjustment of NULL_CHAR to NULL_INT. The result must be closed in order to ensure resources are released. A try-with-resources block is strongly encouraged.

Specified by:

streamAsInt in interface CloseablePrimitiveIteratorOfChar

Returns:

An unboxed IntStream over the remaining contents of this iterator. Must be closed.

streamAsInt

@FinalDefault
default IntStream streamAsInt(@NotNull
 @NotNull CharToIntFunction adapter)

Create an IntStream over the remaining elements of this ValueIteratorOfChar by applying adapter to each element. The result must be closed in order to ensure resources are released. A try-with-resources block is strongly encouraged.

Specified by:

streamAsInt in interface CloseablePrimitiveIteratorOfChar

Returns:

An IntStream over the remaining contents of this iterator. Must be closed.

empty

static ValueIteratorOfChar empty()

Get a ValueIteratorOfChar with no elements. The result does not need to be closed.

Returns:

A ValueIteratorOfChar with no elements

of

static ValueIteratorOfChar of(@NotNull
 @org.jetbrains.annotations.NotNull char... values)

Create a ValueIteratorOfChar over an array of char. The result does not need to be closed.

Parameters:

values - The elements to iterate

Returns:

A ValueIteratorOfChar of values

wrapWithNulls

static ValueIteratorOfChar wrapWithNulls(@Nullable
 @Nullable ValueIteratorOfChar iterator,
 long prefixNulls,
 long postfixNulls)

Wraps a ValueIteratorOfChar with set number of prefix nulls, postfix nulls, or both. The result must be closed.

Parameters:

iterator - The ValueIteratorOfChar to wrap

prefixNulls - The number of nulls to add to the beginning of the iterator

postfixNulls - The number of nulls to add to the end of the iterator

Returns:

A ValueIteratorOfChar with the specified number of prefix and postfix nulls