com.highdeal.hci

Interface XMLAttributes

All Known Implementing Classes:

XMLAttributesImpl

public interface XMLAttributes

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

Method Summary

Modifier and Type	Method and Description
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) Deprecated.
java.util.Date	getDateValue(java.lang.String attName) Gets the value of an XML attribute of date type; Dates 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.
boolean	getStrictBooleanValue(java.lang.String attName) Gets the value of an XML attribute of boolean 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) Registers 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; Dates 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 is not 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 is not a decimal

getBooleanValue

@Deprecated
boolean getBooleanValue(java.lang.String attName)

Deprecated.

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

getStrictBooleanValue

boolean getStrictBooleanValue(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 is not 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 is not 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 is not 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 is not 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)

Registers an ID reference on an attribute and returns the value of the attribute.

Parameters:

attName - The name of the reference

handler - The handler for references

Returns:

The value of the attribute

freeze

XMLAttributes freeze()

Returns a frozen copy of the XML attributes.

Returns:

The frozen copy of the XML attributes