Added in API level 1

Summary: Ctors | Methods | Inherited Methods

AttributesImpl

public class AttributesImpl
extends Object implements Attributes

java.lang.Object
↳	org.xml.sax.helpers.AttributesImpl

Known direct subclasses

Attributes2Impl

Attributes2Impl SAX2 extension helper for additional Attributes information, implementing the Attributes2 interface.

Default implementation of the Attributes interface.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

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

There are two typical uses of this class:

to take a persistent snapshot of an Attributes object in a startElement event; or
to construct or modify an Attributes object in a SAX2 driver or filter.

This class replaces the now-deprecated SAX1 AttributeListImpl class; in addition to supporting the updated Attributes interface rather than the deprecated AttributeList interface, it also includes a much more efficient implementation using a single array rather than a set of Vectors.

Summary

Public constructors
`AttributesImpl()` Construct a new, empty AttributesImpl object.
`AttributesImpl(Attributes atts)` Copy an existing Attributes object.

Public methods
`void`	`addAttribute(String uri, String localName, String qName, String type, String value)` Add an attribute to the end of the list.
`void`	`clear()` Clear the attribute list for reuse.
`int`	`getIndex(String qName)` Look up an attribute's index by qualified (prefixed) name.
`int`	`getIndex(String uri, String localName)` Look up an attribute's index by Namespace name.
`int`	`getLength()` Return the number of attributes in the list.
`String`	`getLocalName(int index)` Return an attribute's local name.
`String`	`getQName(int index)` Return an attribute's qualified (prefixed) name.
`String`	`getType(String qName)` Look up an attribute's type by qualified (prefixed) name.
`String`	`getType(int index)` Return an attribute's type by index.
`String`	`getType(String uri, String localName)` Look up an attribute's type by Namespace-qualified name.
`String`	`getURI(int index)` Return an attribute's Namespace URI.
`String`	`getValue(String qName)` Look up an attribute's value by qualified (prefixed) name.
`String`	`getValue(String uri, String localName)` Look up an attribute's value by Namespace-qualified name.
`String`	`getValue(int index)` Return an attribute's value by index.
`void`	`removeAttribute(int index)` Remove an attribute from the list.
`void`	`setAttribute(int index, String uri, String localName, String qName, String type, String value)` Set an attribute in the list.
`void`	`setAttributes(Attributes atts)` Copy an entire Attributes object.
`void`	`setLocalName(int index, String localName)` Set the local name of a specific attribute.
`void`	`setQName(int index, String qName)` Set the qualified name of a specific attribute.
`void`	`setType(int index, String type)` Set the type of a specific attribute.
`void`	`setURI(int index, String uri)` Set the Namespace URI of a specific attribute.
`void`	`setValue(int index, String value)` Set the value of a specific attribute.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          org.xml.sax.Attributes

`abstract int`	`getIndex(String qName)` Look up the index of an attribute by XML qualified (prefixed) name.
`abstract int`	`getIndex(String uri, String localName)` Look up the index of an attribute by Namespace name.
`abstract int`	`getLength()` Return the number of attributes in the list.
`abstract String`	`getLocalName(int index)` Look up an attribute's local name by index.
`abstract String`	`getQName(int index)` Look up an attribute's XML qualified (prefixed) name by index.
`abstract String`	`getType(String qName)` Look up an attribute's type by XML qualified (prefixed) name.
`abstract String`	`getType(int index)` Look up an attribute's type by index.
`abstract String`	`getType(String uri, String localName)` Look up an attribute's type by Namespace name.
`abstract String`	`getURI(int index)` Look up an attribute's Namespace URI by index.
`abstract String`	`getValue(String qName)` Look up an attribute's value by XML qualified (prefixed) name.
`abstract String`	`getValue(int index)` Look up an attribute's value by index.
`abstract String`	`getValue(String uri, String localName)` Look up an attribute's value by Namespace name.

Public constructors

AttributesImpl

Added in API level 1

public AttributesImpl ()

Construct a new, empty AttributesImpl object.

AttributesImpl

Added in API level 1

public AttributesImpl (Attributes atts)

Copy an existing Attributes object.

This constructor is especially useful inside a startElement event.

Parameters
`atts`	`Attributes`: The existing Attributes object.

Public methods

addAttribute

Added in API level 1

public void addAttribute (String uri, 
                String localName, 
                String qName, 
                String type, 
                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`	`String`: The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
`localName`	`String`: The local name, or the empty string if Namespace processing is not being performed.
`qName`	`String`: The qualified (prefixed) name, or the empty string if qualified names are not available.
`type`	`String`: The attribute type as a string.
`value`	`String`: The attribute value.

clear

Added in API level 1

public void clear ()

Clear the attribute list for reuse.

Note that little memory is freed by this call: the current array is kept so it can be reused.

getIndex

Added in API level 1

public int getIndex (String qName)

Look up an attribute's index by qualified (prefixed) name.

Parameters
`qName`	`String`: The qualified name.

Returns
`int`	The attribute's index, or -1 if none matches.

See also:

Attributes.getIndex(java.lang.String)

getIndex

Added in API level 1

public int getIndex (String uri, 
                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`	`String`: The attribute's Namespace URI, or the empty string if none is available.
`localName`	`String`: The attribute's local name.

Returns
`int`	The attribute's index, or -1 if none matches.

See also:

Attributes.getIndex(java.lang.String, java.lang.String)

getLength

Added in API level 1

public int getLength ()

Return the number of attributes in the list.

Returns
`int`	The number of attributes in the list.

See also:

Attributes.getLength()

getLocalName

Added in API level 1

public String getLocalName (int index)

Return an attribute's local name.

Parameters
`index`	`int`: The attribute's index (zero-based).

Returns
`String`	The attribute's local name, the empty string if none is available, or null if the index if out of range.

See also:

Attributes.getLocalName(int)

getQName

Added in API level 1

public String getQName (int index)

Return an attribute's qualified (prefixed) name.

Parameters
`index`	`int`: The attribute's index (zero-based).

Returns
`String`	The attribute's qualified name, the empty string if none is available, or null if the index is out of bounds.

See also:

Attributes.getQName(int)

getType

Added in API level 1

public String getType (String qName)

Look up an attribute's type by qualified (prefixed) name.

Parameters
`qName`	`String`: The qualified name.

Returns
`String`	The attribute's type, or null if there is no matching attribute.

See also:

Attributes.getType(java.lang.String)

getType

Added in API level 1

public String getType (int index)

Return an attribute's type by index.

Parameters
`index`	`int`: The attribute's index (zero-based).

Returns
`String`	The attribute's type, "CDATA" if the type is unknown, or null if the index is out of bounds.

See also:

Attributes.getType(int)

getType

Added in API level 1

public String getType (String uri, 
                String localName)

Look up an attribute's type by Namespace-qualified name.

Parameters
`uri`	`String`: The Namespace URI, or the empty string for a name with no explicit Namespace URI.
`localName`	`String`: The local name.

Returns
`String`	The attribute's type, or null if there is no matching attribute.

See also:

Attributes.getType(java.lang.String, java.lang.String)

getURI

Added in API level 1

public String getURI (int index)

Return an attribute's Namespace URI.

Parameters
`index`	`int`: The attribute's index (zero-based).

Returns
`String`	The Namespace URI, the empty string if none is available, or null if the index is out of range.

See also:

Attributes.getURI(int)

getValue

Added in API level 1

public String getValue (String qName)

Look up an attribute's value by qualified (prefixed) name.

Parameters
`qName`	`String`: The qualified name.

Returns
`String`	The attribute's value, or null if there is no matching attribute.

See also:

Attributes.getValue(java.lang.String)

getValue

Added in API level 1

public String getValue (String uri, 
                String localName)

Look up an attribute's value by Namespace-qualified name.

Parameters
`uri`	`String`: The Namespace URI, or the empty string for a name with no explicit Namespace URI.
`localName`	`String`: The local name.

Returns
`String`	The attribute's value, or null if there is no matching attribute.

See also:

Attributes.getValue(java.lang.String, java.lang.String)

getValue

Added in API level 1

public String getValue (int index)

Return an attribute's value by index.

Parameters
`index`	`int`: The attribute's index (zero-based).

Returns
`String`	The attribute's value or null if the index is out of bounds.

See also:

Attributes.getValue(int)

removeAttribute

Added in API level 1

public void removeAttribute (int index)

Remove an attribute from the list.

Parameters
`index`	`int`: The index of the attribute (zero-based).

Throws
`ArrayIndexOutOfBoundsException`	When the supplied index does not point to an attribute in the list.

setAttribute

Added in API level 1

public void setAttribute (int index, 
                String uri, 
                String localName, 
                String qName, 
                String type, 
                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`	`int`: The index of the attribute (zero-based).
`uri`	`String`: The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
`localName`	`String`: The local name, or the empty string if Namespace processing is not being performed.
`qName`	`String`: The qualified name, or the empty string if qualified names are not available.
`type`	`String`: The attribute type as a string.
`value`	`String`: The attribute value.

Throws
`ArrayIndexOutOfBoundsException`	When the supplied index does not point to an attribute in the list.

setAttributes

Added in API level 1

public void setAttributes (Attributes atts)

Copy an entire Attributes object.

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

Parameters
`atts`	`Attributes`: The attributes to copy.

setLocalName

Added in API level 1

public void setLocalName (int index, 
                String localName)

Set the local name of a specific attribute.

Parameters
`index`	`int`: The index of the attribute (zero-based).
`localName`	`String`: The attribute's local name, or the empty string for none.

Throws
`ArrayIndexOutOfBoundsException`	When the supplied index does not point to an attribute in the list.

setQName

Added in API level 1

public void setQName (int index, 
                String qName)

Set the qualified name of a specific attribute.

Parameters
`index`	`int`: The index of the attribute (zero-based).
`qName`	`String`: The attribute's qualified name, or the empty string for none.

Throws
`ArrayIndexOutOfBoundsException`	When the supplied index does not point to an attribute in the list.

setType

Added in API level 1

public void setType (int index, 
                String type)

Set the type of a specific attribute.

Parameters
`index`	`int`: The index of the attribute (zero-based).
`type`	`String`: The attribute's type.

Throws
`ArrayIndexOutOfBoundsException`	When the supplied index does not point to an attribute in the list.

setURI

Added in API level 1

public void setURI (int index, 
                String uri)

Set the Namespace URI of a specific attribute.

Parameters
`index`	`int`: The index of the attribute (zero-based).
`uri`	`String`: The attribute's Namespace URI, or the empty string for none.

Throws
`ArrayIndexOutOfBoundsException`	When the supplied index does not point to an attribute in the list.

setValue

Added in API level 1

public void setValue (int index, 
                String value)

Set the value of a specific attribute.

Parameters
`index`	`int`: The index of the attribute (zero-based).
`value`	`String`: The attribute's value.

Throws
`ArrayIndexOutOfBoundsException`	When the supplied index does not point to an attribute in the list.