org.xml.sax.helpers.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:
- to take a persistent snapshot of an Attributes object
in a startElement event; or
- 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.
Known Direct Subclasses
Summary
Public Constructors
Public Methods
|
|
|
|
|
void |
addAttribute(String uri, String localName, String qName, String type, String value) |
|
|
|
|
|
void |
clear() |
|
|
|
|
|
int |
getIndex(String qName) |
|
|
|
|
|
int |
getIndex(String uri, String localName) |
|
|
|
|
|
int |
getLength() |
|
|
|
|
|
String |
getLocalName(int index) |
|
|
|
|
|
String |
getQName(int index) |
|
|
|
|
|
String |
getType(int index) |
|
|
|
|
|
String |
getType(String uri, String localName) |
|
|
|
|
|
String |
getType(String qName) |
|
|
|
|
|
String |
getURI(int index) |
|
|
|
|
|
String |
getValue(int index) |
|
|
|
|
|
String |
getValue(String qName) |
|
|
|
|
|
String |
getValue(String uri, String localName) |
|
|
|
|
|
void |
removeAttribute(int index) |
|
|
|
|
|
void |
setAttribute(int index, String uri, String localName, String qName, String type, String value) |
|
|
|
|
|
void |
setAttributes(Attributes atts) |
|
|
|
|
|
void |
setLocalName(int index, String localName) |
|
|
|
|
|
void |
setQName(int index, String qName) |
|
|
|
|
|
void |
setType(int index, String type) |
|
|
|
|
|
void |
setURI(int index, String uri) |
|
|
|
|
|
void |
setValue(int index, String value) |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
getIndex,
getIndex,
getLength,
getLocalName,
getQName,
getType,
getType,
getType,
getURI,
getValue,
getValue,
getValue
Details
Public Constructors
public
AttributesImpl()
Construct a new, empty AttributesImpl object.
public
AttributesImpl(Attributes atts)
Copy an existing Attributes object.
This constructor is especially useful inside a
startElement event.
Parameters
atts
| The existing Attributes object.
|
Public Methods
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.
|
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.
public
int
getIndex(String qName)
Look up an attribute's index by qualified (prefixed) name.
Parameters
qName
| The qualified name. |
Returns
- The attribute's index, or -1 if none matches.
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.
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.
public
int
getLength()
Return the number of attributes in the list.
Returns
- The number of attributes in the list.
public
String
getLocalName(int index)
Return an attribute's local name.
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.
public
String
getQName(int index)
Return an attribute's qualified (prefixed) name.
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.
public
String
getType(int index)
Return an attribute's type by index.
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.
Look up an attribute's type by Namespace-qualified name.
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.
Look up an attribute's type by qualified (prefixed) name.
Parameters
qName
| The qualified name. |
Returns
- The attribute's type, or null if there is no
matching attribute.
public
String
getURI(int index)
Return an attribute's Namespace URI.
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.
public
String
getValue(int index)
Return an attribute's value by index.
Parameters
index
| The attribute's index (zero-based). |
Returns
- The attribute's value or null if the index is out of bounds.
Look up an attribute's value by qualified (prefixed) name.
Parameters
qName
| The qualified name. |
Returns
- The attribute's value, or null if there is no
matching attribute.
Look up an attribute's value by Namespace-qualified name.
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.
public
void
removeAttribute(int index)
Remove an attribute from the list.
Parameters
index
| The index of the attribute (zero-based). |
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. |
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.
|
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. |
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. |
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. |
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. |
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. |