Class ComponentPathIterator

java.lang.Object

net.dv8tion.jda.api.components.utils.ComponentPathIterator

All Implemented Interfaces:

Iterator<ComponentPathIterator.ComponentWithPath>

public class ComponentPathIterator
extends Object
implements Iterator<ComponentPathIterator.ComponentWithPath>

Utility class to recursively iterate on a list of components while keeping track their path.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComponentPathIterator.ComponentWithPath

Method Summary

Modifier and Type	Method	Description
static ComponentPathIterator	create(String rootName, Collection<? extends Component> components)	Creates a ComponentPathIterator to recursively iterate on the provided components.
static Stream<ComponentPathIterator.ComponentWithPath>	createStream(String rootName, Collection<? extends Component> components)	Creates a Stream of ComponentPathIterator.ComponentWithPath which recursively iterates on the provided components.
boolean	hasNext()
ComponentPathIterator.ComponentWithPath	next()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Iterator

forEachRemaining, remove

Method Details

create

@Nonnull
public static ComponentPathIterator create(@Nonnull
 String rootName,
 @Nonnull
 Collection<? extends Component> components)

Creates a ComponentPathIterator to recursively iterate on the provided components.

Parameters:

components - The components to iterate on

Returns:

A new ComponentPathIterator

createStream

@Nonnull
public static Stream<ComponentPathIterator.ComponentWithPath> createStream(@Nonnull
 String rootName,
 @Nonnull
 Collection<? extends Component> components)

Creates a Stream of ComponentPathIterator.ComponentWithPath which recursively iterates on the provided components.

Parameters:

components - The components to iterate on

Returns:

A new, ordered Stream of ComponentPathIterator.ComponentWithPath

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<ComponentPathIterator.ComponentWithPath>

next

@Nonnull
public ComponentPathIterator.ComponentWithPath next()

Specified by:

next in interface Iterator<ComponentPathIterator.ComponentWithPath>