com.comphenix.xp.parser

Class TextParser<TResult>

java.lang.Object

com.comphenix.xp.parser.TextParser<TResult>

Type Parameters:

TResult - - type of the resulting object.

Direct Known Subclasses:

BooleanParser, IntegerParser, ItemDurabilityParser, ItemNameParser, ItemParser, MobDamageCauseParser, MobEntityTypeParser, MobMatcher, MobParser, MobSizeParser, ParameterParser, PotionParser, PotionTypeParser, PresetParser, StringParser

public abstract class TextParser<TResult>
extends java.lang.Object

Represents an object that transforms strings of text into objects.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
TextParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.Queue<java.lang.String>	getParameterQueue(java.lang.String text) Reads tokens from (delimited by a vertical bar) a query rule body.
TResult	parse(java.util.Queue<java.lang.String> tokens) Transforms the head of the queue into a string of objects.
abstract TResult	parse(java.lang.String text) Transforms the given text into an object.
static java.lang.Integer	tryParse(java.lang.String input) Attempt to parse integer.
static java.lang.Integer	tryParse(java.lang.String input, java.lang.Integer defaultValue) Attempt to parse integer.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextParser

public TextParser()

Method Detail

parse

public abstract TResult parse(java.lang.String text)
                       throws ParsingException

Transforms the given text into an object.

Parameters:

text - - text to parse.

Returns:

Result of the parsing.

Throws:

ParsingException - The text cannot be transformed into a list of objects.

parse

public TResult parse(java.util.Queue<java.lang.String> tokens)
              throws ParsingException

Transforms the head of the queue into a string of objects. No head is treated as an empty string.

Parameters:

tokens - - queue of tokens.

Returns:

The corresponding string of objects.

Throws:

ParsingException - The head cannot be transformed into a list of objects.

getParameterQueue

protected java.util.Queue<java.lang.String> getParameterQueue(java.lang.String text)

Reads tokens from (delimited by a vertical bar) a query rule body.

Parameters:

text - - query rule body to read.

Returns:

Queue of the tokens.

tryParse

public static java.lang.Integer tryParse(java.lang.String input)

Attempt to parse integer.

Parameters:

input - - text of the integer to parse.

Returns:

The parsed integer if successful, or NULL if unsuccessful.

tryParse

public static java.lang.Integer tryParse(java.lang.String input,
                         java.lang.Integer defaultValue)

Attempt to parse integer.

Parameters:

input - - text of the integer to parse.

defaultValue - - value to return if the parsing was unsuccessful.

Returns:

The parsed integer if successful, or defaultValue if not.