Package org.htmlunit.cyberneko.xerces.util

Class XMLAttributesImpl

java.lang.Object

org.htmlunit.cyberneko.xerces.util.XMLAttributesImpl

All Implemented Interfaces:

XMLAttributes, Attributes, Attributes2

public class XMLAttributesImpl
extends Object
implements XMLAttributes

The XMLAttributesImpl class is an implementation of the XMLAttributes interface which defines a collection of attributes for an element. In the parser, the document source would scan the entire start element and collect the attributes. The attributes are communicated to the document handler in the startElement method.

The attributes are read-write so that subsequent stages in the document pipeline can modify the values or change the attributes that are propagated to the next stage.

Author:

Andy Clark, IBM, Elena Litani, IBM, Michael Glavassevich, IBM

See Also:

XMLDocumentHandler.startElement(org.htmlunit.cyberneko.xerces.xni.QName, org.htmlunit.cyberneko.xerces.xni.XMLAttributes, org.htmlunit.cyberneko.xerces.xni.Augmentations)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XMLAttributesImpl.Attribute	INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Attribute information.

Constructor Summary

Constructors

Constructor	Description
XMLAttributesImpl()	Default constructor.
XMLAttributesImpl(XMLAttributesImpl attributes)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
int	addAttribute(QName name, String type, String value)	Adds an attribute.
void	addAttribute(QName name, String type, String value, boolean specified)	Adds an attribute.
void	addAttribute(QName name, String type, String value, String nonNormalizedValue, boolean specified)
ArrayList<XMLAttributesImpl.Attribute>	getAttributes()	INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
int	getIndex(String qName)	Look up the index of an attribute by XML 1.0 qualified name.
int	getIndex(String uri, String localPart)	Look up the index of an attribute by Namespace name.
int	getLength()	Return the number of attributes in the list.
String	getLocalName(int index)	Look up an attribute's local name by index.
QName	getName(int index)	Returns the full QName of the name of this attribute.
void	getName(int attrIndex, QName attrName)	Sets the fields in the given QName structure with the values of the attribute name at the specified index.
String	getNameRawName(int index)	Return the name of an attribute in this list (by position).
String	getNonNormalizedValue(int index)
String	getQName(int index)	Look up an attribute's XML 1.0 qualified name by index.
String	getType(int index)	Look up an attribute's type by index.
String	getType(String qname)	Look up an attribute's type by XML 1.0 qualified name.
String	getType(String uri, String localName)	Look up an attribute's type by Namespace name.
String	getURI(int index)	Look up an attribute's Namespace URI by index.
String	getValue(int index)	Look up an attribute's value by index.
String	getValue(String qname)	Look up an attribute's value by XML 1.0 qualified name.
String	getValue(String uri, String localName)	Look up an attribute's value by Namespace name.
boolean	isDeclared(int index)
boolean	isDeclared(String qName)
boolean	isDeclared(String uri, String localName)
boolean	isSpecified(int attrIndex)	Returns true if the attribute is specified in the instance document.
boolean	isSpecified(String qName)
boolean	isSpecified(String uri, String localName)
void	removeAllAttributes()	Removes all of the attributes.
void	removeAttributeAt(int attrIndex)	Removes the attribute at the specified index.
void	setName(int attrIndex, QName attrName)	Sets the name of the attribute at the specified index.
void	setSpecified(int attrIndex, boolean specified)	Sets whether an attribute is specified in the instance document or not.
void	setValue(int attrIndex, String attrValue)	Sets the value of the attribute at the specified index.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLAttributesImpl

public XMLAttributesImpl()

Default constructor.

XMLAttributesImpl

public XMLAttributesImpl(XMLAttributesImpl attributes)

Copy constructor.

Method Detail

addAttribute

public int addAttribute(QName name,
                        String type,
                        String value)

Adds an attribute. The attribute's non-normalized value of the attribute will have the same value as the attribute value. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using the setSpecified method.

Note: If an attribute of the same name already exists, the old values for the attribute are replaced by the new values.

Specified by:

addAttribute in interface XMLAttributes

Parameters:

name - The attribute name.

type - The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true|false)".

value - The attribute value.

Returns:

Returns the attribute index.

See Also:

setSpecified(int, boolean)

addAttribute

public void addAttribute(QName name,
                         String type,
                         String value,
                         boolean specified)

Adds an attribute. The attribute's non-normalized value of the attribute will have the same value as the attribute value. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using the setSpecified method.

This method differs from addAttribute in that it does not check if an attribute of the same name already exists in the list before adding it. In order to improve performance of namespace processing, this method allows uniqueness checks to be deferred until all the namespace information is available after the entire attribute specification has been read.

Caution: If this method is called it should not be mixed with calls to addAttribute unless it has been determined that all the attribute names are unique.

Parameters:

name - the attribute name

type - the attribute type

value - the attribute value

specified - the specified attribute value

addAttribute

public void addAttribute(QName name,
                         String type,
                         String value,
                         String nonNormalizedValue,
                         boolean specified)

removeAllAttributes

public void removeAllAttributes()

Removes all of the attributes. This method will also remove all entities associated to the attributes.

Specified by:

removeAllAttributes in interface XMLAttributes

removeAttributeAt

public void removeAttributeAt(int attrIndex)

Removes the attribute at the specified index.

Note: This operation changes the indexes of all attributes following the attribute at the specified index.

Specified by:

removeAttributeAt in interface XMLAttributes

Parameters:

attrIndex - The attribute index.

setName

public void setName(int attrIndex,
                    QName attrName)

Sets the name of the attribute at the specified index.

Specified by:

setName in interface XMLAttributes

Parameters:

attrIndex - The attribute index.

attrName - The new attribute name.

getName

public void getName(int attrIndex,
                    QName attrName)

Sets the fields in the given QName structure with the values of the attribute name at the specified index.

Specified by:

getName in interface XMLAttributes

Parameters:

attrIndex - The attribute index.

attrName - The attribute name structure to fill in.

setValue

public void setValue(int attrIndex,
                     String attrValue)

Sets the value of the attribute at the specified index. This method will overwrite the non-normalized value of the attribute.

Specified by:

setValue in interface XMLAttributes

Parameters:

attrIndex - The attribute index.

attrValue - The new attribute value.

setSpecified

public void setSpecified(int attrIndex,
                         boolean specified)

Sets whether an attribute is specified in the instance document or not.

Specified by:

setSpecified in interface XMLAttributes

Parameters:

attrIndex - The attribute index.

specified - True if the attribute is specified in the instance document.

isSpecified

public boolean isSpecified(int attrIndex)

Returns true if the attribute is specified in the instance document.

Specified by:

isSpecified in interface Attributes2

Parameters:

attrIndex - The attribute index.

getLength

public int getLength()

Return the number of attributes in the list.

Once you know the number of attributes, you can iterate through the list.

Specified by:

getLength in interface Attributes

Returns:

The number of attributes in the list.

getType

public String getType(int index)

Look up an attribute's type by index.

The attribute type is one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper case).

If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value "CDATA" as stated in the XML 1.0 Recommendation (clause 3.3.3, "Attribute-Value Normalization").

For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".

Specified by:

getType in interface Attributes

Parameters:

index - The attribute index (zero-based).

Returns:

The attribute's type as a string, or null if the index is out of range.

See Also:

getLength()

getType

public String getType(String qname)

Look up an attribute's type by XML 1.0 qualified name.

See getType(int) for a description of the possible types.

Specified by:

getType in interface Attributes

Parameters:

qname - The XML 1.0 qualified name.

Returns:

The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.

getValue

public String getValue(int index)

Look up an attribute's value by index.

If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Specified by:

getValue in interface Attributes

Parameters:

index - The attribute index (zero-based).

Returns:

The attribute's value as a string, or null if the index is out of range.

See Also:

getLength()

getValue

public String getValue(String qname)

Look up an attribute's value by XML 1.0 qualified name.

See getValue(int) for a description of the possible values.

Specified by:

getValue in interface Attributes

Parameters:

qname - The XML 1.0 qualified name.

Returns:

The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.

getNameRawName

public String getNameRawName(int index)

Return the name of an attribute in this list (by position).

The names must be unique: the SAX parser shall not include the same attribute twice. Attributes without values (those declared #IMPLIED without a value specified in the start tag) will be omitted from the list.

If the attribute name has a namespace prefix, the prefix will still be attached.

Parameters:

index - The index of the attribute in the list (starting at 0).

Returns:

The name of the indexed attribute, or null if the index is out of range.

See Also:

getLength()

getName

public QName getName(int index)

Returns the full QName of the name of this attribute.

Specified by:

getName in interface XMLAttributes

Parameters:

index - The attribute index.

getIndex

public int getIndex(String qName)

Look up the index of an attribute by XML 1.0 qualified name.

Specified by:

getIndex in interface Attributes

Parameters:

qName - The qualified (prefixed) name.

Returns:

The index of the attribute, or -1 if it does not appear in the list.

getIndex

public int getIndex(String uri,
                    String localPart)

Look up the index of an attribute by Namespace name.

Specified by:

getIndex in interface Attributes

Parameters:

uri - The Namespace URI, or null if the name has no Namespace URI.

localPart - The attribute's local name.

Returns:

The index of the attribute, or -1 if it does not appear in the list.

getLocalName

public String getLocalName(int index)

Look up an attribute's local name by index.

Specified by:

getLocalName in interface Attributes

Parameters:

index - The attribute index (zero-based).

Returns:

The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.

See Also:

getLength()

getQName

public String getQName(int index)

Look up an attribute's XML 1.0 qualified name by index.

Specified by:

getQName in interface Attributes

Parameters:

index - The attribute index (zero-based).

Returns:

The XML 1.0 qualified name, or the empty string if none is available, or null if the index is out of range.

See Also:

getLength()

getType

public String getType(String uri,
                      String localName)

Look up an attribute's type by Namespace name.

See getType(int) for a description of the possible types.

Specified by:

getType in interface Attributes

Parameters:

uri - The Namespace URI, or null if the name has no Namespace URI.

localName - The local name of the attribute.

Returns:

The attribute type as a string, or null if the attribute is not in the list or if Namespace processing is not being performed.

getURI

public String getURI(int index)

Look up an attribute's Namespace URI by index.

Specified by:

getURI in interface Attributes

Parameters:

index - The attribute index (zero-based).

Returns:

The Namespace URI

See Also:

getLength()

getValue

public String getValue(String uri,
                       String localName)

Look up an attribute's value by Namespace name.

See getValue(int) for a description of the possible values.

Specified by:

getValue in interface Attributes

Parameters:

uri - The Namespace URI, or null if the

localName - The local name of the attribute.

Returns:

The attribute value as a string, or null if the attribute is not in the list.

getNonNormalizedValue

public String getNonNormalizedValue(int index)

Specified by:

getNonNormalizedValue in interface XMLAttributes

Parameters:

index - The attribute index.

Returns:

the non-normalized value of the attribute at the specified index. If no non-normalized value is set, this method will return the same value as the getValue(int) method.

isDeclared

public boolean isDeclared(int index)

Specified by:

isDeclared in interface Attributes2

isDeclared

public boolean isDeclared(String qName)

Specified by:

isDeclared in interface Attributes2

isDeclared

public boolean isDeclared(String uri,
                          String localName)

Specified by:

isDeclared in interface Attributes2

isSpecified

public boolean isSpecified(String qName)

Specified by:

isSpecified in interface Attributes2

isSpecified

public boolean isSpecified(String uri,
                           String localName)

Specified by:

isSpecified in interface Attributes2

getAttributes

public ArrayList<XMLAttributesImpl.Attribute> getAttributes()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.

Returns:

the internal attributes_ ArrayList to allow some performance optimizations.