com.bluecast.xml

Class AttributesHolder

Implemented Interfaces:
AttributeList, Attributes

public final class AttributesHolder
extends java.lang.Object
implements Attributes, AttributeList

This is an extension to Megginson's AttributesImpl to make it compatible with SAX 1. It also adds a method to check for uniqueness while adding attributes.
Version:
$Revision: 1.4 $
Author:
Yuval Oren, yuval@bluecast.com

Field Summary

protected String[]
data
protected int
length

Constructor Summary

AttributesHolder()
Construct a new, empty AttributesHolder object.
AttributesHolder(Attributes atts)
Copy an existing Attributes object.

Method Summary

void
addAndCheckAttribute(String uri, String localName, String qName, String type, String value)
Add an attribute while checking if it is unique.
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
getName(int i)
Return an attributes XML 1.0 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(String uri, String localName)
Look up an attribute's type by Namespace-qualified name.
String
getType(int index)
Return an attribute's type by index.
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.

Field Details

data

protected String[] data

length

protected int length

Constructor Details

AttributesHolder

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

AttributesHolder

public AttributesHolder(Attributes atts)
Copy an existing Attributes object.

This constructor is especially useful inside a startElement event.

Parameters:
atts - The existing Attributes object.

Method Details

addAndCheckAttribute

public void addAndCheckAttribute(String uri,
                                 String localName,
                                 String qName,
                                 String type,
                                 String value)
            throws SAXException
Add an attribute while checking if it is unique.

addAttribute

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 - 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.

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.


getIndex

public int getIndex(String qName)
Look up an attribute's index by qualified (prefixed) name.
Specified by:
getIndex in interface Attributes
Parameters:
qName - The qualified name.
Returns:
The attribute's index, or -1 if none matches.
See Also:
org.xml.sax.Attributes.getIndex(java.lang.String)

getIndex

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.

Specified by:
getIndex in interface Attributes
Parameters:
uri - The attribute's Namespace URI, or the empty string if none is available.
localName - The attribute's local name.
Returns:
The attribute's index, or -1 if none matches.
See Also:
org.xml.sax.Attributes.getIndex(java.lang.String,java.lang.String)

getLength

public int getLength()
Return the number of attributes in the list.
Specified by:
getLength in interface Attributes
getLength in interface AttributeList
Returns:
The number of attributes in the list.

getLocalName

public String getLocalName(int index)
Return an attribute's local name.
Specified by:
getLocalName in interface Attributes
Parameters:
index - The attribute's index (zero-based).
Returns:
The attribute's local name, the empty string if none is available, or null if the index if out of range.

getName

public String getName(int i)
Return an attributes XML 1.0 name. This returns the same result as getQName().
Specified by:
getName in interface AttributeList
See Also:
getQName(int)

getQName

public String getQName(int index)
Return an attribute's qualified (prefixed) name.
Specified by:
getQName in interface Attributes
Parameters:
index - The attribute's index (zero-based).
Returns:
The attribute's qualified name, the empty string if none is available, or null if the index is out of bounds.

getType

public String getType(String qName)
Look up an attribute's type by qualified (prefixed) name.
Specified by:
getType in interface Attributes
getType in interface AttributeList
Parameters:
qName - The qualified name.
Returns:
The attribute's type, or null if there is no matching attribute.
See Also:
org.xml.sax.Attributes.getType(java.lang.String)

getType

public String getType(String uri,
                      String localName)
Look up an attribute's type by Namespace-qualified name.
Specified by:
getType in interface Attributes
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 matching attribute.
See Also:
org.xml.sax.Attributes.getType(java.lang.String,java.lang.String)

getType

public String getType(int index)
Return an attribute's type by index.
Specified by:
getType in interface Attributes
getType in interface AttributeList
Parameters:
index - The attribute's index (zero-based).
Returns:
The attribute's type, "CDATA" if the type is unknown, or null if the index is out of bounds.

getURI

public String getURI(int index)
Return an attribute's Namespace URI.
Specified by:
getURI in interface Attributes
Parameters:
index - The attribute's index (zero-based).
Returns:
The Namespace URI, the empty string if none is available, or null if the index is out of range.

getValue

public String getValue(String qName)
Look up an attribute's value by qualified (prefixed) name.
Specified by:
getValue in interface Attributes
getValue in interface AttributeList
Parameters:
qName - The qualified name.
Returns:
The attribute's value, or null if there is no matching attribute.
See Also:
org.xml.sax.Attributes.getValue(java.lang.String)

getValue

public String getValue(String uri,
                       String localName)
Look up an attribute's value by Namespace-qualified name.
Specified by:
getValue in interface Attributes
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 matching attribute.
See Also:
org.xml.sax.Attributes.getValue(java.lang.String,java.lang.String)

getValue

public String getValue(int index)
Return an attribute's value by index.
Specified by:
getValue in interface Attributes
getValue in interface AttributeList
Parameters:
index - The attribute's index (zero-based).
Returns:
The attribute's value or null if the index is out of bounds.

removeAttribute

public void removeAttribute(int index)
Remove an attribute from the list.
Parameters:
index - The index of the attribute (zero-based).

setAttribute

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 - 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.

setAttributes

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 - The attributes to copy.

setLocalName

public void setLocalName(int index,
                         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.

setQName

public void setQName(int index,
                     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.

setType

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

setURI

public void setURI(int index,
                   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.

setValue

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