com.highdeal.hci
Interface XMLAttributes

All Known Implementing Classes:

XMLAttributesImpl

public interface XMLAttributes

This interface allows to access to attributes of an XML tag.

Method Summary

XMLAttributes	freeze() Returns a frozen copy of the XML attributes.
java.lang.String[]	getAttributesNames() Returns all the attributes names.
java.math.BigInteger	getBigIntegerValue(java.lang.String attName) Gets the value of an XML attribute of big integer type.
boolean	getBooleanValue(java.lang.String attName) Gets the value of an XML attribute of boolean type.
java.util.Date	getDateValue(java.lang.String attName) Gets the value of an XML attribute of date type, date are encoded using ISO 8601 date and time formats.
java.math.BigDecimal	getDecimalValue(java.lang.String attName) Gets the value of an XML attribute of decimal type.
java.lang.Integer	getIntegerValue(java.lang.String attName) Gets the value of an XML attribute of integer type.
java.lang.Long	getLongValue(java.lang.String attName) Gets the value of an XML attribute of long type.
java.lang.String	getValue(java.lang.String attName) Gets the value of an XML attribute.
java.lang.String	registerHandler(java.lang.String attName, ReferenceHandler handler) Register an id reference on an attribute and returns the value of the attribute.

Method Detail

getValue

java.lang.String getValue(java.lang.String attName)

Gets the value of an XML attribute.

Parameters:

attName - the attribute to get the value for.

Returns:

the value of the attribute as a string.

getDateValue

java.util.Date getDateValue(java.lang.String attName)

Gets the value of an XML attribute of date type, date are encoded using ISO 8601 date and time formats.

Parameters:

attName - the name of the attribute.

Returns:

the value of the attribute as a date.

Throws:

XMLIllegalArgumentException - when the attribute value isn't a ISO 8601 date.

getDecimalValue

java.math.BigDecimal getDecimalValue(java.lang.String attName)

Gets the value of an XML attribute of decimal type.

Parameters:

attName - the name of the attribute.

Returns:

the value of the attribute as a decimal.

Throws:

XMLIllegalArgumentException - when the attribute value isn't a decimal.

getBooleanValue

boolean getBooleanValue(java.lang.String attName)

Gets the value of an XML attribute of boolean type.

Parameters:

attName - the name of the attribute.

Returns:

true if the value of attName is "true", false otherwise.

Throws:

XMLIllegalArgumentException - when the attribute value isn't a boolean.

getIntegerValue

java.lang.Integer getIntegerValue(java.lang.String attName)

Gets the value of an XML attribute of integer type.

Parameters:

attName - the name of the attribute.

Returns:

the value of the attribute as an integer.

Throws:

XMLIllegalArgumentException - when the attribute value isn't a integer.

getLongValue

java.lang.Long getLongValue(java.lang.String attName)

Gets the value of an XML attribute of long type.

Parameters:

attName - the name of the attribute.

Returns:

the value of the attribute as a long.

Throws:

XMLIllegalArgumentException - when the attribute value isn't a long.

getBigIntegerValue

java.math.BigInteger getBigIntegerValue(java.lang.String attName)

Gets the value of an XML attribute of big integer type.

Parameters:

attName - the name of the attribute.

Returns:

the value of the attribute as a big integer.

Throws:

XMLIllegalArgumentException - when the attribute value isn't a big integer.

getAttributesNames

java.lang.String[] getAttributesNames()

Returns all the attributes names.

Returns:

the attributes names.

registerHandler

java.lang.String registerHandler(java.lang.String attName,
                                 ReferenceHandler handler)

Register an id reference on an attribute and returns the value of the attribute.

Parameters:

attName - the name of the reference.

handler - the reference handler.

Returns:

the value of the attribute.

freeze

XMLAttributes freeze()

Returns a frozen copy of the XML attributes.

Returns:

a frozen copy of the XML attributes.