baritone.api.command.argument

Interface ICommandArgument

public interface ICommandArgument

A ICommandArgument is an immutable object representing one command argument. It contains data on the index of that argument, its value, and the rest of the string that argument was found in

You're recommended to use IArgConsumer}s to handle these.

Since:

10/2/2019

Method Summary

Modifier and Type	Method and Description
<T> T	getAs(java.lang.Class<T> type) Tries to use a stateless IArgParser to parse this argument into the specified class
<T,S> T	getAs(java.lang.Class<T> type, java.lang.Class<S> stateType, S state) Tries to use a stated IArgParser to parse this argument into the specified class
<E extends java.lang.Enum<?>> E	getEnum(java.lang.Class<E> enumClass) Gets an enum value from the enum class with the same name as this argument's value
int	getIndex()
java.lang.String	getRawRest()
java.lang.String	getValue()
<T> boolean	is(java.lang.Class<T> type) Tries to use a stateless IArgParser to parse this argument into the specified class
<T,S> boolean	is(java.lang.Class<T> type, java.lang.Class<S> stateType, S state) Tries to use a stated IArgParser to parse this argument into the specified class

Method Detail

getIndex

int getIndex()

Returns:

The index of this command argument in the list of command arguments generated

getValue

java.lang.String getValue()

Returns:

The raw value of just this argument

getRawRest

java.lang.String getRawRest()

Returns:

The raw value of the remaining arguments after this one was captured

getEnum

<E extends java.lang.Enum<?>> E getEnum(java.lang.Class<E> enumClass)
                                 throws CommandInvalidTypeException

Gets an enum value from the enum class with the same name as this argument's value

For example if you getEnum as an EnumFacing, and this argument's value is "up", it will return EnumFacing.UP

Parameters:

enumClass - The enum class to search

Returns:

An enum constant of that class with the same name as this argument's value

Throws:

CommandInvalidTypeException - If the constant couldn't be found

See Also:

IArgConsumer.peekEnum(Class), IArgConsumer.peekEnum(Class, int), IArgConsumer.peekEnumOrNull(Class), IArgConsumer.peekEnumOrNull(Class, int), IArgConsumer.getEnum(Class), IArgConsumer.getEnumOrNull(Class)

getAs

<T> T getAs(java.lang.Class<T> type)
     throws CommandInvalidTypeException

Tries to use a stateless IArgParser to parse this argument into the specified class

Parameters:

type - The class to parse this argument into

Returns:

An instance of the specified type

Throws:

CommandInvalidTypeException - If the parsing failed

is

<T> boolean is(java.lang.Class<T> type)

Tries to use a stateless IArgParser to parse this argument into the specified class

Parameters:

type - The class to parse this argument into

Returns:

If the parser succeeded

getAs

<T,S> T getAs(java.lang.Class<T> type,
              java.lang.Class<S> stateType,
              S state)
       throws CommandInvalidTypeException

Tries to use a stated IArgParser to parse this argument into the specified class

Parameters:

type - The class to parse this argument into

Returns:

An instance of the specified type

Throws:

CommandInvalidTypeException - If the parsing failed

is

<T,S> boolean is(java.lang.Class<T> type,
                 java.lang.Class<S> stateType,
                 S state)

Tries to use a stated IArgParser to parse this argument into the specified class

Parameters:

type - The class to parse this argument into

Returns:

If the parser succeeded