Package dev.jorel.commandapi.arguments

Class ArgumentUtilities

java.lang.Object

dev.jorel.commandapi.arguments.ArgumentUtilities

public class ArgumentUtilities
extends Object

Utilities for creating mock argument parsers

Method Summary

Modifier and Type	Method	Description
static ParserLiteral	literal(String literal)	Returns a new ParserLiteral.
static ParserArgument<String>	readUntilWithoutEscapeCharacter(char terminator)	Returns a new ParserArgument that reads characters from the input StringReader until it reaches the given terminator character.
static com.mojang.brigadier.Message	translatedMessage(String key)	Turns a translation key into a Brigadier Message.
static com.mojang.brigadier.Message	translatedMessage(String key, Object... args)	Turns a translation key into a Brigadier Message.

Methods inherited from class java.lang.Object

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

Method Details

translatedMessage

public static com.mojang.brigadier.Message translatedMessage(String key)

Turns a translation key into a Brigadier Message. These keys can be a default Minecraft Language Code or any translation loaded by a plugin.

Parameters:

key - The key for the message translation.

Returns:

A Brigadier Message that represents the given language key.

translatedMessage

public static com.mojang.brigadier.Message translatedMessage(String key,
 Object... args)

Turns a translation key into a Brigadier Message. These keys can be a default Minecraft Language Code or any translation loaded by a plugin.

Parameters:

key - The key for the message translation.

args - Objects to insert into the string at the location of %s markers in the resulting translated message.

Returns:

A Brigadier Message that represents the given language key.

literal

public static ParserLiteral literal(String literal)

Returns a new ParserLiteral. When the returned parser is invoked, it tries to read the given literal String from the input StringReader. If the literal is present, this parser succeeds and moves StringReader.getCursor() to the end of the literal. Otherwise, this parser will fail and throw a CommandSyntaxException with type BuiltInExceptionProvider.literalIncorrect().

Parameters:

literal - The exact String that is expected to be at the start of the input StringReader.

Returns:

A ParserLiteral that checks if the literal String can be read from the input StringReader.

readUntilWithoutEscapeCharacter

public static ParserArgument<String> readUntilWithoutEscapeCharacter(char terminator)

Returns a new ParserArgument that reads characters from the input StringReader until it reaches the given terminator character. If the terminator character is not found, the entire StringReader.getRemaining() String will be read.

Note - This is intended to work like StringReader.readStringUntil(char) but with two differences: 1. This method does not treat \ as a special character. StringReader.readStringUntil(char) allows the terminator character to be escaped by unescaped \. 2. This method does not throw a CommandSyntaxException if the end of the string is reached without a terminator. StringReader.readStringUntil(char) will throw BuiltInExceptionProvider.readerExpectedEndOfQuote() if this happens.

Parameters:

terminator - The character to stop reading at.

Returns:

A ParserArgument that reads until it finds the given terminator. Note that the returned String will include the terminator at the end, unless the end of the input StringReader is reached without finding the terminator.