Attributes
Attributes2Impl
public class AttributesImpl extends Object implements Attributes
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 | Description |
---|---|
AttributesImpl() |
Construct a new, empty AttributesImpl object. |
AttributesImpl |
Copy an existing Attributes object. |
Modifier and Type | Method | Description |
---|---|---|
void |
addAttribute |
Add an attribute to the end of the list. |
void |
clear() |
Clear the attribute list for reuse. |
int |
getIndex |
Look up an attribute's index by qualified (prefixed) name. |
int |
getIndex |
Look up an attribute's index by Namespace name. |
int |
getLength() |
Return the number of attributes in the list. |
String |
getLocalName |
Return an attribute's local name. |
String |
getQName |
Return an attribute's qualified (prefixed) name. |
String |
getType |
Return an attribute's type by index. |
String |
getType |
Look up an attribute's type by qualified (prefixed) name. |
String |
getType |
Look up an attribute's type by Namespace-qualified name. |
String |
getURI |
Return an attribute's Namespace URI. |
String |
getValue |
Return an attribute's value by index. |
String |
getValue |
Look up an attribute's value by qualified (prefixed) name. |
String |
getValue |
Look up an attribute's value by Namespace-qualified name. |
void |
removeAttribute |
Remove an attribute from the list. |
void |
setAttribute |
Set an attribute in the list. |
void |
setAttributes |
Copy an entire Attributes object. |
void |
setLocalName |
Set the local name of a specific attribute. |
void |
setQName |
Set the qualified name of a specific attribute. |
void |
setType |
Set the type of a specific attribute. |
void |
setURI |
Set the Namespace URI of a specific attribute. |
void |
setValue |
Set the value of a specific attribute. |
public AttributesImpl()
public AttributesImpl(Attributes atts)
This constructor is especially useful inside a startElement
event.
atts
- The existing Attributes object.public int getLength()
getLength
in interface Attributes
public String getURI(int index)
getURI
in interface Attributes
index
- The attribute's index (zero-based).public String getLocalName(int index)
getLocalName
in interface Attributes
index
- The attribute's index (zero-based).public String getQName(int index)
getQName
in interface Attributes
index
- The attribute's index (zero-based).public String getType(int index)
getType
in interface Attributes
index
- The attribute's index (zero-based).public String getValue(int index)
getValue
in interface Attributes
index
- The attribute's index (zero-based).public int getIndex(String uri, 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.public int getIndex(String qName)
getIndex
in interface Attributes
qName
- The qualified name.public String getType(String uri, 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.public String getType(String qName)
getType
in interface Attributes
qName
- The qualified name.public String getValue(String uri, 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.public String getValue(String qName)
getValue
in interface Attributes
qName
- The qualified name.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(String uri, String localName, String qName, String type, 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, String uri, String localName, String qName, String type, 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.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).ArrayIndexOutOfBoundsException
- When the supplied index does not point to an attribute in the list.public void setURI(int index, String uri)
index
- The index of the attribute (zero-based).uri
- The attribute's Namespace URI, or the empty string for none.ArrayIndexOutOfBoundsException
- When the supplied index does not point to an attribute in the list.public void setLocalName(int index, String localName)
index
- The index of the attribute (zero-based).localName
- The attribute's local name, or the empty string for none.ArrayIndexOutOfBoundsException
- When the supplied index does not point to an attribute in the list.public void setQName(int index, String qName)
index
- The index of the attribute (zero-based).qName
- The attribute's qualified name, or the empty string for none.ArrayIndexOutOfBoundsException
- When the supplied index does not point to an attribute in the list.public void setType(int index, String type)
index
- The index of the attribute (zero-based).type
- The attribute's type.ArrayIndexOutOfBoundsException
- When the supplied index does not point to an attribute in the list.public void setValue(int index, String value)
index
- The index of the attribute (zero-based).value
- The attribute's value.ArrayIndexOutOfBoundsException
- When the supplied index does not point to an attribute in the list.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/org/xml/sax/helpers/AttributesImpl.html