Package studio.mevera.imperat.context

Interface ArgumentInput

All Superinterfaces:

Cloneable, Collection<String>, Deque<String>, Iterable<String>, List<String>, Queue<String>

@AvailableSince("1.0.0")
public interface ArgumentInput
extends Deque<String>, List<String>, Cloneable

Represents a custom data structure made specifically for handling the arguments entered by the Source

Method Summary

Modifier and Type	Method	Description
@NotNull ArgumentInput	copy()	Returns an independent copy of this argument stack.
static ArgumentInput	empty()
default @Nullable String	getOr(int index, @Nullable String def)	Fetches the element at the specified index
String	getOriginalRaw()
@NotNull String	join(@NotNull String delimiter, int startIndex)	Joins all present arguments in this stack, starting from the specified index
@NotNull String	join(String delimiter)	Joins all present arguments in this stack
static ArgumentInput	of(String originalLine)
static ArgumentInput	parse(String string)
static ArgumentInput	parse(String[] rawArguments)
static ArgumentInput	parseAutoCompletion(String[] argumentsOnly, boolean extraLastSpace)
static ArgumentInput	parseAutoCompletion(String string, boolean extraLastSpace)

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.util.Deque

add, addAll, addFirst, addLast, contains, descendingIterator, element, getFirst, getLast, iterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, size

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Method Details

parse

static ArgumentInput parse(String[] rawArguments)

parse

static ArgumentInput parse(String string)

parseAutoCompletion

static ArgumentInput parseAutoCompletion(String[] argumentsOnly,
 boolean extraLastSpace)

parseAutoCompletion

static ArgumentInput parseAutoCompletion(String string,
 boolean extraLastSpace)

of

static ArgumentInput of(String originalLine)

Returns:

a new, empty ArgumentInput.

empty

static ArgumentInput empty()

Returns:

a new, empty ArgumentInput.

getOriginalRaw

String getOriginalRaw()

getOr

@Nullable
default @Nullable String getOr(int index,
 @Nullable
 @Nullable String def)

Fetches the element at the specified index

Parameters:

index - the index

def - the default element

Returns:

the element at the specified index.

join

@NotNull
@NotNull String join(String delimiter)

Joins all present arguments in this stack

Parameters:

delimiter - Delimiter between these arguments.

Returns:

The combined string

join

@NotNull
@NotNull String join(@NotNull
 @NotNull String delimiter,
 int startIndex)

Joins all present arguments in this stack, starting from the specified index

Parameters:

delimiter - Delimiter between these arguments

startIndex - The start index to combine from

Returns:

The combined string

copy

@NotNull
@NotNull ArgumentInput copy()

Returns an independent copy of this argument stack.

Returns:

A copy of this argument stack