org.xml.sax
Interface Attributes
All Known Direct Subinterfaces:
Attributes2
public interface Attributes
Interface for a list of XML attributes.
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 interface allows access to a list of attributes in
three different ways:
- by attribute index;
- by Namespace-qualified name; or
- by qualified (prefixed) name.
The list will not contain attributes that were declared
#IMPLIED but not specified in the start tag. It will also not
contain attributes used as Namespace declarations (xmlns*) unless
the
http://xml.org/sax/features/namespace-prefixes
feature is set to
true (it is
false by
default).
Because SAX2 conforms to the "Namespaces in XML" specification,
it does not give namespace declaration attributes a namespace URI.
Some other W3C specifications are in conflict with that, expecting
these declarations to be in a namespace.
Handler code may need to resolve that conflict.
If the namespace-prefixes feature (see above) is
false,
access by qualified name may not be available; if the
http://xml.org/sax/features/namespaces
feature is
false, access by Namespace-qualified names
may not be available.
This interface replaces the now-deprecated SAX1 org.xml.sax.AttributeList AttributeList interface, which does not
contain Namespace support. In addition to Namespace support, it
adds the
getIndex methods (below).
The order of attributes in the list is unspecified, and will
vary from implementation to implementation.
- SAX 2.0
- David Megginson
org.xml.sax.helpers.AttributesImpl
org.xml.sax.ext.DeclHandler.attributeDecl
int | getIndex(java.lang.String uri, java.lang.String localName) |
int | getIndex(java.lang.String qName) |
int | getLength() |
java.lang.String | getLocalName(int index) |
java.lang.String | getQName(int index) |
java.lang.String | getType(int index) |
java.lang.String | getType(java.lang.String uri, java.lang.String localName) |
java.lang.String | getType(java.lang.String qName) |
java.lang.String | getURI(int index) |
java.lang.String | getValue(int index) |
java.lang.String | getValue(java.lang.String uri, java.lang.String localName) |
java.lang.String | getValue(java.lang.String qName) |
getIndex
public int getIndex(java.lang.String uri, java.lang.String localName)
Look up the index of an attribute by Namespace name.
- uri - The Namespace URI, or the empty string if
the name has no Namespace URI.
- localName - The attribute's local name.
- The index of the attribute, or -1 if it does not
appear in the list.
getIndex
public int getIndex(java.lang.String qName)
Look up the index of an attribute by XML 1.0 qualified name.
- qName - The qualified (prefixed) name.
- The index of the attribute, or -1 if it does not
appear in the list.
getLength
public int getLength()
Return the number of attributes in the list.
Once you know the number of attributes, you can iterate
through the list.
- The number of attributes in the list.
getURI(int)
getLocalName(int)
getQName(int)
getType(int)
getValue(int)
getLocalName
public String getLocalName(int index)
Look up an attribute's local name by index.
- index - The attribute index (zero-based).
- The local name, or the empty string if Namespace
processing is not being performed, or null
if the index is out of range.
getLength
getQName
public String getQName(int index)
Look up an attribute's XML 1.0 qualified name by index.
- index - The attribute index (zero-based).
- The XML 1.0 qualified name, or the empty string
if none is available, or null if the index
is out of range.
getLength
getType
public String getType(int index)
Look up an attribute's type by index.
The attribute type is one of the strings "CDATA", "ID",
"IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES",
or "NOTATION" (always in upper case).
If the parser has not read a declaration for the attribute,
or if the parser does not report attribute types, then it must
return the value "CDATA" as stated in the XML 1.0 Recommentation
(clause 3.3.3, "Attribute-Value Normalization").
For an enumerated attribute that is not a notation, the
parser will report the type as "NMTOKEN".
- index - The attribute index (zero-based).
- The attribute's type as a string, or null if the
index is out of range.
getLength
getType
public String getType(java.lang.String uri, java.lang.String localName)
- uri - The Namespace URI, or the empty String if the
name has no Namespace URI.
- localName - The local name of the attribute.
- The attribute type as a string, or null if the
attribute is not in the list or if Namespace
processing is not being performed.
getType
public String getType(java.lang.String qName)
Look up an attribute's type by XML 1.0 qualified name.
See
getType(int) getType(int) for a description
of the possible types.
- qName - The XML 1.0 qualified name.
- The attribute type as a string, or null if the
attribute is not in the list or if qualified names
are not available.
getURI
public String getURI(int index)
Look up an attribute's Namespace URI by index.
- index - The attribute index (zero-based).
- The Namespace URI, or the empty string if none
is available, or null if the index is out of
range.
getLength
getValue
public String getValue(int index)
Look up an attribute's value by index.
If the attribute value is a list of tokens (IDREFS,
ENTITIES, or NMTOKENS), the tokens will be concatenated
into a single string with each token separated by a
single space.
- index - The attribute index (zero-based).
- The attribute's value as a string, or null if the
index is out of range.
getLength
getValue
public String getValue(java.lang.String uri, java.lang.String localName)
- uri - The Namespace URI, or the empty String if the
name has no Namespace URI.
- localName - The local name of the attribute.
- The attribute value as a string, or null if the
attribute is not in the list.
getValue
public String getValue(java.lang.String qName)
- qName - The XML 1.0 qualified name.
- The attribute value as a string, or null if the
attribute is not in the list or if qualified names
are not available.
- by attribute index;
- by Namespace-qualified name; or
- by qualified (prefixed) name.
The list will not contain attributes that were declared #IMPLIED but not specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless thehttp://xml.org/sax/features/namespace-prefixes
feature is set to true (it is false by default). Because SAX2 conforms to the "Namespaces in XML" specification, it does not give namespace declaration attributes a namespace URI. Some other W3C specifications are in conflict with that, expecting these declarations to be in a namespace. Handler code may need to resolve that conflict. If the namespace-prefixes feature (see above) is false, access by qualified name may not be available; if thehttp://xml.org/sax/features/namespaces
feature is false, access by Namespace-qualified names may not be available. This interface replaces the now-deprecated SAX1 org.xml.sax.AttributeList AttributeList interface, which does not contain Namespace support. In addition to Namespace support, it adds the getIndex methods (below). The order of attributes in the list is unspecified, and will vary from implementation to implementation.