OpenJDK 27 · jdk.internal.util.xml.impl.Attrs · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv String[]	mItems Attributes string array.
private char	mLength Number of attributes in the attributes string array.

Access	Constructor and Description
public	Attrs() Constructor.

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) Implements jdk.internal.org.xml.sax.Attributes.getIndex. 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) Implements jdk.internal.org.xml.sax.Attributes.getIndex. Look up the index of an attribute by XML 1.0 qualified name.
pack-priv int	Returns: The index of the attribute, or -1 if it does not appear in the list. getIndexNullNS(String The Namespace URI, or the empty string if the name has no Namespace URI. `null` value enforce the search by the local name only. uri, String The attribute's local name. localName) Look up the index of an attribute by Namespace name.
public int	Returns: The number of attributes in the list. getLength() Implements jdk.internal.org.xml.sax.Attributes.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) Implements jdk.internal.org.xml.sax.Attributes.getLocalName. Look up an attribute's local name by index.
public String	Returns: The XML 1.0 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) Implements jdk.internal.org.xml.sax.Attributes.getQName. Look up an attribute's XML 1.0 qualified 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) Implements jdk.internal.org.xml.sax.Attributes.getType. 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) Implements jdk.internal.org.xml.sax.Attributes.getType. 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 1.0 qualified name. qName) Implements jdk.internal.org.xml.sax.Attributes.getType. Look up an attribute's type by XML 1.0 qualified 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) Implements jdk.internal.org.xml.sax.Attributes.getURI. 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) Implements jdk.internal.org.xml.sax.Attributes.getValue. 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) Implements jdk.internal.org.xml.sax.Attributes.getValue. 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 1.0 qualified name. qName) Implements jdk.internal.org.xml.sax.Attributes.getValue. Look up an attribute's value by XML 1.0 qualified name.
public boolean	Returns: true if the attribute was declared in the DTD, false otherwise. isDeclared(int The attribute index (zero-based). index) Returns false unless the attribute was declared in the DTD.
public boolean	Returns: true if the attribute was declared in the DTD, false otherwise. isDeclared(String The XML qualified (prefixed) name. qName) Returns false unless the attribute was declared in the DTD.
public boolean	Returns: true if the attribute was declared in the DTD, false otherwise. isDeclared(String The Namespace URI, or the empty string if the name has no Namespace URI. uri, String The attribute's local name. localName) Returns false unless the attribute was declared in the DTD.
public boolean	Returns: true if the value was found in the XML text, false if the value was provided by DTD defaulting. isSpecified(int The attribute index (zero-based). index) Returns true unless the attribute value was provided by DTD defaulting.
public boolean	Returns: true if the value was found in the XML text, false if the value was provided by DTD defaulting. isSpecified(String The Namespace URI, or the empty string if the name has no Namespace URI. uri, String The attribute's local name. localName) Returns true unless the attribute value was provided by DTD defaulting.
public boolean	Returns: true if the value was found in the XML text, false if the value was provided by DTD defaulting. isSpecified(String The XML qualified (prefixed) name. qName) Returns true unless the attribute value was provided by DTD defaulting.
public void	setLength(char The number of attributes in the object. length) Sets up the number of attributes and ensure the capacity of the attribute string array.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

mItems	back to summary
pack-priv String[] mItems Attributes string array. Each individual attribute is represented by four strings: namespace URL(+0), qname(+1), local name(+2), value(+3), type(+4), declared["d"] and default["D"](+5). In order to find attribute by the attribute index, the attribute index MUST be multiplied by 8. The result will point to the attribute namespace URL.

mLength	back to summary
private char mLength Number of attributes in the attributes string array.

Attrs	back to summary
public Attrs() Constructor.

Method Detail

getIndex	back to summary
public int getIndex(String uri, String localName) Implements jdk.internal.org.xml.sax.Attributes.getIndex. 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)

Implements jdk.internal.org.xml.sax.Attributes.getIndex.

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) Implements jdk.internal.org.xml.sax.Attributes.getIndex. Look up the index of an attribute by XML 1.0 qualified 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)

Implements jdk.internal.org.xml.sax.Attributes.getIndex.

Look up the index of an attribute by XML 1.0 qualified 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.

getIndexNullNS back to summary

getIndexNullNS	back to summary
pack-priv int getIndexNullNS(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. `null` value enforce the search by the local name only. localName:String The attribute's local name. Returns:int The index of the attribute, or -1 if it does not appear in the list.

pack-priv int getIndexNullNS(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. null value enforce the search by the local name only.
localName:String: The attribute's local 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() Implements jdk.internal.org.xml.sax.Attributes.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()

Implements jdk.internal.org.xml.sax.Attributes.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) Implements jdk.internal.org.xml.sax.Attributes.getLocalName. 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)

Implements jdk.internal.org.xml.sax.Attributes.getLocalName.

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) Implements jdk.internal.org.xml.sax.Attributes.getQName. Look up an attribute's XML 1.0 qualified name by index. Parameters index:int The attribute index (zero-based). Returns:String The XML 1.0 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)

Implements jdk.internal.org.xml.sax.Attributes.getQName.

Look up an attribute's XML 1.0 qualified name by index.

Parameters

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

Returns:String

The XML 1.0 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) Implements jdk.internal.org.xml.sax.Attributes.getType. 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)

Implements jdk.internal.org.xml.sax.Attributes.getType.

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) Implements jdk.internal.org.xml.sax.Attributes.getType. 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)

Implements jdk.internal.org.xml.sax.Attributes.getType.

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) Implements jdk.internal.org.xml.sax.Attributes.getType. Look up an attribute's type by XML 1.0 qualified name. See `getType(int)` for a description of the possible types. Parameters qName:String The XML 1.0 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)

Implements jdk.internal.org.xml.sax.Attributes.getType.

Look up an attribute's type by XML 1.0 qualified name.

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

Parameters

qName:String: The XML 1.0 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) Implements jdk.internal.org.xml.sax.Attributes.getURI. 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)

Implements jdk.internal.org.xml.sax.Attributes.getURI.

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) Implements jdk.internal.org.xml.sax.Attributes.getValue. 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)

Implements jdk.internal.org.xml.sax.Attributes.getValue.

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) Implements jdk.internal.org.xml.sax.Attributes.getValue. 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)

Implements jdk.internal.org.xml.sax.Attributes.getValue.

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) Implements jdk.internal.org.xml.sax.Attributes.getValue. Look up an attribute's value by XML 1.0 qualified name. See `getValue(int)` for a description of the possible values. Parameters qName:String The XML 1.0 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)

Implements jdk.internal.org.xml.sax.Attributes.getValue.

Look up an attribute's value by XML 1.0 qualified name.

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

Parameters

qName:String: The XML 1.0 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.

isDeclared	back to summary
public boolean isDeclared(int index) Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid). Parameters index:int The attribute index (zero-based). Returns:boolean true if the attribute was declared in the DTD, false otherwise. Exceptions ArrayIndexOutOfBoundsException: When the supplied index does not identify an attribute.

isDeclared

back to summary

public boolean isDeclared(int index)

Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).

Parameters

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

Returns:boolean

true if the attribute was declared in the DTD, false otherwise.

Exceptions

ArrayIndexOutOfBoundsException:: When the supplied index does not identify an attribute.

isDeclared	back to summary
public boolean isDeclared(String qName) Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid). Parameters qName:String The XML qualified (prefixed) name. Returns:boolean true if the attribute was declared in the DTD, false otherwise. Exceptions IllegalArgumentException: When the supplied name does not identify an attribute.

isDeclared

back to summary

public boolean isDeclared(String qName)

Parameters

qName:String: The XML qualified (prefixed) name.

Returns:boolean

true if the attribute was declared in the DTD, false otherwise.

Exceptions

IllegalArgumentException:: When the supplied name does not identify an attribute.

isDeclared	back to summary
public boolean isDeclared(String uri, String localName) Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid). Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD. The declaration will have applied to the attribute's qName. 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:boolean true if the attribute was declared in the DTD, false otherwise. Exceptions IllegalArgumentException: When the supplied names do not identify an attribute.

isDeclared

back to summary

public boolean isDeclared(String uri, String localName)

Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD. The declaration will have applied to the attribute's qName.

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:boolean

true if the attribute was declared in the DTD, false otherwise.

Exceptions

IllegalArgumentException:: When the supplied names do not identify an attribute.

isSpecified	back to summary
public boolean isSpecified(int index) Returns true unless the attribute value was provided by DTD defaulting. Parameters index:int The attribute index (zero-based). Returns:boolean true if the value was found in the XML text, false if the value was provided by DTD defaulting. Exceptions ArrayIndexOutOfBoundsException: When the supplied index does not identify an attribute.

isSpecified

back to summary

public boolean isSpecified(int index)

Returns true unless the attribute value was provided by DTD defaulting.

Parameters

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

Returns:boolean

true if the value was found in the XML text, false if the value was provided by DTD defaulting.

Exceptions

ArrayIndexOutOfBoundsException:: When the supplied index does not identify an attribute.

isSpecified	back to summary
public boolean isSpecified(String uri, String localName) Returns true unless the attribute value was provided by DTD defaulting. Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD. The declaration will have applied to the attribute's qName. 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:boolean true if the value was found in the XML text, false if the value was provided by DTD defaulting. Exceptions IllegalArgumentException: When the supplied names do not identify an attribute.

isSpecified

back to summary

public boolean isSpecified(String uri, String localName)

Returns true unless the attribute value was provided by DTD defaulting.

Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD. The declaration will have applied to the attribute's qName.

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:boolean

true if the value was found in the XML text, false if the value was provided by DTD defaulting.

Exceptions

IllegalArgumentException:: When the supplied names do not identify an attribute.

isSpecified	back to summary
public boolean isSpecified(String qName) Returns true unless the attribute value was provided by DTD defaulting. Parameters qName:String The XML qualified (prefixed) name. Returns:boolean true if the value was found in the XML text, false if the value was provided by DTD defaulting. Exceptions IllegalArgumentException: When the supplied name does not identify an attribute.

isSpecified

back to summary

public boolean isSpecified(String qName)

Returns true unless the attribute value was provided by DTD defaulting.

Parameters

qName:String: The XML qualified (prefixed) name.

Returns:boolean

true if the value was found in the XML text, false if the value was provided by DTD defaulting.

Exceptions

IllegalArgumentException:: When the supplied name does not identify an attribute.

setLength	back to summary
public void setLength(char length) Sets up the number of attributes and ensure the capacity of the attribute string array. Parameters length:char The number of attributes in the object.

setLength

back to summary

public void setLength(char length)

Sets up the number of attributes and ensure the capacity of the attribute string array.

Parameters

length:char: The number of attributes in the object.

public Class Attrs

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail