uk.ac.ed.epcc.safe.accounting.parsers

Class PropertyEntryMaker<T>

java.lang.Object

uk.ac.ed.epcc.safe.accounting.parsers.PropertyEntryMaker<T>

Type Parameters:

T - Type of the PropertyTag and the type of the generated object

All Implemented Interfaces:

ContainerEntryMaker

public class PropertyEntryMaker<T>
extends java.lang.Object
implements ContainerEntryMaker

Links a PropertyTag with a ValueParser. The the purpose of the PropertyEntryMaker it to parse a string and construct an object using the data contained in the string. The object will have the same datatype as the one supported by the PropertyTag and thus the PropertyTag and generated object may be used as a key-value pair in a PropertyContainer.

Author:

jgreen4

Constructor Summary

Constructors

Constructor and Description
PropertyEntryMaker(PropertyTag<T> tag, ValueParser<? extends T> parser) Constructs a new PropertyEntryMaker around an existing PropertyTag.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of this PropertyEntryMaker, which will be the same as the name of it's PropertyTag.
ValueParser<? extends T>	getParser() Returns the parser this PropertyEntryMaker uses to generate objects of type T from string values.
PropertyTag<T>	getPropertyTag() Returns the PropertyTag this maker parses values for.
java.lang.Class<? super T>	getTarget() The type of class this PropertyEntryMaker parses string to
void	setValue(PropertyContainer contanier, java.lang.String valueString) Parses the specified string and adds the generated value to container using this PropertyEntryMaker's PropertyTag as the key
void	setValue(PropertyMap map, java.lang.String valueString) Parses the specified string and adds the generated value to PropertyContainer using this PropertyEntryMaker's PropertyTag as the key.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyEntryMaker

public PropertyEntryMaker(PropertyTag<T> tag,
                  ValueParser<? extends T> parser)
                   throws java.lang.NullPointerException

Constructs a new PropertyEntryMaker around an existing PropertyTag.

Throws:

java.lang.NullPointerException - If tag or parser are null

Parameters:

tag - The PropertyTag this maker may parse values for

parser - The parser used to generate the object of type T from a given string

Method Detail

getName

public java.lang.String getName()

Returns the name of this PropertyEntryMaker, which will be the same as the name of it's PropertyTag.

Returns:

The name of this PropertyEntryMaker

getParser

public ValueParser<? extends T> getParser()

Returns the parser this PropertyEntryMaker uses to generate objects of type T from string values.

Returns:

This PropertyEntryMaker's parser

getPropertyTag

public PropertyTag<T> getPropertyTag()

Returns the PropertyTag this maker parses values for.

Returns:

This PropertyEntryMaker's PropertyTag

getTarget

public java.lang.Class<? super T> getTarget()

The type of class this PropertyEntryMaker parses string to

Returns:

This PropertyEntryMaker's datatype

setValue

public void setValue(PropertyContainer contanier,
            java.lang.String valueString)
              throws java.lang.IllegalArgumentException,
                     InvalidPropertyException,
                     java.lang.NullPointerException

Parses the specified string and adds the generated value to container using this PropertyEntryMaker's PropertyTag as the key

Specified by:

setValue in interface ContainerEntryMaker

Throws:

java.lang.IllegalArgumentException - If valueString is not of a format that allows this maker to convert it into an object of type T

InvalidPropertyException - If the container cannot contain this parser's PropertyTag

java.lang.NullPointerException - If container is null or valueString is null and this the parser does not support null strings

Parameters:

contanier - The container to add this parser's PropertyTag and parsed value to

valueString - The string to parse and convert into an object of type T

setValue

public void setValue(PropertyMap map,
            java.lang.String valueString)
              throws java.lang.IllegalArgumentException,
                     java.lang.NullPointerException

Parses the specified string and adds the generated value to PropertyContainer using this PropertyEntryMaker's PropertyTag as the key. This method differs from setValue(PropertyContainer, String) in that it can't throw an InvalidPropertyException (PropertyMaps don't when properties are set in them, unlike PropertyContainers)

Specified by:

setValue in interface ContainerEntryMaker

Throws:

java.lang.IllegalArgumentException - If valueString is not of a format that allows this maker to convert it into an object of type T

java.lang.NullPointerException - If valueString is null and this maker does not support null strings

Parameters:

map - The container to add this parser's PropertyTag and parsed value to

valueString - The string to parse and convert into an object of type T

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object