Module net.kyori.adventure.api

Package net.kyori.adventure.text

Interface ComponentIteratorType

public sealed 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 final ComponentIteratorType	BREADTH_FIRST	A breadth-first iteration.
static final ComponentIteratorType	DEPTH_FIRST	A depth-first iteration.

Method Summary

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

Field Details

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 Details

populate

void populate(Component component,
 Deque<Component> deque,
 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