Package net.kyori.adventure.text

Interface ComponentIteratorType

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@NonExtendable
@FunctionalInterface
public interface ComponentIteratorType

The iterator types.

Since:

4.9.0

See Also:

Component.iterator(ComponentIteratorType, Set), Component.iterable(ComponentIteratorType, Set), Component.spliterator(ComponentIteratorType, Set)

Field Summary

Fields

Modifier and Type	Field	Description
static ComponentIteratorType	BREADTH_FIRST	A breadth-first iteration.
static ComponentIteratorType	DEPTH_FIRST	A depth-first iteration.

Method Summary

Modifier and Type	Method	Description
void	populate(@NotNull Component component, @NotNull java.util.Deque<Component> deque, @NotNull java.util.Set<ComponentIteratorFlag> flags)	Populates a deque with the children of the provided component, based on the iterator type and flags.

Field Detail

DEPTH_FIRST

static final ComponentIteratorType DEPTH_FIRST

A depth-first iteration.

Since:

4.9.0

BREADTH_FIRST

static final ComponentIteratorType BREADTH_FIRST

A breadth-first iteration.

Since:

4.9.0

Method Detail

populate

void populate(@NotNull
              @NotNull Component component,
              @NotNull
              @NotNull java.util.Deque<Component> deque,
              @NotNull
              @NotNull java.util.Set<ComponentIteratorFlag> flags)

Populates a deque with the children of the provided component, based on the iterator type and flags.

Parameters:

component - the component

deque - the deque

flags - the flags

Since:

4.9.0