|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xml.sax.helpers.AttributesImpl
public class AttributesImpl
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:
startElement
event; orThis 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.
Constructor Summary | |
---|---|
AttributesImpl()
Construct a new, empty AttributesImpl object. |
|
AttributesImpl(Attributes atts)
Copy an existing Attributes object. |
Method Summary | |
---|---|
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. |
void |
clear()
Clear the attribute list for reuse. |
int |
getIndex(java.lang.String qName)
Look up an attribute's index by qualified (prefixed) name. |
int |
getIndex(java.lang.String uri,
java.lang.String localName)
Look up an attribute's index by Namespace name. |
int |
getLength()
Return the number of attributes in the list. |
java.lang.String |
getLocalName(int index)
Return an attribute's local name. |
java.lang.String |
getQName(int index)
Return an attribute's qualified (prefixed) name. |
java.lang.String |
getType(int index)
Return an attribute's type by index. |
java.lang.String |
getType(java.lang.String qName)
Look up an attribute's type by qualified (prefixed) name. |
java.lang.String |
getType(java.lang.String uri,
java.lang.String localName)
Look up an attribute's type by Namespace-qualified name. |
java.lang.String |
getURI(int index)
Return an attribute's Namespace URI. |
java.lang.String |
getValue(int index)
Return an attribute's value by index. |
java.lang.String |
getValue(java.lang.String qName)
Look up an attribute's value by qualified (prefixed) name. |
java.lang.String |
getValue(java.lang.String uri,
java.lang.String localName)
Look up an attribute's value by Namespace-qualified name. |
void |
removeAttribute(int index)
Remove an attribute from the list. |
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. |
void |
setAttributes(Attributes atts)
Copy an entire Attributes object. |
void |
setLocalName(int index,
java.lang.String localName)
Set the local name of a specific attribute. |
void |
setQName(int index,
java.lang.String qName)
Set the qualified name of a specific attribute. |
void |
setType(int index,
java.lang.String type)
Set the type of a specific attribute. |
void |
setURI(int index,
java.lang.String uri)
Set the Namespace URI of a specific attribute. |
void |
setValue(int index,
java.lang.String value)
Set the value of a specific attribute. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AttributesImpl()
public AttributesImpl(Attributes atts)
This constructor is especially useful inside a
startElement
event.
atts
- The existing Attributes object.Method Detail |
---|
public int getLength()
getLength
in interface Attributes
Attributes.getLength()
public java.lang.String getURI(int index)
getURI
in interface Attributes
index
- The attribute's index (zero-based).
Attributes.getURI(int)
public java.lang.String getLocalName(int index)
getLocalName
in interface Attributes
index
- The attribute's index (zero-based).
Attributes.getLocalName(int)
public java.lang.String getQName(int index)
getQName
in interface Attributes
index
- The attribute's index (zero-based).
Attributes.getQName(int)
public java.lang.String getType(int index)
getType
in interface Attributes
index
- The attribute's index (zero-based).
Attributes.getType(int)
public java.lang.String getValue(int index)
getValue
in interface Attributes
index
- The attribute's index (zero-based).
Attributes.getValue(int)
public int getIndex(java.lang.String uri, java.lang.String localName)
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.
getIndex
in interface Attributes
uri
- The attribute's Namespace URI, or the empty
string if none is available.localName
- The attribute's local name.
Attributes.getIndex(java.lang.String,java.lang.String)
public int getIndex(java.lang.String qName)
getIndex
in interface Attributes
qName
- The qualified name.
Attributes.getIndex(java.lang.String)
public java.lang.String getType(java.lang.String uri, java.lang.String localName)
getType
in interface Attributes
uri
- The Namespace URI, or the empty string for a name
with no explicit Namespace URI.localName
- The local name.
Attributes.getType(java.lang.String,java.lang.String)
public java.lang.String getType(java.lang.String qName)
getType
in interface Attributes
qName
- The qualified name.
Attributes.getType(java.lang.String)
public java.lang.String getValue(java.lang.String uri, java.lang.String localName)
getValue
in interface Attributes
uri
- The Namespace URI, or the empty string for a name
with no explicit Namespace URI.localName
- The local name.
Attributes.getValue(java.lang.String,java.lang.String)
public java.lang.String getValue(java.lang.String qName)
getValue
in interface Attributes
qName
- The qualified name.
Attributes.getValue(java.lang.String)
public void clear()
Note that little memory is freed by this call: the current array is kept so it can be reused.
public void setAttributes(Attributes atts)
It may be more efficient to reuse an existing object rather than constantly allocating new ones.
atts
- The attributes to copy.public void addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String qName, java.lang.String type, java.lang.String value)
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.
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.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)
For the sake of speed, this method does no checking for name conflicts or well-formedness: such checks are the responsibility of the application.
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.
java.lang.ArrayIndexOutOfBoundsException
- When the
supplied index does not point to an attribute
in the list.public void removeAttribute(int index)
index
- The index of the attribute (zero-based).
java.lang.ArrayIndexOutOfBoundsException
- When the
supplied index does not point to an attribute
in the list.public void setURI(int index, java.lang.String uri)
index
- The index of the attribute (zero-based).uri
- The attribute's Namespace URI, or the empty
string for none.
java.lang.ArrayIndexOutOfBoundsException
- When the
supplied index does not point to an attribute
in the list.public void setLocalName(int index, java.lang.String localName)
index
- The index of the attribute (zero-based).localName
- The attribute's local name, or the empty
string for none.
java.lang.ArrayIndexOutOfBoundsException
- When the
supplied index does not point to an attribute
in the list.public void setQName(int index, java.lang.String qName)
index
- The index of the attribute (zero-based).qName
- The attribute's qualified name, or the empty
string for none.
java.lang.ArrayIndexOutOfBoundsException
- When the
supplied index does not point to an attribute
in the list.public void setType(int index, java.lang.String type)
index
- The index of the attribute (zero-based).type
- The attribute's type.
java.lang.ArrayIndexOutOfBoundsException
- When the
supplied index does not point to an attribute
in the list.public void setValue(int index, java.lang.String value)
index
- The index of the attribute (zero-based).value
- The attribute's value.
java.lang.ArrayIndexOutOfBoundsException
- When the
supplied index does not point to an attribute
in the list.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |