com.hp.util.syntax.parsers

Class ListParameterParser

java.lang.Object

com.hp.util.syntax.parsers.AbstractParameterParser

com.hp.util.syntax.parsers.ListParameterParser

All Implemented Interfaces:

ConstraintsParser, ParameterParser, TypedParser, Serializable

Direct Known Subclasses:

DateListParameterParser, NumberListParameterParser, StringListParameterParser

public abstract class ListParameterParser
extends AbstractParameterParser

Abstraction of a parser capable of producing lists of parameters.

Author:

Thomas Vachuska

See Also:

Serialized Form

Field Summary

Fields inherited from class com.hp.util.syntax.parsers.AbstractParameterParser

locale

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListParameterParser() Default constructor.
protected	ListParameterParser(Locale locale) Constructs a new parser using the given locale.

Method Summary

Methods

Modifier and Type	Method and Description
Serializable	parse(String tokens, Constraints constraints, Parameters soFar) Returns a non-null List of objects if the parsing of the given tokens string was succesful and if each of the list item objects complied with the specified constraints, if any were specified.
protected abstract Serializable	parseItem(String token, Constraints constraints, Parameters soFar) Returns the parsed object corresponding to the given list item.

Methods inherited from class com.hp.util.syntax.parsers.AbstractParameterParser

getLocale

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hp.util.syntax.parsers.ConstraintsParser

parse

Methods inherited from interface com.hp.util.syntax.parsers.TypedParser

getTypeToken

Constructor Detail

ListParameterParser

protected ListParameterParser()

Default constructor.

ListParameterParser

protected ListParameterParser(Locale locale)

Constructs a new parser using the given locale.

Parameters:

locale - Locale to associate with this parser.

Method Detail

parseItem

protected abstract Serializable parseItem(String token,
                     Constraints constraints,
                     Parameters soFar)

Returns the parsed object corresponding to the given list item. This method should only parse the token and does not need to invoke Constraints.isValid(java.io.Serializable) as this is performed by parse(java.lang.String, com.hp.util.syntax.parsers.Constraints, com.hp.util.syntax.Parameters) method.

Parameters:

token - String to be decoded/parsed into a Serializable entity.

constraints - Constraints & hints to use for parsing and for validating the resulting Serializable.

soFar - Parameters accumulated by the parsing process thus far.

Returns:

A serializable entity created based on the token value.

parse

public Serializable parse(String tokens,
                 Constraints constraints,
                 Parameters soFar)

Returns a non-null List of objects if the parsing of the given tokens string was succesful and if each of the list item objects complied with the specified constraints, if any were specified. Returns null otherwise.

Parameters:

tokens - String to be decoded/parsed into a Serializable entity.

constraints - Constraints & hints to use for parsing and for validating the resulting Serializable.

soFar - Parameters accumulated by the parsing process thus far.

Returns:

ArrayList of Serializable entities if the parsing was successful; returns null otherwise.

See Also:

ParameterParser.parse(java.lang.String, com.hp.util.syntax.parsers.Constraints, com.hp.util.syntax.Parameters)