com.datasiqn.commandcore.argument

Interface ArgumentReader

All Known Implementing Classes:

StringArgumentReader

public interface ArgumentReader

A class meant to read an argument. When used to parse an argument, make sure the reader is on the space after the argument.

Method Summary

Modifier and Type	Method and Description
boolean	atEnd() Gets whether the reader has reached the last character.
char	get() Gets the current character this reader is looking at
int	index() Gets the current index of the reader
void	jumpTo(int index) Sets the index to something else, "jumping" to that location
char	next() Advances the reader by 1, returning the current character after advancing
@NotNull String	nextWord() Returns the next word and places the reader on the space after that word, or the last character in the reader
int	size() Gets the size of the underlying data
@NotNull String	splice(int beginning) Performs a splice that gets a string starting at index beginning and ending at index size()
@NotNull String	splice(int beginning, int end) Performs a splice that gets a string starting at index beginning and ending at index end

Method Detail

get

char get()

Gets the current character this reader is looking at

Returns:

The current character

next

char next()

Advances the reader by 1, returning the current character after advancing

     

     char next = reader.next();
     char current = reader.get();
     assert next == current;

     
 

Returns:

The current character after advancing 1 character

Throws:

IllegalStateException - If the reader has already reached the last character

atEnd

boolean atEnd()

Gets whether the reader has reached the last character. If this is true, calling next() will throw an exception. This is the same as checking if index() == size() - 1

Returns:

true if the reader is at the last character, false otherwise

index

int index()

Gets the current index of the reader

Returns:

The current index of the reader

size

int size()

Gets the size of the underlying data

Returns:

The size of the underlying data

jumpTo

void jumpTo(int index)

Sets the index to something else, "jumping" to that location

Parameters:

index - The index to set to

Throws:

IndexOutOfBoundsException - If index is negative or greater than or equal to size()

splice

@NotNull
@NotNull String splice(int beginning)

Performs a splice that gets a string starting at index beginning and ending at index size()

     

     // reader has the internal string of "hello there"
     String spliced = reader.splice(2);
     assert spliced.equals("llo there");

     
 

Parameters:

beginning - The index to start at

Returns:

The spliced string

splice

@NotNull
@NotNull String splice(int beginning,
                                 int end)

Performs a splice that gets a string starting at index beginning and ending at index end

     

     // reader has the internal string of "hello there"
     String spliced = reader.splice(2, 8);
     assert spliced.equals("llo th");

     
 

Parameters:

beginning - The index to start at

end - The index to end at

Returns:

The spliced string

nextWord

@NotNull
@NotNull String nextWord()

Returns the next word and places the reader on the space after that word, or the last character in the reader

     

     // reader has the internal string of "hello there"
     String word = reader.nextWord();
     assert word.equals("hello");
     assert reader.get() == ' ';

     
 

Returns:

The next word