Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

addArgument(String, Object) - Method in class net.lenni0451.commandlib.contexts.ExecutionContext
Add a parsed argument.
and(ArgumentRequirement<E>...) - Static method in class net.lenni0451.commandlib.utils.Util
And chain multiple argument requirements.
arg(String, ArgumentType<E, T>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Start building an argument and add it to the line.
arg(String, String, ArgumentType<E, T>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Start building an argument and add it to the line.
ArgumentBuilder<E> - Interface in net.lenni0451.commandlib.builder
A convenience interface to allow for the easy creation of arguments.
ArgumentChain<E> - Class in net.lenni0451.commandlib
A chain of arguments required for correct execution.
ArgumentChain.MatchedArgument - Class in net.lenni0451.commandlib
A wrapper for an argument that has been matched.
ArgumentComparator - Class in net.lenni0451.commandlib.utils.comparator
Used to compare strings in a case-sensitive or case-insensitive way.
ArgumentComparator() - Constructor for class net.lenni0451.commandlib.utils.comparator.ArgumentComparator
 
ArgumentNode<E,T> - Class in net.lenni0451.commandlib.nodes
The abstract argument node class containing all methods required to build a customizable argument tree.
ArgumentNode(String) - Constructor for class net.lenni0451.commandlib.nodes.ArgumentNode
 
ArgumentNode(String, String) - Constructor for class net.lenni0451.commandlib.nodes.ArgumentNode
 
ArgumentParseException - Exception in net.lenni0451.commandlib.exceptions
An exception which is thrown when an argument could not be parsed.
ArgumentRequirement<E> - Interface in net.lenni0451.commandlib.utils.interfaces
A functional interface to allow checking if a command can be executed.
ArgumentType<E,T> - Interface in net.lenni0451.commandlib.types
The argument type is a simple wrapper interface to argument nodes.

B

beautify(Enum<?>, boolean) - Static method in class net.lenni0451.commandlib.utils.Util
Beautify the name of an enum value.
buildChains(ArgumentNode<E, ?>) - Static method in class net.lenni0451.commandlib.ArgumentChain
Build a list of all chains for the given argument node.

C

canRead() - Method in class net.lenni0451.commandlib.utils.StringReader
 
canRead(int) - Method in class net.lenni0451.commandlib.utils.StringReader
Get if the reader can read the given amount of characters.
CASE_INSENSITIVE - Static variable in class net.lenni0451.commandlib.utils.comparator.ArgumentComparator
A case-insensitive comparator.
CASE_SENSITIVE - Static variable in class net.lenni0451.commandlib.utils.comparator.ArgumentComparator
A case-sensitive comparator.
cast(Object) - Static method in class net.lenni0451.commandlib.utils.Util
Cast anything to anything else.
ChainExecutionException - Exception in net.lenni0451.commandlib.exceptions
An exception which is thrown when the execution of a command chain fails.
ChainExecutionException(ArgumentParseException, int, int, String, String) - Constructor for exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
ChainExecutionException(RuntimeException, int, int, String, String) - Constructor for exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
ChainExecutionException(HandledException, int, int, String, String) - Constructor for exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
ChainExecutionException(ChainExecutionException.Reason, int, int, String, String) - Constructor for exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
ChainExecutionException(ChainExecutionException, int) - Constructor for exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
ChainExecutionException.Reason - Enum in net.lenni0451.commandlib.exceptions
The reason why the execution failed.
children() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
children() - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
CloseChainsComparator<E> - Class in net.lenni0451.commandlib.utils.comparator
Compare failed argument chains by their reason.
CloseChainsComparator() - Constructor for class net.lenni0451.commandlib.utils.comparator.CloseChainsComparator
 
CommandExceptionHandler<E> - Interface in net.lenni0451.commandlib.utils.interfaces
A functional interface to allow handling exceptions thrown when parsing arguments.
CommandExecutionException - Exception in net.lenni0451.commandlib.exceptions
An exception which is thrown when an error occurs during the execution of a command.
CommandExecutionException(String) - Constructor for exception net.lenni0451.commandlib.exceptions.CommandExecutionException
 
CommandExecutionException(String, List<ParseResult.FailedChain<?>>) - Constructor for exception net.lenni0451.commandlib.exceptions.CommandExecutionException
 
CommandExecutor<E> - Class in net.lenni0451.commandlib
The handler for all registered commands.
CommandExecutor() - Constructor for class net.lenni0451.commandlib.CommandExecutor
 
CommandExecutor(ArgumentComparator) - Constructor for class net.lenni0451.commandlib.CommandExecutor
 
compare(String, String) - Method in class net.lenni0451.commandlib.utils.comparator.ArgumentComparator
Compare if two strings are equal.
compare(ParseResult.FailedChain<E>, ParseResult.FailedChain<E>) - Method in class net.lenni0451.commandlib.utils.comparator.CloseChainsComparator
 
compare(Completion, Completion) - Method in class net.lenni0451.commandlib.utils.comparator.CompletionsComparator
 
compareTo(String, String) - Method in class net.lenni0451.commandlib.utils.comparator.ArgumentComparator
Compare two strings.
complete(Set<String>, String[], ExecutionContext<E>) - Method in interface net.lenni0451.commandlib.nodes.StringArrayNode.Completor
 
Completion - Class in net.lenni0451.commandlib
A completion for the user input suggesting what the user might want to type.
Completion(int, String) - Constructor for class net.lenni0451.commandlib.Completion
 
CompletionContext - Class in net.lenni0451.commandlib.contexts
A context which is used to store information about the completion process.
CompletionContext() - Constructor for class net.lenni0451.commandlib.contexts.CompletionContext
 
completions(CompletionsProvider<E>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Add a completions provider to the last added argument.
completions(E, String) - Method in class net.lenni0451.commandlib.CommandExecutor
Get completions for the given command input.
completions(E, StringReader) - Method in class net.lenni0451.commandlib.CommandExecutor
Get completions for the given command input.
completions(CompletionsProvider<E>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Set the custom completions provider of this argument node.
completions(CompletionsProvider<E>) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
CompletionsComparator - Class in net.lenni0451.commandlib.utils.comparator
A comparator to sort command completions.
CompletionsComparator(ArgumentComparator) - Constructor for class net.lenni0451.commandlib.utils.comparator.CompletionsComparator
 
completionsProvider() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
completionsProvider() - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
CompletionsProvider<E> - Interface in net.lenni0451.commandlib.utils.interfaces
A functional interface to allow supplying custom completions.
create() - Static method in class net.lenni0451.commandlib.builder.LineBuilder
Create a new line builder.

D

DECIMAL_PATTERN - Static variable in class net.lenni0451.commandlib.utils.Util
A pattern to check if a string is a decimal number.
defaultValue(T) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Set the default value of the last added argument.
description() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
dynamicType(DynamicType.SingleParser<T>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a dynamic parsing argument type.
dynamicType(DynamicType.BiParser<E, T>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a dynamic parsing argument type.
DynamicType<E,T> - Class in net.lenni0451.commandlib.types
 
DynamicType(DynamicType.SingleParser<T>) - Constructor for class net.lenni0451.commandlib.types.DynamicType
 
DynamicType(DynamicType.BiParser<E, T>) - Constructor for class net.lenni0451.commandlib.types.DynamicType
 
DynamicType.BiParser<E,T> - Interface in net.lenni0451.commandlib.types
 
DynamicType.SingleParser<T> - Interface in net.lenni0451.commandlib.types
 

E

ensureLength(int) - Method in class net.lenni0451.commandlib.utils.StringReader
Ensure that the reader can read the given amount of characters.
EnumType<E,T extends java.lang.Enum<T>> - Class in net.lenni0451.commandlib.types
The enum type parses an enum value from the string reader.
equals(Object) - Method in class net.lenni0451.commandlib.Completion
 
exceptionHandler(CommandExceptionHandler<E>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Add an exception handler to the last added argument.
exceptionHandler() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
exceptionHandler(CommandExceptionHandler<E>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Set the exception handler of this argument node.
exceptionHandler() - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
exceptionHandler(CommandExceptionHandler<E>) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
execute(E, String) - Method in class net.lenni0451.commandlib.CommandExecutor
Execute the given command input.
execute(E, StringReader) - Method in class net.lenni0451.commandlib.CommandExecutor
Execute the given command input.
execute(E, String[], ExecutionContext<E>) - Method in interface net.lenni0451.commandlib.nodes.StringArrayNode.Executor
 
executes(Runnable) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Set the Runnable executor of the line and build the line into an ArgumentNode.
executes(Consumer<ExecutionContext<E>>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Set the Consumer executor of the line and build the line into an ArgumentNode.
executes(Supplier<R>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Set the Supplier executor of the line and build the line into an ArgumentNode.
executes(Function<ExecutionContext<E>, R>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Set the Function executor of the line and build the line into an ArgumentNode.
executes(Runnable) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Set the Runnable executor of this argument node.
executes(Consumer<ExecutionContext<E>>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Set the Consumer executor of this argument node.
executes(Supplier<?>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Set the Supplier executor of this argument node.
executes(Function<ExecutionContext<E>, ?>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Set the Function executor of this argument node.
executes(Runnable) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
executes(Consumer<ExecutionContext<E>>) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
executes(Supplier<?>) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
executes(Function<ExecutionContext<E>, ?>) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
ExecutionContext<E> - Class in net.lenni0451.commandlib.contexts
A context which is used to store information about the execution process.
ExecutionContext(ArgumentComparator, E, boolean) - Constructor for class net.lenni0451.commandlib.contexts.ExecutionContext
 
executor() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
executor() - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
expected(String) - Static method in exception net.lenni0451.commandlib.exceptions.ArgumentParseException
Create a new exception with the given expected value.

F

FailedChain(ArgumentChain<E>, ChainExecutionException) - Constructor for class net.lenni0451.commandlib.ParseResult.FailedChain
 
fillInStackTrace() - Method in exception net.lenni0451.commandlib.exceptions.HandledException
 

G

get() - Method in interface net.lenni0451.commandlib.utils.interfaces.ThrowingSupplier
Get the value.
getArgument(int) - Method in class net.lenni0451.commandlib.ArgumentChain
Get an argument node by its index.
getArgument(String) - Method in class net.lenni0451.commandlib.contexts.ExecutionContext
Get a parsed argument by its name.
getArgumentChain() - Method in class net.lenni0451.commandlib.ParseResult.FailedChain
 
getArgumentChain() - Method in class net.lenni0451.commandlib.ParseResult.ParsedChain
 
getArgumentComparator() - Method in class net.lenni0451.commandlib.contexts.ExecutionContext
 
getArgumentName() - Method in exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
getArguments() - Method in class net.lenni0451.commandlib.contexts.ExecutionContext
 
getClosest(List<ParseResult.FailedChain<E>>) - Static method in class net.lenni0451.commandlib.utils.comparator.CloseChainsComparator
Sort the given list of failed chains by their reason.
getCommand() - Method in exception net.lenni0451.commandlib.exceptions.CommandExecutionException
 
getCompletion() - Method in class net.lenni0451.commandlib.Completion
 
getCompletionsTrim() - Method in class net.lenni0451.commandlib.contexts.CompletionContext
 
getCursor() - Method in class net.lenni0451.commandlib.ArgumentChain.MatchedArgument
 
getCursor() - Method in class net.lenni0451.commandlib.utils.StringReader
 
getExecutionException() - Method in class net.lenni0451.commandlib.ParseResult.FailedChain
 
getExecutionIndex() - Method in exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
getExecutor() - Method in class net.lenni0451.commandlib.ArgumentChain
Get the executor of this chain.
getExecutor() - Method in class net.lenni0451.commandlib.contexts.ExecutionContext
 
getExtraData() - Method in exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
getFailedChains() - Method in class net.lenni0451.commandlib.ParseResult
 
getLength() - Method in class net.lenni0451.commandlib.ArgumentChain
 
getMatch() - Method in class net.lenni0451.commandlib.ArgumentChain.MatchedArgument
 
getMatchedArguments() - Method in class net.lenni0451.commandlib.ParseResult.ParsedChain
 
getMostLikelyChains() - Method in exception net.lenni0451.commandlib.exceptions.CommandExecutionException
 
getParsedChains() - Method in class net.lenni0451.commandlib.ParseResult
 
getReaderCursor() - Method in exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
getReason() - Method in exception net.lenni0451.commandlib.exceptions.ChainExecutionException
 
getStackTrace() - Method in exception net.lenni0451.commandlib.exceptions.HandledException
 
getStart() - Method in class net.lenni0451.commandlib.Completion
The start of a completion is the index in the input where the completion starts.
getString() - Method in class net.lenni0451.commandlib.utils.StringReader
 
getTargetChains() - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
getTargetNode() - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
getValue() - Method in class net.lenni0451.commandlib.ArgumentChain.MatchedArgument
 
getWeight() - Method in interface net.lenni0451.commandlib.types.ArgumentType
 
getWeight() - Method in class net.lenni0451.commandlib.types.EnumType
 
getWeight() - Method in class net.lenni0451.commandlib.types.IntegerType
 
getWeight() - Method in class net.lenni0451.commandlib.types.StringType
 
getWeights() - Method in class net.lenni0451.commandlib.ArgumentChain
 
greedyString() - Static method in class net.lenni0451.commandlib.types.StringType
Create a new string type that parses a string that contains all remaining characters.

H

handle(ExecutionContext<E>, Exception) - Method in interface net.lenni0451.commandlib.utils.interfaces.CommandExceptionHandler
Handle the thrown exception.
HandledException - Exception in net.lenni0451.commandlib.exceptions
A wrapper exception which is used to mark the original exception as handled by a CommandExceptionHandler.
HandledException(Throwable) - Constructor for exception net.lenni0451.commandlib.exceptions.HandledException
 
hashCode() - Method in class net.lenni0451.commandlib.Completion
 

I

INT_PATTERN - Static variable in class net.lenni0451.commandlib.utils.Util
A pattern to check if a string is an integer number.
integer() - Static method in class net.lenni0451.commandlib.types.IntegerType
Create a new integer type with no min and max value.
integer(int, int) - Static method in class net.lenni0451.commandlib.types.IntegerType
Create a new integer type with a min and max value.
IntegerType<E> - Class in net.lenni0451.commandlib.types
The integer type parses an integer number from the string reader.
isExecution() - Method in class net.lenni0451.commandlib.contexts.ExecutionContext
 

L

length() - Method in class net.lenni0451.commandlib.utils.StringReader
 
line() - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
 
LineBuilder<E> - Class in net.lenni0451.commandlib.builder
Easily build a line of arguments into an ArgumentNode.
list(String, ArgumentType<E, T>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new list argument node.
list(String, String, ArgumentType<E, T>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new list argument node.
ListNode<E,T> - Class in net.lenni0451.commandlib.nodes
The list node can be used to parse the same argument multiple times.
ListNode(String, ArgumentType<E, T>) - Constructor for class net.lenni0451.commandlib.nodes.ListNode
 
ListNode(String, String, ArgumentType<E, T>) - Constructor for class net.lenni0451.commandlib.nodes.ListNode
 

M

maxInteger(int) - Static method in class net.lenni0451.commandlib.types.IntegerType
Create a new integer type with a max value.
merge(ArgumentChain<E>, ArgumentChain<E>) - Static method in class net.lenni0451.commandlib.ArgumentChain
 
minInteger(int) - Static method in class net.lenni0451.commandlib.types.IntegerType
Create a new integer type with a min value.

N

name() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
named(String) - Static method in exception net.lenni0451.commandlib.exceptions.ArgumentParseException
Create a new exception with the given name of the argument.
namedExpected(String, String) - Static method in exception net.lenni0451.commandlib.exceptions.ArgumentParseException
Create a new exception with the given name of the argument and the expected value.
namedReason(String, String) - Static method in exception net.lenni0451.commandlib.exceptions.ArgumentParseException
Create a new exception with the given name of the argument and the reason.
net.lenni0451.commandlib - package net.lenni0451.commandlib
 
net.lenni0451.commandlib.builder - package net.lenni0451.commandlib.builder
 
net.lenni0451.commandlib.contexts - package net.lenni0451.commandlib.contexts
 
net.lenni0451.commandlib.exceptions - package net.lenni0451.commandlib.exceptions
 
net.lenni0451.commandlib.nodes - package net.lenni0451.commandlib.nodes
 
net.lenni0451.commandlib.types - package net.lenni0451.commandlib.types
 
net.lenni0451.commandlib.utils - package net.lenni0451.commandlib.utils
 
net.lenni0451.commandlib.utils.comparator - package net.lenni0451.commandlib.utils.comparator
 
net.lenni0451.commandlib.utils.interfaces - package net.lenni0451.commandlib.utils.interfaces
 
node(ArgumentNode<E, ?>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Add an existing node to the line.

O

of(String) - Static method in exception net.lenni0451.commandlib.exceptions.ArgumentParseException
Create a new exception with the given message.
of(Class<T>) - Static method in class net.lenni0451.commandlib.types.EnumType
Create a new enum type.
ofThrowing(ThrowingSupplier<T>) - Static method in class net.lenni0451.commandlib.utils.Util
Get an optional from a throwing supplier.

P

parse(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.ArgumentChain
Parse the given input and return the parsed arguments.
parse(ExecutionContext<E>, StringReader) - Method in interface net.lenni0451.commandlib.types.DynamicType.BiParser
 
parse(StringReader) - Method in interface net.lenni0451.commandlib.types.DynamicType.SingleParser
 
parseCompletions(CompletionContext, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Provide the completions of this argument.
parseCompletions(Set<String>, CompletionContext, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Provide the completions of this argument.
parseCompletions(Set<String>, CompletionContext, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.ListNode
 
parseCompletions(Set<String>, CompletionContext, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
parseCompletions(Set<String>, CompletionContext, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.StringArrayNode
 
parseCompletions(Set<String>, CompletionContext, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.StringNode
 
parseCompletions(Set<String>, CompletionContext, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.TypedNode
 
parseCompletions(Set<String>, ExecutionContext<E>, StringReader) - Method in interface net.lenni0451.commandlib.types.ArgumentType
Provide the completions of this argument.
parseCompletions(Set<String>, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.types.DynamicType
 
parseCompletions(Set<String>, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.types.EnumType
 
parseCompletions(Set<String>, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.types.IntegerType
 
parseCompletions(Set<String>, ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.types.StringType
 
ParsedChain(ArgumentChain<E>, List<ArgumentChain.MatchedArgument>) - Constructor for class net.lenni0451.commandlib.ParseResult.ParsedChain
 
ParseResult<E> - Class in net.lenni0451.commandlib
Storage for all parsed argument chains.
ParseResult(List<ParseResult.ParsedChain<E>>, List<ParseResult.FailedChain<E>>) - Constructor for class net.lenni0451.commandlib.ParseResult
 
ParseResult.FailedChain<E> - Class in net.lenni0451.commandlib
 
ParseResult.ParsedChain<E> - Class in net.lenni0451.commandlib
 
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Parse the value of this argument.
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.ListNode
 
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.StringArrayNode
 
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.StringNode
 
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.TypedNode
 
parseValue(ExecutionContext<E>, StringReader) - Method in interface net.lenni0451.commandlib.types.ArgumentType
Parses the value of the argument.
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.types.DynamicType
 
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.types.EnumType
 
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.types.IntegerType
 
parseValue(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.types.StringType
 
peek() - Method in class net.lenni0451.commandlib.utils.StringReader
 
peek(int) - Method in class net.lenni0451.commandlib.utils.StringReader
Get the character with the given offset without moving the cursor.
peekRemaining() - Method in class net.lenni0451.commandlib.utils.StringReader
 
populateArguments(ExecutionContext<E>, List<ArgumentChain.MatchedArgument>) - Method in class net.lenni0451.commandlib.ArgumentChain
Populate the given execution context with the given arguments.
prepend(Set<String>, String) - Static method in class net.lenni0451.commandlib.utils.Util
Prepend all strings in a set with a prefix.
provide(Set<String>, ExecutionContext<E>, StringReader) - Method in interface net.lenni0451.commandlib.utils.interfaces.CompletionsProvider
Provide custom completions.
providesArgument - Variable in class net.lenni0451.commandlib.nodes.ArgumentNode
 
providesArgument() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
providesArgument() - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 

R

read() - Method in class net.lenni0451.commandlib.utils.StringReader
 
read(int) - Method in class net.lenni0451.commandlib.utils.StringReader
Read the given amount of characters and move the cursor by the given amount of characters.
readDecimalNumber() - Method in class net.lenni0451.commandlib.utils.StringReader
Read a word and ensure that it is a valid decimal number.
readIntegerNumber() - Method in class net.lenni0451.commandlib.utils.StringReader
Read a word and ensure that it is a valid integer number.
readRemaining() - Method in class net.lenni0451.commandlib.utils.StringReader
 
readString() - Method in class net.lenni0451.commandlib.utils.StringReader
Read a string starting with a single or double quote.
readUntil(char) - Method in class net.lenni0451.commandlib.utils.StringReader
Read until the given character is found or the end of the string is reached.
readUntil(char, boolean) - Method in class net.lenni0451.commandlib.utils.StringReader
Read until the given character is found or the end of the string is reached.
readWord() - Method in class net.lenni0451.commandlib.utils.StringReader
Read a word until the next whitespace character is found.
readWordOrString() - Method in class net.lenni0451.commandlib.utils.StringReader
Read a word or a string if the next character is a single or double quote.
reason(String) - Static method in exception net.lenni0451.commandlib.exceptions.ArgumentParseException
Create a new exception with the given reason.
redirect(ArgumentNode<E, ?>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a redirect node.
RedirectNode<E> - Class in net.lenni0451.commandlib.nodes
A node that redirects the execution to another node.
RedirectNode(ArgumentNode<E, ?>) - Constructor for class net.lenni0451.commandlib.nodes.RedirectNode
 
register(ArgumentNode<E, ?>) - Method in class net.lenni0451.commandlib.CommandExecutor
Register an argument node.
register(StringNode<E>) - Method in class net.lenni0451.commandlib.CommandExecutor
Register a string argument node.
remaining() - Method in class net.lenni0451.commandlib.utils.StringReader
 
require(char...) - Method in class net.lenni0451.commandlib.utils.StringReader
Require the next character to be in the given array.
requirement() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
requires(ArgumentRequirement<E>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Set the requirement of this argument node.

S

setCompletionsTrim(int) - Method in class net.lenni0451.commandlib.contexts.CompletionContext
Set the amount of characters that should be trimmed from the completions.
setCursor(int) - Method in class net.lenni0451.commandlib.utils.StringReader
Set the cursor position.
skip() - Method in class net.lenni0451.commandlib.utils.StringReader
Move the cursor by one character.
skip(int) - Method in class net.lenni0451.commandlib.utils.StringReader
Move the cursor by the given amount of characters.
skipRequiredWhitespace() - Method in class net.lenni0451.commandlib.utils.StringReader
Skip all whitespace characters and ensure that at least one character was skipped.
skipRequiredWhitespaceOrEOL() - Method in class net.lenni0451.commandlib.utils.StringReader
Skip all whitespace characters and ensure that at least one character was skipped.
skipWhitespace() - Method in class net.lenni0451.commandlib.utils.StringReader
Skip all whitespace characters.
sortMap(Map<K, V>, Comparator<Map.Entry<K, V>>) - Static method in class net.lenni0451.commandlib.utils.Util
Sort a map by a comparator.
startsWith(String, String) - Method in class net.lenni0451.commandlib.utils.comparator.ArgumentComparator
Check if string a starts with string b.
string(String) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new string argument node.
string(String, String) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new string argument node.
string() - Static method in class net.lenni0451.commandlib.types.StringType
Create a new string type that parses a single word or a string surrounded by single or double quotes.
stringArray(String, StringArrayNode.Executor<E>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new string array argument node.
stringArray(String, StringArrayNode.Executor<E>, StringArrayNode.Completor<E>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new string array argument node.
stringArray(String, String, StringArrayNode.Executor<E>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new string array argument node.
stringArray(String, String, StringArrayNode.Executor<E>, StringArrayNode.Completor<E>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new string array argument node.
StringArrayNode<E> - Class in net.lenni0451.commandlib.nodes
The string array node can be used to handle an argument the traditional way by only receiving a string array.
StringArrayNode(String, StringArrayNode.Completor<E>) - Constructor for class net.lenni0451.commandlib.nodes.StringArrayNode
 
StringArrayNode(String, String, StringArrayNode.Completor<E>) - Constructor for class net.lenni0451.commandlib.nodes.StringArrayNode
 
StringArrayNode.Completor<E> - Interface in net.lenni0451.commandlib.nodes
The completor interface for the string array node.
StringArrayNode.Executor<E> - Interface in net.lenni0451.commandlib.nodes
The executor interface for the string array node.
StringNode<E> - Class in net.lenni0451.commandlib.nodes
The string node only matches the given string.
StringNode(String) - Constructor for class net.lenni0451.commandlib.nodes.StringNode
 
StringNode(String, String) - Constructor for class net.lenni0451.commandlib.nodes.StringNode
 
StringReader - Class in net.lenni0451.commandlib.utils
A simple string reader used for parsing arguments.
StringReader(String) - Constructor for class net.lenni0451.commandlib.utils.StringReader
 
StringType<E> - Class in net.lenni0451.commandlib.types
The string type parses a string from the string reader.

T

test(ExecutionContext<E>) - Method in interface net.lenni0451.commandlib.utils.interfaces.ArgumentRequirement
Test if the command can be executed.
then(ArgumentNode<E, ?>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Add a child to this argument node.
then(List<ArgumentNode<E, ?>>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Add multiple children to this argument node.
then(List<ArgumentNode<E, ?>>) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
then(ArgumentNode<E, ?>) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
ThrowingSupplier<T> - Interface in net.lenni0451.commandlib.utils.interfaces
A functional interface equivalent to Supplier but with the ability to throw an exception.
toString() - Method in class net.lenni0451.commandlib.ArgumentChain
 
toString(boolean) - Method in class net.lenni0451.commandlib.ArgumentChain
 
toString() - Method in class net.lenni0451.commandlib.Completion
 
typed(String, ArgumentType<E, T>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new typed argument node.
typed(String, String, ArgumentType<E, T>) - Method in interface net.lenni0451.commandlib.builder.ArgumentBuilder
Create a new typed argument node.
TypedNode<E,T> - Class in net.lenni0451.commandlib.nodes
The typed argument node matches the given ArgumentType which can be treated like a wrapper for argument nodes.
TypedNode(String, ArgumentType<E, T>) - Constructor for class net.lenni0451.commandlib.nodes.TypedNode
 
TypedNode(String, String, ArgumentType<E, T>) - Constructor for class net.lenni0451.commandlib.nodes.TypedNode
 

U

Util - Class in net.lenni0451.commandlib.utils
Some useful methods required by the command lib.
Util() - Constructor for class net.lenni0451.commandlib.utils.Util
 

V

validator(Predicate<T>) - Method in class net.lenni0451.commandlib.builder.LineBuilder
Add a validator to the last added argument.
validator() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
validator(Predicate<T>) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Set the validator of this argument node.
validator() - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
validator(Predicate<Void>) - Method in class net.lenni0451.commandlib.nodes.RedirectNode
 
value(ExecutionContext<E>, StringReader) - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
Parse the value of this argument.
valueOf(String) - Static method in enum net.lenni0451.commandlib.exceptions.ChainExecutionException.Reason
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.lenni0451.commandlib.exceptions.ChainExecutionException.Reason
Returns an array containing the constants of this enum type, in the order they are declared.

W

weight - Variable in class net.lenni0451.commandlib.nodes.ArgumentNode
 
weight() - Method in class net.lenni0451.commandlib.nodes.ArgumentNode
 
word() - Static method in class net.lenni0451.commandlib.types.StringType
Create a new string type that parses a single word.
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links