com.hp.util.syntax.parsers

Class FileParameterParser

java.lang.Object

com.hp.util.syntax.parsers.AbstractParameterParser

com.hp.util.syntax.parsers.FileParameterParser

All Implemented Interfaces:

ConstraintsParser, ParameterParser, TypedParser, Serializable

public class FileParameterParser
extends AbstractParameterParser

Builtin parser for file values.

Author:

Thomas Vachuska

See Also:

Serialized Form

Field Summary

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

locale

Constructor Summary

Constructors

Constructor and Description
FileParameterParser() Default constructor.
FileParameterParser(Locale locale) Constructs a new file parameter parser using the given locale.

Method Summary

Methods

Modifier and Type	Method and Description
String	getTypeToken() Returns the string which serves as a value type token for parameters of this type.
Constraints	parse(Properties db, TokenTranslator tr, ParserLoader parserLoader) Creates an instance of FileConstraints.
Serializable	parse(String token, Constraints constraints, Parameters soFar) Returns a non-null object if the parsing of the given token was succesful and if the object value complied with the specified constraints, if any were specified.

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

Constructor Detail

FileParameterParser

public FileParameterParser()

Default constructor.

FileParameterParser

public FileParameterParser(Locale locale)

Constructs a new file parameter parser using the given locale.

Parameters:

locale - Locale to associate with this parser.

Method Detail

getTypeToken

public String getTypeToken()

Description copied from interface: TypedParser

Returns the string which serves as a value type token for parameters of this type.

Returns:

type token string of the parser

See Also:

TypedParser.getTypeToken()

parse

public Constraints parse(Properties db,
                TokenTranslator tr,
                ParserLoader parserLoader)

Creates an instance of FileConstraints.

Parameters:

db - Set of properties that can be used to parametrize the constraints implementation.

tr - A token translator that can be used for locale-specific or other types of value translation.

parserLoader - Reference to the parameter and constraints parser loader.

Returns:

FileConstraints instance created using the specified properties.

See Also:

ConstraintsParser.parse(java.util.Properties, com.hp.util.format.TokenTranslator, com.hp.util.syntax.ParserLoader)

parse

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

Returns a non-null object if the parsing of the given token was succesful and if the object value complied with the specified constraints, if any were specified.

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 validated File instance or null if the resulting File value does not meet the constraints, if any.

See Also:

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