XMLAttributesImpl (Red Hat JBoss Enterprise Application Platform 7.1.0.Beta1 public API)

java.lang.Object
- org.apache.xerces.util.XMLAttributesImpl

All Implemented Interfaces:

XMLAttributes
```
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 propogated to the next stage.

Version:

$Id$

Author:

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

See Also:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.apache.xerces.util.XMLAttributesImpl.Attribute[]`	`fAttributes` Attribute information.
`protected org.apache.xerces.util.XMLAttributesImpl.Attribute[]`	`fAttributeTableView` Hashtable of attribute information.
`protected int[]`	`fAttributeTableViewChainState` Tracks whether each chain in the hash table is stale with respect to the current state of this object.
`protected boolean`	`fIsTableViewConsistent` Indicates whether the table view contains consistent data.
`protected int`	`fLargeCount` Usage count for the attribute table view.
`protected int`	`fLength` Attribute count.
`protected boolean`	`fNamespaces` Namespaces.
`protected int`	`fTableViewBuckets` Actual number of buckets in the table view.
`protected static int`	`SIZE_LIMIT` Threshold at which an instance is treated as a large attribute list.
`protected static int`	`TABLE_SIZE` Default table size.

Constructor Summary

Constructors
Constructor and Description

XMLAttributesImpl()
Default constructor.

XMLAttributesImpl(int tableSize)

Constructors
Constructor and Description
`XMLAttributesImpl()` Default constructor.
`XMLAttributesImpl(int tableSize)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addAttribute(QName name, String type, String value)` Adds an attribute.
`void`	`addAttributeNS(QName name, String type, String value)` Adds an attribute.
`QName`	`checkDuplicatesNS()` Checks for duplicate expanded names (local part and namespace name pairs) in the attribute specification.
`protected void`	`cleanTableView()` Purges all elements from the table view.
`Augmentations`	`getAugmentations(int attributeIndex)` Look up an augmentations by attributes index.
`Augmentations`	`getAugmentations(String qName)` Look up an augmentation by XML 1.0 qualified name.
`Augmentations`	`getAugmentations(String uri, String localName)` Look up an augmentations by Namespace name.
`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`	`getIndexFast(String qName)` Look up the index of an attribute by XML 1.0 qualified name.
`int`	`getIndexFast(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.
`String`	`getName(int index)` Return the name of an attribute in this list (by position).
`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`	`getNonNormalizedValue(int attrIndex)` Returns the non-normalized value of the attribute at the specified index.
`String`	`getPrefix(int index)` Returns the prefix of the attribute at the specified index.
`String`	`getQName(int index)` Look up an attribute's XML 1.0 qualified name by index.
`protected int`	`getTableViewBucket(String qname)` Returns the position in the table view where the given attribute name would be hashed.
`protected int`	`getTableViewBucket(String localpart, String uri)` Returns the position in the table view where the given attribute name would be hashed.
`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`	`isSpecified(int attrIndex)` Returns true if the attribute is specified in the instance document.
`protected void`	`prepareAndPopulateTableView()` Prepares the table view of the attributes list for use, and populates it with the attributes which have been previously read.
`protected void`	`prepareTableView()` Prepares the table view of the attributes list for use.
`void`	`removeAllAttributes()` Removes all of the attributes.
`void`	`removeAttributeAt(int attrIndex)` Removes the attribute at the specified index.
`void`	`setAugmentations(int attrIndex, Augmentations augs)` Sets the augmentations of the attribute at the specified index.
`void`	`setName(int attrIndex, QName attrName)` Sets the name of the attribute at the specified index.
`void`	`setNamespaces(boolean namespaces)` Sets whether namespace processing is being performed.
`void`	`setNonNormalizedValue(int attrIndex, String attrValue)` Sets the non-normalized value 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`	`setType(int attrIndex, String attrType)` Sets the type of the attribute at the specified index.
`void`	`setURI(int attrIndex, String uri)` Sets the uri of the attribute at the specified index.
`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

- Field Detail
  - TABLE_SIZE
```
protected static final int TABLE_SIZE
```
    Default table size.
    
    See Also:
    
    Constant Field Values
  - SIZE_LIMIT
```
protected static final int SIZE_LIMIT
```
    Threshold at which an instance is treated as a large attribute list.
    
    See Also:
    
    Constant Field Values
  - fNamespaces
```
protected boolean fNamespaces
```
    Namespaces.
  - fLargeCount
```
protected int fLargeCount
```
    Usage count for the attribute table view. Incremented each time all attributes are removed when the attribute table view is in use.
  - fLength
```
protected int fLength
```
    Attribute count.
  - fAttributes
```
protected org.apache.xerces.util.XMLAttributesImpl.Attribute[] fAttributes
```
    Attribute information.
  - fAttributeTableView
```
protected org.apache.xerces.util.XMLAttributesImpl.Attribute[] fAttributeTableView
```
    Hashtable of attribute information. Provides an alternate view of the attribute specification.
  - fAttributeTableViewChainState
```
protected int[] fAttributeTableViewChainState
```
    Tracks whether each chain in the hash table is stale with respect to the current state of this object. A chain is stale if its state is not the same as the number of times the attribute table view has been used.
  - fTableViewBuckets
```
protected int fTableViewBuckets
```
    Actual number of buckets in the table view.
  - fIsTableViewConsistent
```
protected boolean fIsTableViewConsistent
```
    Indicates whether the table view contains consistent data.
- Constructor Detail
  - XMLAttributesImpl
```
public XMLAttributesImpl()
```
    Default constructor.
  - XMLAttributesImpl
```
public XMLAttributesImpl(int tableSize)
```
    Parameters:
    
    tableSize - initial size of table view
- Method Detail
  - setNamespaces
```
public void setNamespaces(boolean namespaces)
```
    Sets whether namespace processing is being performed. This state is needed to return the correct value from the getLocalName method.
    
    Parameters:
    
    namespaces - True if namespace processing is turned on.
    
    See Also:
    
    getLocalName(int)
  - 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 until set using the setNonNormalizedValue method. 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:
    
    setNonNormalizedValue(int, java.lang.String), setSpecified(int, boolean)
  - 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.
  - setType
```
public void setType(int attrIndex,
                    String attrType)
```
    Sets the type of the attribute at the specified index.
    
    Specified by:
    
    setType in interface XMLAttributes
    
    Parameters:
    
    attrIndex - The attribute index.
    
    attrType - 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)".
  - 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.
    
    See Also:
    
    setNonNormalizedValue(int, java.lang.String)
  - setNonNormalizedValue
```
public void setNonNormalizedValue(int attrIndex,
                                  String attrValue)
```
    Sets the non-normalized value of the attribute at the specified index.
    
    Specified by:
    
    setNonNormalizedValue in interface XMLAttributes
    
    Parameters:
    
    attrIndex - The attribute index.
    
    attrValue - The new non-normalized attribute value.
  - getNonNormalizedValue
```
public String getNonNormalizedValue(int attrIndex)
```
    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.
    
    Specified by:
    
    getNonNormalizedValue in interface XMLAttributes
    
    Parameters:
    
    attrIndex - The attribute index.
  - 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 XMLAttributes
    
    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 XMLAttributes
    
    Returns:
    
    The number of attributes in the list.
    
    See Also:
    
    XMLAttributes.getURI(int), XMLAttributes.getLocalName(int), XMLAttributes.getQName(int), XMLAttributes.getType(int), XMLAttributes.getValue(int)
  - 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 Recommentation (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 XMLAttributes
    
    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 XMLAttributes
    
    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 XMLAttributes
    
    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 XMLAttributes
    
    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.
  - getName
```
public String getName(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()
  - getIndex
```
public int getIndex(String qName)
```
    Look up the index of an attribute by XML 1.0 qualified name.
    
    Specified by:
    
    getIndex in interface XMLAttributes
    
    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 XMLAttributes
    
    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 XMLAttributes
    
    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 XMLAttributes
    
    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 XMLAttributes
    
    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.
  - getPrefix
```
public String getPrefix(int index)
```
    Returns the prefix of the attribute at the specified index.
    
    Specified by:
    
    getPrefix in interface XMLAttributes
    
    Parameters:
    
    index - The index of the attribute.
  - getURI
```
public String getURI(int index)
```
    Look up an attribute's Namespace URI by index.
    
    Specified by:
    
    getURI in interface XMLAttributes
    
    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 XMLAttributes
    
    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.
  - getAugmentations
```
public Augmentations getAugmentations(String uri,
                                      String localName)
```
    Look up an augmentations by Namespace name.
    
    Specified by:
    
    getAugmentations in interface XMLAttributes
    
    Parameters:
    
    uri - The Namespace URI, or null if the
    
    localName - The local name of the attribute.
    
    Returns:
    
    Augmentations
  - getAugmentations
```
public Augmentations getAugmentations(String qName)
```
    Look up an augmentation by XML 1.0 qualified name.
    
    Specified by:
    
    getAugmentations in interface XMLAttributes
    
    Parameters:
    
    qName - The XML 1.0 qualified name.
    
    Returns:
    
    Augmentations
  - getAugmentations
```
public Augmentations getAugmentations(int attributeIndex)
```
    Look up an augmentations by attributes index.
    
    Specified by:
    
    getAugmentations in interface XMLAttributes
    
    Parameters:
    
    attributeIndex - The attribute index.
    
    Returns:
    
    Augmentations
  - setAugmentations
```
public void setAugmentations(int attrIndex,
                             Augmentations augs)
```
    Sets the augmentations of the attribute at the specified index.
    
    Specified by:
    
    setAugmentations in interface XMLAttributes
    
    Parameters:
    
    attrIndex - The attribute index.
    
    augs - The augmentations.
  - setURI
```
public void setURI(int attrIndex,
                   String uri)
```
    Sets the uri of the attribute at the specified index.
    
    Parameters:
    
    attrIndex - The attribute index.
    
    uri - Namespace uri
  - getIndexFast
```
public int getIndexFast(String qName)
```
    Look up the index of an attribute by XML 1.0 qualified name.
    Note: This method uses reference comparison, and thus should only be used internally. We cannot use this method in any code exposed to users as they may not pass in unique strings.
    
    Parameters:
    
    qName - The qualified (prefixed) name.
    
    Returns:
    
    The index of the attribute, or -1 if it does not appear in the list.
  - addAttributeNS
```
public void addAttributeNS(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 until set using the setNonNormalizedValue method. 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
    
    See Also:
    
    setNonNormalizedValue(int, java.lang.String), setSpecified(int, boolean), checkDuplicatesNS()
  - checkDuplicatesNS
```
public QName checkDuplicatesNS()
```
    Checks for duplicate expanded names (local part and namespace name pairs) in the attribute specification. If a duplicate is found its name is returned.
    This should be called once all the in-scope namespaces for the element enclosing these attributes is known, and after all the attributes have gone through namespace binding.
    
    Returns:
    
    the name of a duplicate attribute found in the search, otherwise null.
  - getIndexFast
```
public int getIndexFast(String uri,
                        String localPart)
```
    Look up the index of an attribute by Namespace name.
    Note: This method uses reference comparison, and thus should only be used internally. We cannot use this method in any code exposed to users as they may not pass in unique strings.
    
    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.
  - getTableViewBucket
```
protected int getTableViewBucket(String qname)
```
    Returns the position in the table view where the given attribute name would be hashed.
    
    Parameters:
    
    qname - the attribute name
    
    Returns:
    
    the position in the table view where the given attribute would be hashed
  - getTableViewBucket
```
protected int getTableViewBucket(String localpart,
                                 String uri)
```
    Returns the position in the table view where the given attribute name would be hashed.
    
    Parameters:
    
    localpart - the local part of the attribute
    
    uri - the namespace name of the attribute
    
    Returns:
    
    the position in the table view where the given attribute would be hashed
  - cleanTableView
```
protected void cleanTableView()
```
    Purges all elements from the table view.
  - prepareTableView
```
protected void prepareTableView()
```
    Prepares the table view of the attributes list for use.
  - prepareAndPopulateTableView
```
protected void prepareAndPopulateTableView()
```
    Prepares the table view of the attributes list for use, and populates it with the attributes which have been previously read.

Class XMLAttributesImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TABLE_SIZE

SIZE_LIMIT

fNamespaces

fLargeCount

fLength

fAttributes

fAttributeTableView

fAttributeTableViewChainState

fTableViewBuckets

fIsTableViewConsistent

Constructor Detail

XMLAttributesImpl

XMLAttributesImpl

Method Detail

setNamespaces

addAttribute

removeAllAttributes

removeAttributeAt

setName

getName

setType

setValue

setNonNormalizedValue

getNonNormalizedValue

setSpecified

isSpecified

getLength

getType

getType

getValue

getValue

getName

getIndex

getIndex

getLocalName

getQName

getType

getPrefix

getURI

getValue

getAugmentations

getAugmentations

getAugmentations

setAugmentations

setURI

getIndexFast

addAttributeNS

checkDuplicatesNS

getIndexFast

getTableViewBucket

getTableViewBucket

cleanTableView

prepareTableView

prepareAndPopulateTableView