FileDocCategorySizeDatePackage
AttributesImpl.javaAPI DocJava SE 6 API16973Tue Jun 10 00:27:36 BST 2008org.xml.sax.helpers

AttributesImpl

public class AttributesImpl extends Object implements Attributes
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 {@link org.xml.sax.Attributes 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 {@link org.xml.sax.ContentHandler#startElement startElement} event; or
  2. to construct or modify an Attributes object in a SAX2 driver or filter.

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

since
SAX 2.0
author
David Megginson
version
2.0.1 (sax2r2)

Fields Summary
int
length
String[]
data
Constructors Summary
public AttributesImpl()
Construct a new, empty AttributesImpl object.

	length = 0;
	data = null;
    
public AttributesImpl(Attributes atts)
Copy an existing Attributes object.

This constructor is especially useful inside a {@link org.xml.sax.ContentHandler#startElement startElement} event.

param
atts The existing Attributes object.

	setAttributes(atts);
    
Methods Summary
public voidaddAttribute(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.

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

	ensureCapacity(length+1);
	data[length*5] = uri;
	data[length*5+1] = localName;
	data[length*5+2] = qName;
	data[length*5+3] = type;
	data[length*5+4] = value;
	length++;
    
private voidbadIndex(int index)
Report a bad array index in a manipulator.

param
index The index to report.
exception
java.lang.ArrayIndexOutOfBoundsException Always.

	String msg =
	    "Attempt to modify attribute at illegal index: " + index;
	throw new ArrayIndexOutOfBoundsException(msg);
    
public voidclear()
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.

	if (data != null) {
	    for (int i = 0; i < (length * 5); i++)
		data [i] = null;
	}
	length = 0;
    
private voidensureCapacity(int n)
Ensure the internal array's capacity.

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

        if (n <= 0) {
            return;
        }
        int max;
        if (data == null || data.length == 0) {
            max = 25;
        }
        else if (data.length >= n * 5) {
            return;
        }
        else {
            max = data.length;
        }
        while (max < n * 5) {
            max *= 2;
        }

        String newData[] = new String[max];
        if (length > 0) {
            System.arraycopy(data, 0, newData, 0, length*5);
        }
        data = newData;
    
public intgetIndex(java.lang.String qName)
Look up an attribute's index by qualified (prefixed) name.

param
qName The qualified name.
return
The attribute's index, or -1 if none matches.
see
org.xml.sax.Attributes#getIndex(java.lang.String)

	int max = length * 5;
	for (int i = 0; i < max; i += 5) {
	    if (data[i+2].equals(qName)) {
		return i / 5;
	    }
	} 
	return -1;
    
public intgetIndex(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.

param
uri The attribute's Namespace URI, or the empty string if none is available.
param
localName The attribute's local name.
return
The attribute's index, or -1 if none matches.
see
org.xml.sax.Attributes#getIndex(java.lang.String,java.lang.String)

	int max = length * 5;
	for (int i = 0; i < max; i += 5) {
	    if (data[i].equals(uri) && data[i+1].equals(localName)) {
		return i / 5;
	    }
	} 
	return -1;
    
public intgetLength()
Return the number of attributes in the list.

return
The number of attributes in the list.
see
org.xml.sax.Attributes#getLength

	return length;
    
public java.lang.StringgetLocalName(int index)
Return an attribute's local name.

param
index The attribute's index (zero-based).
return
The attribute's local name, the empty string if none is available, or null if the index if out of range.
see
org.xml.sax.Attributes#getLocalName

	if (index >= 0 && index < length) {
	    return data[index*5+1];
	} else {
	    return null;
	}
    
public java.lang.StringgetQName(int index)
Return an attribute's qualified (prefixed) name.

param
index The attribute's index (zero-based).
return
The attribute's qualified name, the empty string if none is available, or null if the index is out of bounds.
see
org.xml.sax.Attributes#getQName

	if (index >= 0 && index < length) {
	    return data[index*5+2];
	} else {
	    return null;
	}
    
public java.lang.StringgetType(java.lang.String uri, java.lang.String localName)
Look up an attribute's type by Namespace-qualified name.

param
uri The Namespace URI, or the empty string for a name with no explicit Namespace URI.
param
localName The local name.
return
The attribute's type, or null if there is no matching attribute.
see
org.xml.sax.Attributes#getType(java.lang.String,java.lang.String)

	int max = length * 5;
	for (int i = 0; i < max; i += 5) {
	    if (data[i].equals(uri) && data[i+1].equals(localName)) {
		return data[i+3];
	    }
	} 
	return null;
    
public java.lang.StringgetType(java.lang.String qName)
Look up an attribute's type by qualified (prefixed) name.

param
qName The qualified name.
return
The attribute's type, or null if there is no matching attribute.
see
org.xml.sax.Attributes#getType(java.lang.String)

	int max = length * 5;
	for (int i = 0; i < max; i += 5) {
	    if (data[i+2].equals(qName)) {
		return data[i+3];
	    }
	}
	return null;
    
public java.lang.StringgetType(int index)
Return an attribute's type by index.

param
index The attribute's index (zero-based).
return
The attribute's type, "CDATA" if the type is unknown, or null if the index is out of bounds.
see
org.xml.sax.Attributes#getType(int)

	if (index >= 0 && index < length) {
	    return data[index*5+3];
	} else {
	    return null;
	}
    
public java.lang.StringgetURI(int index)
Return an attribute's Namespace URI.

param
index The attribute's index (zero-based).
return
The Namespace URI, the empty string if none is available, or null if the index is out of range.
see
org.xml.sax.Attributes#getURI

	if (index >= 0 && index < length) {
	    return data[index*5];
	} else {
	    return null;
	}
    
public java.lang.StringgetValue(java.lang.String uri, java.lang.String localName)
Look up an attribute's value by Namespace-qualified name.

param
uri The Namespace URI, or the empty string for a name with no explicit Namespace URI.
param
localName The local name.
return
The attribute's value, or null if there is no matching attribute.
see
org.xml.sax.Attributes#getValue(java.lang.String,java.lang.String)

	int max = length * 5;
	for (int i = 0; i < max; i += 5) {
	    if (data[i].equals(uri) && data[i+1].equals(localName)) {
		return data[i+4];
	    }
	}
	return null;
    
public java.lang.StringgetValue(java.lang.String qName)
Look up an attribute's value by qualified (prefixed) name.

param
qName The qualified name.
return
The attribute's value, or null if there is no matching attribute.
see
org.xml.sax.Attributes#getValue(java.lang.String)

	int max = length * 5;
	for (int i = 0; i < max; i += 5) {
	    if (data[i+2].equals(qName)) {
		return data[i+4];
	    }
	}
	return null;
    
public java.lang.StringgetValue(int index)
Return an attribute's value by index.

param
index The attribute's index (zero-based).
return
The attribute's value or null if the index is out of bounds.
see
org.xml.sax.Attributes#getValue(int)

	if (index >= 0 && index < length) {
	    return data[index*5+4];
	} else {
	    return null;
	}
    
public voidremoveAttribute(int index)
Remove an attribute from the list.

param
index The index of the attribute (zero-based).
exception
java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.

	if (index >= 0 && index < length) {
	    if (index < length - 1) {
		System.arraycopy(data, (index+1)*5, data, index*5,
				 (length-index-1)*5);
	    }
	    index = (length - 1) * 5;
	    data [index++] = null;
	    data [index++] = null;
	    data [index++] = null;
	    data [index++] = null;
	    data [index] = null;
	    length--;
	} else {
	    badIndex(index);
	}
    
public voidsetAttribute(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.

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

	if (index >= 0 && index < length) {
	    data[index*5] = uri;
	    data[index*5+1] = localName;
	    data[index*5+2] = qName;
	    data[index*5+3] = type;
	    data[index*5+4] = value;
	} else {
	    badIndex(index);
	}
    
public voidsetAttributes(org.xml.sax.Attributes atts)
Copy an entire Attributes object.

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

param
atts The attributes to copy.

        clear();
        length = atts.getLength();
        if (length > 0) {
            data = new String[length*5];
            for (int i = 0; i < length; i++) {
                data[i*5] = atts.getURI(i);
                data[i*5+1] = atts.getLocalName(i);
                data[i*5+2] = atts.getQName(i);
                data[i*5+3] = atts.getType(i);
                data[i*5+4] = atts.getValue(i);
            }
	}
    
public voidsetLocalName(int index, java.lang.String localName)
Set the local name of a specific attribute.

param
index The index of the attribute (zero-based).
param
localName The attribute's local name, or the empty string for none.
exception
java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.

	if (index >= 0 && index < length) {
	    data[index*5+1] = localName;
	} else {
	    badIndex(index);
	}
    
public voidsetQName(int index, java.lang.String qName)
Set the qualified name of a specific attribute.

param
index The index of the attribute (zero-based).
param
qName The attribute's qualified name, or the empty string for none.
exception
java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.

	if (index >= 0 && index < length) {
	    data[index*5+2] = qName;
	} else {
	    badIndex(index);
	}
    
public voidsetType(int index, java.lang.String type)
Set the type of a specific attribute.

param
index The index of the attribute (zero-based).
param
type The attribute's type.
exception
java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.

	if (index >= 0 && index < length) {
	    data[index*5+3] = type;
	} else {
	    badIndex(index);
	}
    
public voidsetURI(int index, java.lang.String uri)
Set the Namespace URI of a specific attribute.

param
index The index of the attribute (zero-based).
param
uri The attribute's Namespace URI, or the empty string for none.
exception
java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.

	if (index >= 0 && index < length) {
	    data[index*5] = uri;
	} else {
	    badIndex(index);
	}
    
public voidsetValue(int index, java.lang.String value)
Set the value of a specific attribute.

param
index The index of the attribute (zero-based).
param
value The attribute's value.
exception
java.lang.ArrayIndexOutOfBoundsException When the supplied index does not point to an attribute in the list.

	if (index >= 0 && index < length) {
	    data[index*5+4] = value;
	} else {
	    badIndex(index);
	}