com.datasiqn.commandcore.argument

Interface Arguments

All Known Implementing Classes:

StringArguments

public interface Arguments

Represents command arguments

Method Summary

Modifier and Type	Method and Description
@NotNull ArgumentReader	asReader() Converts all arguments into an ArgumentReader
static void	checkBounds(int i, int size) Checks if i is smaller than size and at least 0
default <T> T	get(int i, ArgumentType<T> type) Gets a specific argument
<T> @NotNull com.datasiqn.resultapi.Result<T,String>	getChecked(int i, ArgumentType<T> type) Same as get(int, ArgumentType), except checks if there is an error and returns a Result
@NotNull String	getString(int i) Gets a simple string argument
int	size() Gets the size of the arguments

Method Detail

size

int size()

Gets the size of the arguments

Returns:

The number of arguments

get

@NotNull
default <T> T get(int i,
                            ArgumentType<T> type)

Gets a specific argument

Type Parameters:

T - The type of the argument type

Parameters:

i - The index of the argument

type - The argument type

Returns:

The parsed argument

Throws:

IllegalArgumentException - If the argument could not be parsed into type

IndexOutOfBoundsException - If i is an invalid index (i < 0, or i >= size())

getChecked

@NotNull
<T> @NotNull com.datasiqn.resultapi.Result<T,String> getChecked(int i,
                                                                          ArgumentType<T> type)

Same as get(int, ArgumentType), except checks if there is an error and returns a Result

Type Parameters:

T - The type of the argument type

Parameters:

i - The index of the argument

type - The argument type

Returns:

The result of the parsing

Throws:

IndexOutOfBoundsException - If i is an invalid index (i < 0, or i >= size())

getString

@NotNull
@NotNull String getString(int i)

Gets a simple string argument

Parameters:

i - The index of the argument

Returns:

The argument as a string

Throws:

IndexOutOfBoundsException - if i is an invalid index (i < 0, or i >= size()

asReader

@NotNull
@NotNull ArgumentReader asReader()

Converts all arguments into an ArgumentReader

Returns:

The newly created ArgumentReader

checkBounds

static void checkBounds(int i,
                        int size)

Checks if i is smaller than size and at least 0

Parameters:

i - The number to check

size - The total size

Throws:

IndexOutOfBoundsException - If i >= size or i < 0