Package cloud.commandframework.brigadier.argument

Interface StringReaderAsQueue

All Superinterfaces:

Collection<String>, Iterable<String>, Queue<String>

public interface StringReaderAsQueue
extends Queue<String>

An interface combining Queue behaviour with a Brigadier StringReader.

This can be implemented either by wrapping an existing StringReader instance, or extending StringReader at its creation time to implement this interface.

Since:

1.5.0

Method Summary

Modifier and Type	Method	Description
default boolean	add(String element)
default boolean	addAll(@NonNull Collection<? extends String> elements)
default void	clear()
default boolean	contains(Object element)
default boolean	containsAll(@NonNull Collection<?> elements)
default String	element()
static StringReaderAsQueue	from(com.mojang.brigadier.StringReader reader)	Given an existing Brigadier StringReader, get a view of it as a Queue
com.mojang.brigadier.StringReader	getOriginal()	Get the backing StringReader used to source data.
default boolean	isEmpty()
default @NonNull Iterator<String>	iterator()
default boolean	offer(String element)
default String	remove()
default boolean	removeAll(@NonNull Collection<?> elements)
default boolean	retainAll(@NonNull Collection<?> elements)
default Object[]	toArray()
default <T> T[]	toArray(T[] a)

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, remove, removeIf, size, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Queue

peek, poll

Method Details

from

static StringReaderAsQueue from(com.mojang.brigadier.StringReader reader)

Given an existing Brigadier StringReader, get a view of it as a Queue

Parameters:

reader - the input reader

Returns:

a view of the contents of the reader as a Queue split by word.

getOriginal

com.mojang.brigadier.StringReader getOriginal()

Get the backing StringReader used to source data.

Returns:

the original reader

isEmpty

default boolean isEmpty()

Specified by:

isEmpty in interface Collection<String>

contains

default boolean contains(Object element)

Specified by:

contains in interface Collection<String>

iterator

default @NonNull Iterator<String> iterator()

Specified by:

iterator in interface Collection<String>

Specified by:

iterator in interface Iterable<String>

toArray

default Object[] toArray()

Specified by:

toArray in interface Collection<String>

toArray

default <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<String>

add

default boolean add(String element)

Specified by:

add in interface Collection<String>

Specified by:

add in interface Queue<String>

offer

default boolean offer(String element)

Specified by:

offer in interface Queue<String>

remove

default String remove()

Specified by:

remove in interface Queue<String>

element

default String element()

Specified by:

element in interface Queue<String>

containsAll

default boolean containsAll(@NonNull Collection<?> elements)

Specified by:

containsAll in interface Collection<String>

addAll

default boolean addAll(@NonNull Collection<? extends String> elements)

Specified by:

addAll in interface Collection<String>

removeAll

default boolean removeAll(@NonNull Collection<?> elements)

Specified by:

removeAll in interface Collection<String>

retainAll

default boolean retainAll(@NonNull Collection<?> elements)

Specified by:

retainAll in interface Collection<String>

clear

default void clear()

Specified by:

clear in interface Collection<String>