com.datasiqn.commandcore.argument

Class StringArguments

java.lang.Object

com.datasiqn.commandcore.argument.StringArguments

All Implemented Interfaces:

Arguments

public class StringArguments
extends Object
implements Arguments

Represents a list of arguments.

Internally, this uses a List<String> to store arguments and parses the string it every time the user wants an argument.

Constructor Summary

Constructors

Constructor and Description
StringArguments(List<String> args) Creates a new ListArguments

Method Summary

Modifier and Type	Method and Description
@NotNull ArgumentReader	asReader() Converts all arguments into an ArgumentReader
<T> @NotNull com.datasiqn.resultapi.Result<T,String>	getChecked(int i, @NotNull ArgumentType<T> type) Same as Arguments.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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datasiqn.commandcore.argument.Arguments

checkBounds, get

Constructor Detail

StringArguments

public StringArguments(List<String> args)

Creates a new ListArguments

Parameters:

args - The arguments in a string list

Method Detail

size

public int size()

Description copied from interface: Arguments

Gets the size of the arguments

Specified by:

size in interface Arguments

Returns:

The number of arguments

getChecked

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

Description copied from interface: Arguments

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

Specified by:

getChecked in interface Arguments

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

getString

@NotNull
public @NotNull String getString(int i)

Description copied from interface: Arguments

Gets a simple string argument

Specified by:

getString in interface Arguments

Parameters:

i - The index of the argument

Returns:

The argument as a string

asReader

@NotNull
public @NotNull ArgumentReader asReader()

Description copied from interface: Arguments

Converts all arguments into an ArgumentReader

Specified by:

asReader in interface Arguments

Returns:

The newly created ArgumentReader