OpenJDK 1.23 · org.xml.sax.Attributes · APIdia, the JavaDoc alternative

Interface for a list of XML attributes.

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 original "Namespaces in XML" recommendation, it normally does not give namespace declaration attributes a namespace URI.

Some SAX2 parsers may support using an optional feature flag (http://xml.org/sax/features/xmlns-uris) to request that those attributes be given URIs, conforming to a later backwards-incompatible revision of that recommendation. (The attribute's "local name" will be the prefix, or "xmlns" when defining a default element namespace.) For portability, handler code should always resolve that conflict, rather than requiring parsers that can change the setting of that feature flag.

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

Method Summary

Modifier and Type	Method and Description
public int	Returns: The index of the attribute, or -1 if it does not appear in the list. getIndex(String The Namespace URI, or the empty string if the name has no Namespace URI. uri, String The attribute's local name. localName) Look up the index of an attribute by Namespace name.
public int	Returns: The index of the attribute, or -1 if it does not appear in the list. getIndex(String The qualified (prefixed) name. qName) Look up the index of an attribute by XML qualified (prefixed) name.
public int	Returns: The number of attributes in the list. getLength() Return the number of attributes in the list.
public String	Returns: The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range. getLocalName(int The attribute index (zero-based). index) Look up an attribute's local name by index.
public String	Returns: The XML qualified name, or the empty string if none is available, or null if the index is out of range. getQName(int The attribute index (zero-based). index) Look up an attribute's XML qualified (prefixed) name by index.
public String	Returns: The attribute's type as a string, or null if the index is out of range. getType(int The attribute index (zero-based). index) Look up an attribute's type by index.
public String	Returns: 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(String The Namespace URI, or the empty String if the name has no Namespace URI. uri, String The local name of the attribute. localName) Look up an attribute's type by Namespace name.
public String	Returns: The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available. getType(String The XML qualified name. qName) Look up an attribute's type by XML qualified (prefixed) name.
public String	Returns: The Namespace URI, or the empty string if none is available, or null if the index is out of range. getURI(int The attribute index (zero-based). index) Look up an attribute's Namespace URI by index.
public String	Returns: The attribute's value as a string, or null if the index is out of range. getValue(int The attribute index (zero-based). index) Look up an attribute's value by index.
public String	Returns: The attribute value as a string, or null if the attribute is not in the list. getValue(String The Namespace URI, or the empty String if the name has no Namespace URI. uri, String The local name of the attribute. localName) Look up an attribute's value by Namespace name.
public String	Returns: The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available. getValue(String The XML qualified name. qName) Look up an attribute's value by XML qualified (prefixed) name.

Method Detail

getIndex	back to summary
public int getIndex(String uri, String localName) Look up the index of an attribute by Namespace name. Parameters uri:String The Namespace URI, or the empty string if the name has no Namespace URI. localName:String The attribute's local name. Returns:int The index of the attribute, or -1 if it does not appear in the list.

getIndex

back to summary

public int getIndex(String uri, String localName)

Look up the index of an attribute by Namespace name.

Parameters

uri:String: The Namespace URI, or the empty string if the name has no Namespace URI.
localName:String: The attribute's local name.

Returns:int

The index of the attribute, or -1 if it does not appear in the list.

getIndex	back to summary
public int getIndex(String qName) Look up the index of an attribute by XML qualified (prefixed) name. Parameters qName:String The qualified (prefixed) name. Returns:int The index of the attribute, or -1 if it does not appear in the list.

getIndex

back to summary

public int getIndex(String qName)

Look up the index of an attribute by XML qualified (prefixed) name.

Parameters

qName:String: The qualified (prefixed) name.

Returns:int

The index of the attribute, or -1 if it does not appear in the list.

getLength back to summary

getLength	back to summary
public int getLength() Return the number of attributes in the list. Once you know the number of attributes, you can iterate through the list. Returns:int The number of attributes in the list. See Also `getURI(int)`, `getLocalName(int)`, `getQName(int)`, `getType(int)`, `getValue(int)`

public int getLength()

Return the number of attributes in the list.

Once you know the number of attributes, you can iterate through the list.

Returns:int: The number of attributes in the list.
See Also: getURI(int), getLocalName(int), getQName(int), getType(int), getValue(int)

getLocalName back to summary

getLocalName	back to summary
public String getLocalName(int index) Look up an attribute's local name by index. Parameters index:int The attribute index (zero-based). Returns:String The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range. See Also `getLength`

public String getLocalName(int index)

Look up an attribute's local name by index.

Parameters

index:int: The attribute index (zero-based).

Returns:String

The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.

See Also

getLength

getQName back to summary

getQName	back to summary
public String getQName(int index) Look up an attribute's XML qualified (prefixed) name by index. Parameters index:int The attribute index (zero-based). Returns:String The XML qualified name, or the empty string if none is available, or null if the index is out of range. See Also `getLength`

public String getQName(int index)

Look up an attribute's XML qualified (prefixed) name by index.

Parameters

index:int: The attribute index (zero-based).

Returns:String

The XML qualified name, or the empty string if none is available, or null if the index is out of range.

See Also

getLength

getType back to summary

getType	back to summary
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 Recommendation (clause 3.3.3, "Attribute-Value Normalization"). For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN". Parameters index:int The attribute index (zero-based). Returns:String The attribute's type as a string, or null if the index is out of range. See Also `getLength`

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 Recommendation (clause 3.3.3, "Attribute-Value Normalization").

For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".

Parameters

index:int: The attribute index (zero-based).

Returns:String

The attribute's type as a string, or null if the index is out of range.

See Also

getLength

getType back to summary

getType	back to summary
public String getType(String uri, String localName) Look up an attribute's type by Namespace name. See `getType(int)` for a description of the possible types. Parameters uri:String The Namespace URI, or the empty String if the name has no Namespace URI. localName:String The local name of the attribute. Returns:String The attribute type as a string, or null if the attribute is not in the list or if Namespace processing is not being performed.

public String getType(String uri, String localName)

Look up an attribute's type by Namespace name.

See getType(int) for a description of the possible types.

Parameters

uri:String: The Namespace URI, or the empty String if the name has no Namespace URI.
localName:String: The local name of the attribute.

Returns:String

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 back to summary

getType	back to summary
public String getType(String qName) Look up an attribute's type by XML qualified (prefixed) name. See `getType(int)` for a description of the possible types. Parameters qName:String The XML qualified name. Returns:String The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.

public String getType(String qName)

Look up an attribute's type by XML qualified (prefixed) name.

See getType(int) for a description of the possible types.

Parameters

qName:String: The XML qualified name.

Returns:String

The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.

getURI back to summary

getURI	back to summary
public String getURI(int index) Look up an attribute's Namespace URI by index. Parameters index:int The attribute index (zero-based). Returns:String The Namespace URI, or the empty string if none is available, or null if the index is out of range. See Also `getLength`

public String getURI(int index)

Look up an attribute's Namespace URI by index.

Parameters

index:int: The attribute index (zero-based).

Returns:String

The Namespace URI, or the empty string if none is available, or null if the index is out of range.

See Also

getLength

getValue back to summary

getValue	back to summary
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. Parameters index:int The attribute index (zero-based). Returns:String The attribute's value as a string, or null if the index is out of range. See Also `getLength`

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.

Parameters

index:int: The attribute index (zero-based).

Returns:String

The attribute's value as a string, or null if the index is out of range.

See Also

getLength

getValue back to summary

getValue	back to summary
public String getValue(String uri, String localName) Look up an attribute's value by Namespace name. See `getValue(int)` for a description of the possible values. Parameters uri:String The Namespace URI, or the empty String if the name has no Namespace URI. localName:String The local name of the attribute. Returns:String The attribute value as a string, or null if the attribute is not in the list.

public String getValue(String uri, String localName)

Look up an attribute's value by Namespace name.

See getValue(int) for a description of the possible values.

Parameters

uri:String: The Namespace URI, or the empty String if the name has no Namespace URI.
localName:String: The local name of the attribute.

Returns:String

The attribute value as a string, or null if the attribute is not in the list.

getValue back to summary

getValue	back to summary
public String getValue(String qName) Look up an attribute's value by XML qualified (prefixed) name. See `getValue(int)` for a description of the possible values. Parameters qName:String The XML qualified name. Returns:String The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.

public String getValue(String qName)

Look up an attribute's value by XML qualified (prefixed) name.

See getValue(int) for a description of the possible values.

Parameters

qName:String: The XML qualified name.

Returns:String

The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.

public Interface Attributes

Method Summary

Method Detail