com.comphenix.xp.parser.primitives

Class BooleanParser

java.lang.Object

com.comphenix.xp.parser.TextParser<java.util.List<java.lang.Boolean>>

com.comphenix.xp.parser.primitives.BooleanParser

public class BooleanParser
extends TextParser<java.util.List<java.lang.Boolean>>

Constructor Summary

Constructors

Constructor and Description
BooleanParser(java.lang.String parameterName)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getParameterName()
java.util.List<java.lang.Boolean>	parse(java.lang.String text) Parses the given parameter as a boolean.
java.util.List<java.lang.Boolean>	parseAny(java.util.Queue<java.lang.String> tokens) Transforms and returns the first non-null element from the left into an object.

Methods inherited from class com.comphenix.xp.parser.TextParser

getParameterQueue, parse, tryParse, tryParse

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanParser

public BooleanParser(java.lang.String parameterName)

Method Detail

getParameterName

public java.lang.String getParameterName()

parse

public java.util.List<java.lang.Boolean> parse(java.lang.String text)
                                        throws ParsingException

Parses the given parameter as a boolean.

Specified by:

parse in class TextParser<java.util.List<java.lang.Boolean>>

Parameters:

text - - parameter to parse.

Returns:

Boolean value if parsing succeeded, or NULL otherwise.

Throws:

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

parseAny

public java.util.List<java.lang.Boolean> parseAny(java.util.Queue<java.lang.String> tokens)
                                           throws ParsingException

Transforms and returns the first non-null element from the left into an object. That element is removed.

Parameters:

tokens - - queue of items.

Returns:

List containing the removed object, OR an empty list if no object was removed.

Throws:

ParsingException