Google

Xerces 3.1.1 API: Class AttributesImpl
Xerces 3.1.1


Class AttributesImpl

java.lang.Object
  |

Default implementation of the Attributes interface.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This class provides a default implementation of the SAX2 addition of manipulators so that the list can be modified or reused.

There are two typical uses of this class:

  1. to take a persistent snapshot of an Attributes object
  2. to construct or modify an Attributes object in a SAX2 driver or filter.
class; in addition to supporting the updated Attributes implementation using a single array rather than a set of Vectors.

Since:
SAX 2.0
Version:
2.0


          Construct a new, empty AttributesImpl object.
          Copy an existing Attributes object.
Constructor Summary
  java.lang.String localName, java.lang.String qName, java.lang.String type, java.lang.String value)
          Add an attribute to the end of the list.
          Clear the attribute list for reuse.
          Look up an attribute's index by qualified (prefixed) name. java.lang.String localName)
          Look up an attribute's index by Namespace name.
          Return the number of attributes in the list.
          Return an attribute's local name.
          Return an attribute's qualified (prefixed) name.
          Return an attribute's type by index.
          Look up an attribute's type by qualified (prefixed) name. java.lang.String localName)
          Look up an attribute's type by Namespace-qualified name.
          Return an attribute's Namespace URI.
          Return an attribute's value by index.
          Look up an attribute's value by qualified (prefixed) name. java.lang.String localName)
          Look up an attribute's value by Namespace-qualified name.
          Remove an attribute from the list. java.lang.String uri, java.lang.String localName, java.lang.String qName, java.lang.String type, java.lang.String value)
          Set an attribute in the list.
          Copy an entire Attributes object. java.lang.String localName)
          Set the local name of a specific attribute. java.lang.String qName)
          Set the qualified name of a specific attribute. java.lang.String type)
          Set the type of a specific attribute. java.lang.String uri)
          Set the Namespace URI of a specific attribute. java.lang.String value)
          Set the value of a specific attribute.
Method Summary
 void
 void
 int
 int
 int
 java.lang.String
 java.lang.String
 java.lang.String
 java.lang.String
 java.lang.String
 java.lang.String
 java.lang.String
 java.lang.String
 java.lang.String
 void
 void
 void
 void
 void
 void
 void
 void
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttributesImpl

public AttributesImpl()
Construct a new, empty AttributesImpl object.

AttributesImpl
Copy an existing Attributes object.

This constructor is especially useful inside a

Parameters:
atts - The existing Attributes object.
Method Detail

getLength

public int getLength()
Return the number of attributes in the list.

getURI

public java.lang.String getURI(int index)
Return an attribute's Namespace URI.
Parameters:
index - The attribute's index (zero-based).
Returns:
The Namespace URI, the empty string if none is

getLocalName

public java.lang.String getLocalName(int index)
Return an attribute's local name.
Parameters:
index - The attribute's index (zero-based).
Returns:
The attribute's local name, the empty string if

getQName

public java.lang.String getQName(int index)
Return an attribute's qualified (prefixed) name.
Parameters:
index - The attribute's index (zero-based).
Returns:
The attribute's qualified name, the empty string if

getType

public java.lang.String getType(int index)
Return an attribute's type by index.
Parameters:
index - The attribute's index (zero-based).
Returns:
The attribute's type, "CDATA" if the type is unknown, or null

getValue

public java.lang.String getValue(int index)
Return an attribute's value by index.

getIndex

public int getIndex(java.lang.String uri,
                    java.lang.String localName)
Look up an attribute's index by Namespace name.

In many cases, it will be more efficient to look up the name once and use the index query methods rather than using the name query methods repeatedly.

Parameters:
uri - The attribute's Namespace URI, or the empty

getIndex

public int getIndex(java.lang.String qName)
Look up an attribute's index by qualified (prefixed) name.

getType

public java.lang.String getType(java.lang.String uri,
                                java.lang.String localName)
Look up an attribute's type by Namespace-qualified name.
Parameters:
uri - The Namespace URI, or the empty string for a name with no explicit Namespace URI.
localName - The local name.
Returns:
The attribute's type, or null if there is no

getType

public java.lang.String getType(java.lang.String qName)
Look up an attribute's type by qualified (prefixed) name.
Parameters:
qName - The qualified name.
Returns:
The attribute's type, or null if there is no

getValue

public java.lang.String getValue(java.lang.String uri,
                                 java.lang.String localName)
Look up an attribute's value by Namespace-qualified name.
Parameters:
uri - The Namespace URI, or the empty string for a name with no explicit Namespace URI.
localName - The local name.
Returns:
The attribute's value, or null if there is no

getValue

public java.lang.String getValue(java.lang.String qName)
Look up an attribute's value by qualified (prefixed) name.
Parameters:
qName - The qualified name.
Returns:
The attribute's value, or null if there is no

clear

public void clear()
Clear the attribute list for reuse.

Note that no memory is actually freed by this call: the current arrays are kept so that they can be reused.


setAttributes
Copy an entire Attributes object.

It may be more efficient to reuse an existing object rather than constantly allocating new ones.

Parameters:
atts - The attributes to copy.

addAttribute

public void addAttribute(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         java.lang.String type,
                         java.lang.String value)
Add an attribute to the end of the list.

For the sake of speed, this method does no checking to see if the attribute is already in the list: that is the responsibility of the application.

Parameters:
uri - The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
localName - The local name, or the empty string if Namespace processing is not being performed.
qName - The qualified (prefixed) name, or the empty string if qualified names are not available.
type - The attribute type as a string.
value - The attribute value.

setAttribute

public void setAttribute(int index,
                         java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         java.lang.String type,
                         java.lang.String value)
Set an attribute in the list.

For the sake of speed, this method does no checking for name conflicts or well-formedness: such checks are the responsibility of the application.

Parameters:
index - The index of the attribute (zero-based).
uri - The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
localName - The local name, or the empty string if Namespace processing is not being performed.
qName - The qualified name, or the empty string if qualified names are not available.
type - The attribute type as a string.
value - The attribute value.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not point to an attribute in the list.

removeAttribute

public void removeAttribute(int index)
Remove an attribute from the list.
Parameters:
index - The index of the attribute (zero-based).
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not point to an attribute in the list.

setURI

public void setURI(int index,
                   java.lang.String uri)
Set the Namespace URI of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
uri - The attribute's Namespace URI, or the empty string for none.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not point to an attribute in the list.

setLocalName

public void setLocalName(int index,
                         java.lang.String localName)
Set the local name of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
localName - The attribute's local name, or the empty string for none.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not point to an attribute in the list.

setQName

public void setQName(int index,
                     java.lang.String qName)
Set the qualified name of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
qName - The attribute's qualified name, or the empty string for none.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not point to an attribute in the list.

setType

public void setType(int index,
                    java.lang.String type)
Set the type of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
type - The attribute's type.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not point to an attribute in the list.

setValue

public void setValue(int index,
                     java.lang.String value)
Set the value of a specific attribute.
Parameters:
index - The index of the attribute (zero-based).
value - The attribute's value.
Throws:
java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not point to an attribute in the list.

Xerces 3.1.1