Top Description Fields Constructors Methods
org.xml.sax.helpers

public Class AttributesImpl

extends Object
implements Attributes
Class Inheritance
All Implemented Interfaces
org.xml.sax.Attributes
Known Direct Subclasses
com.sun.org.apache.xml.internal.utils.MutableAttrListImpl, com.sun.org.apache.xml.internal.serializer.AttributesImplSerializer, org.xml.sax.ext.Attributes2Impl
Imports
org.xml.sax.Attributes
Default implementation of the Attributes interface.

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:

  1. to take a persistent snapshot of an Attributes object in a startElement event; or
  2. 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.

Author
David Megginson
Since
1.4, SAX 2.0

Field Summary

Modifier and TypeField and Description
pack-priv String[]
data

pack-priv int
length

Constructor Summary

AccessConstructor and Description
public
AttributesImpl()

Construct a new, empty AttributesImpl object.

public
AttributesImpl(Attributes
The existing Attributes object.
atts)

Copy an existing Attributes object.

Method Summary

Modifier and TypeMethod and Description
public void
addAttribute(String
The Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
uri, String
The local name, or the empty string if Namespace processing is not being performed.
localName, String
The qualified (prefixed) name, or the empty string if qualified names are not available.
qName, String
The attribute type as a string.
type, String
The attribute value.
value)

Add an attribute to the end of the list.

private void
badIndex(int
The index to report.
index)

Report a bad array index in a manipulator.

public void
clear()

Clear the attribute list for reuse.

private void
ensureCapacity(int
The minimum number of attributes that the array must be able to hold.
n)

Ensure the internal array's capacity.

public int

Returns:

The attribute's index, or -1 if none matches.
getIndex(String
The attribute's Namespace URI, or the empty string if none is available.
uri, String
The attribute's local name.
localName)

Implements org.xml.sax.Attributes.getIndex.

Look up an attribute's index by Namespace name.
public int

Returns:

The attribute's index, or -1 if none matches.
getIndex(String
The qualified name.
qName)

Implements org.xml.sax.Attributes.getIndex.

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

Returns:

The number of attributes in the list.
getLength()

Implements org.xml.sax.Attributes.getLength.

Return the number of attributes in the list.
public String

Returns:

The attribute's local name, the empty string if none is available, or null if the index if out of range.
getLocalName(int
The attribute's index (zero-based).
index)

Implements org.xml.sax.Attributes.getLocalName.

Return an attribute's local name.
public String

Returns:

The attribute's qualified name, the empty string if none is available, or null if the index is out of bounds.
getQName(int
The attribute's index (zero-based).
index)

Implements org.xml.sax.Attributes.getQName.

Return an attribute's qualified (prefixed) name.
public String

Returns:

The attribute's type, "CDATA" if the type is unknown, or null if the index is out of bounds.
getType(int
The attribute's index (zero-based).
index)

Implements org.xml.sax.Attributes.getType.

Return an attribute's type by index.
public String

Returns:

The attribute's type, or null if there is no matching attribute.
getType(String
The Namespace URI, or the empty string for a name with no explicit Namespace URI.
uri, String
The local name.
localName)

Implements org.xml.sax.Attributes.getType.

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

Returns:

The attribute's type, or null if there is no matching attribute.
getType(String
The qualified name.
qName)

Implements org.xml.sax.Attributes.getType.

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

Returns:

The Namespace URI, the empty string if none is available, or null if the index is out of range.
getURI(int
The attribute's index (zero-based).
index)

Implements org.xml.sax.Attributes.getURI.

Return an attribute's Namespace URI.
public String

Returns:

The attribute's value or null if the index is out of bounds.
getValue(int
The attribute's index (zero-based).
index)

Implements org.xml.sax.Attributes.getValue.

Return an attribute's value by index.
public String

Returns:

The attribute's value, or null if there is no matching attribute.
getValue(String
The Namespace URI, or the empty string for a name with no explicit Namespace URI.
uri, String
The local name.
localName)

Implements org.xml.sax.Attributes.getValue.

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

Returns:

The attribute's value, or null if there is no matching attribute.
getValue(String
The qualified name.
qName)

Implements org.xml.sax.Attributes.getValue.

Look up an attribute's value by qualified (prefixed) name.
public void
removeAttribute(int
The index of the attribute (zero-based).
index)

Remove an attribute from the list.

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

Set an attribute in the list.

public void
setAttributes(Attributes
The attributes to copy.
atts)

Copy an entire Attributes object.

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

Set the local name of a specific attribute.

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

Set the qualified name of a specific attribute.

public void
setType(int
The index of the attribute (zero-based).
index, String
The attribute's type.
type)

Set the type of a specific attribute.

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

Set the Namespace URI of a specific attribute.

public void
setValue(int
The index of the attribute (zero-based).
index, String
The attribute's value.
value)

Set the value of a specific attribute.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

databack to summary
pack-priv String[] data
lengthback to summary
pack-priv int length

Constructor Detail

AttributesImplback to summary
public AttributesImpl()

Construct a new, empty AttributesImpl object.

AttributesImplback to summary
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.

Method Detail

addAttributeback to summary
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.

badIndexback to summary
private void badIndex(int index) throws ArrayIndexOutOfBoundsException

Report a bad array index in a manipulator.

Parameters
index:int

The index to report.

Exceptions
ArrayIndexOutOfBoundsException:
Always.
clearback to summary
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.

ensureCapacityback to summary
private void ensureCapacity(int n)

Ensure the internal array's capacity.

Parameters
n:int

The minimum number of attributes that the array must be able to hold.

getIndexback to summary
public int getIndex(String uri, String localName)

Implements org.xml.sax.Attributes.getIndex.

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
org.xml.sax.Attributes#getIndex(java.lang.String, java.lang.String)
getIndexback to summary
public int getIndex(String qName)

Implements org.xml.sax.Attributes.getIndex.

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
org.xml.sax.Attributes#getIndex(java.lang.String)
getLengthback to summary
public int getLength()

Implements org.xml.sax.Attributes.getLength.

Return the number of attributes in the list.

Returns:int

The number of attributes in the list.

See Also
org.xml.sax.Attributes#getLength
getLocalNameback to summary
public String getLocalName(int index)

Implements org.xml.sax.Attributes.getLocalName.

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
org.xml.sax.Attributes#getLocalName
getQNameback to summary
public String getQName(int index)

Implements org.xml.sax.Attributes.getQName.

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
org.xml.sax.Attributes#getQName
getTypeback to summary
public String getType(int index)

Implements org.xml.sax.Attributes.getType.

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
org.xml.sax.Attributes#getType(int)
getTypeback to summary
public String getType(String uri, String localName)

Implements org.xml.sax.Attributes.getType.

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
org.xml.sax.Attributes#getType(java.lang.String, java.lang.String)
getTypeback to summary
public String getType(String qName)

Implements org.xml.sax.Attributes.getType.

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
org.xml.sax.Attributes#getType(java.lang.String)
getURIback to summary
public String getURI(int index)

Implements org.xml.sax.Attributes.getURI.

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
org.xml.sax.Attributes#getURI
getValueback to summary
public String getValue(int index)

Implements org.xml.sax.Attributes.getValue.

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
org.xml.sax.Attributes#getValue(int)
getValueback to summary
public String getValue(String uri, String localName)

Implements org.xml.sax.Attributes.getValue.

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
org.xml.sax.Attributes#getValue(java.lang.String, java.lang.String)
getValueback to summary
public String getValue(String qName)

Implements org.xml.sax.Attributes.getValue.

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
org.xml.sax.Attributes#getValue(java.lang.String)
removeAttributeback to summary
public void removeAttribute(int index)

Remove an attribute from the list.

Parameters
index:int

The index of the attribute (zero-based).

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not point to an attribute in the list.
setAttributeback to summary
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.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not point to an attribute in the list.
setAttributesback to summary
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.

setLocalNameback to summary
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.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not point to an attribute in the list.
setQNameback to summary
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.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not point to an attribute in the list.
setTypeback to summary
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.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not point to an attribute in the list.
setURIback to summary
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.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not point to an attribute in the list.
setValueback to summary
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.

Exceptions
ArrayIndexOutOfBoundsException:
When the supplied index does not point to an attribute in the list.