OpenJDK 27 · com.sun.org.apache.xerces.internal.xni.XMLAttributes

Method Summary

Modifier and Type	Method and Description
public int	Returns: Returns the attribute index. addAttribute(QName The attribute name. attrName, String The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('\|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true\|false)". attrType, String The attribute value. attrValue) Adds an attribute.
public Augmentations	Returns: Augmentations getAugmentations(int The attribute index. attributeIndex) Look up an augmentation by attribute's index.
public Augmentations	Returns: Augmentations getAugmentations(String The Namespace URI, or the empty string if the name has no Namespace URI. uri, String localPart) Look up an augmentation by namespace name.
public Augmentations	Returns: Augmentations getAugmentations(String The XML 1.0 qualified name. qName) Look up an augmentation by XML 1.0 qualified 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 1.0 qualified name.
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 localPart) Look up the index of an attribute by Namespace name.
public int	getLength() Returns 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 void	getName(int The attribute index. attrIndex, QName The attribute name structure to fill in. attrName) Sets the fields in the given QName structure with the values of the attribute name at the specified index.
public String	getNonNormalizedValue(int The attribute index. attrIndex) Returns the non-normalized value of the attribute at the specified index.
public String	getPrefix(int The index of the attribute. index) Returns the prefix of the attribute at the specified 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) Look up an attribute's XML 1.0 qualified name by index.
public QName	getQualifiedName(int 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 qualified names are not available. getType(String The XML 1.0 qualified name. qName) Look up an attribute's type by XML 1.0 qualified name.
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 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 or if qualified names are not available. getValue(String The XML 1.0 qualified name. qName) Look up an attribute's value by XML 1.0 qualified name.
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 boolean	isSpecified(int The attribute index. attrIndex) Returns true if the attribute is specified in the instance document.
public void	removeAllAttributes() Removes all of the attributes.
public void	removeAttributeAt(int The attribute index. attrIndex) Removes the attribute at the specified index.
public void	setAugmentations(int The attribute index. attrIndex, Augmentations The augmentations. augs) Sets the augmentations of the attribute at the specified index.
public void	setName(int The attribute index. attrIndex, QName The new attribute name. attrName) Sets the name of the attribute at the specified index.
public void	setNonNormalizedValue(int The attribute index. attrIndex, String The new non-normalized attribute value. attrValue) Sets the non-normalized value of the attribute at the specified index.
public void	setSpecified(int The attribute index. attrIndex, boolean True if the attribute is specified in the instance document. specified) Sets whether an attribute is specified in the instance document or not.
public void	setType(int The attribute index. attrIndex, String The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('\|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true\|false)". attrType) Sets the type of the attribute at the specified index.
public void	setValue(int The attribute index. attrIndex, String The new attribute value. attrValue) Sets the value of the attribute at the specified index.
public void	setValue(int attrIndex, String attrValue, XMLString value)

Method Detail

addAttribute back to summary

addAttribute	back to summary
public int addAttribute(QName attrName, String attrType, String attrValue) Adds an attribute. The attribute's non-normalized value of the attribute will have the same value as the attribute value until set using the `setNonNormalizedValue` method. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using the `setSpecified` method. Note If an attribute of the same name already exists, the old values for the attribute are replaced by the new values. Parameters attrName:QName The attribute name. attrType:String The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('\|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true\|false)". attrValue:String The attribute value. Returns:int Returns the attribute index. See Also `setNonNormalizedValue`, `setSpecified`

public int addAttribute(QName attrName, String attrType, String attrValue)

Adds an attribute. The attribute's non-normalized value of the attribute will have the same value as the attribute value until set using the setNonNormalizedValue method. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using the setSpecified method.

Note

If an attribute of the same name already exists, the old values for the attribute are replaced by the new values.

Parameters

attrName:QName: The attribute name.
attrType:String: The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true|false)".
attrValue:String: The attribute value.

Returns:int

Returns the attribute index.

See Also

setNonNormalizedValue, setSpecified

getAugmentations	back to summary
public Augmentations getAugmentations(int attributeIndex) Look up an augmentation by attribute's index. Parameters attributeIndex:int The attribute index. Returns:Augmentations Augmentations

getAugmentations

back to summary

public Augmentations getAugmentations(int attributeIndex)

Look up an augmentation by attribute's index.

Parameters

attributeIndex:int: The attribute index.

Returns:Augmentations

Augmentations

getAugmentations	back to summary
public Augmentations getAugmentations(String uri, String localPart) Look up an augmentation by namespace name. Parameters uri:String The Namespace URI, or the empty string if the name has no Namespace URI. Returns:Augmentations Augmentations

getAugmentations

back to summary

public Augmentations getAugmentations(String uri, String localPart)

Look up an augmentation by namespace name.

Parameters

uri:String: The Namespace URI, or the empty string if the name has no Namespace URI.

Returns:Augmentations

Augmentations

getAugmentations	back to summary
public Augmentations getAugmentations(String qName) Look up an augmentation by XML 1.0 qualified name. Parameters qName:String The XML 1.0 qualified name. Returns:Augmentations Augmentations

getAugmentations

back to summary

public Augmentations getAugmentations(String qName)

Look up an augmentation by XML 1.0 qualified name.

Parameters

qName:String: The XML 1.0 qualified name.

Returns:Augmentations

Augmentations

getIndex	back to summary
public int getIndex(String qName) 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)

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 uri, String localPart) 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. 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 localPart)

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.

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() Returns the number of attributes in the list. Once you know the number of attributes, you can iterate through the list. See Also `getURI(int)`, `getLocalName(int)`, `getQName(int)`, `getType(int)`, `getValue(int)`

public int getLength()

Returns the number of attributes in the list.

Once you know the number of attributes, you can iterate through 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

getName	back to summary
public void getName(int attrIndex, QName attrName) Sets the fields in the given QName structure with the values of the attribute name at the specified index. Parameters attrIndex:int The attribute index. attrName:QName The attribute name structure to fill in.

getName

back to summary

public void getName(int attrIndex, QName attrName)

Sets the fields in the given QName structure with the values of the attribute name at the specified index.

Parameters

attrIndex:int: The attribute index.
attrName:QName: The attribute name structure to fill in.

getNonNormalizedValue back to summary

getNonNormalizedValue	back to summary
public String getNonNormalizedValue(int attrIndex) Returns the non-normalized value of the attribute at the specified index. If no non-normalized value is set, this method will return the same value as the `getValue(int)` method. Parameters attrIndex:int The attribute index.

public String getNonNormalizedValue(int attrIndex)

Returns the non-normalized value of the attribute at the specified index. If no non-normalized value is set, this method will return the same value as the getValue(int) method.

Parameters

attrIndex:int: The attribute index.

getPrefix	back to summary
public String getPrefix(int index) Returns the prefix of the attribute at the specified index. Parameters index:int The index of the attribute.

getPrefix

back to summary

public String getPrefix(int index)

Returns the prefix of the attribute at the specified index.

Parameters

index:int: The index of the attribute.

getQName back to summary

getQName	back to summary
public String getQName(int index) 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)

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

getQualifiedName	back to summary
public QName getQualifiedName(int index)

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

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 qName) 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)

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.

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.

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 qName) 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)

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.

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.

isSpecified	back to summary
public boolean isSpecified(int attrIndex) Returns true if the attribute is specified in the instance document. Parameters attrIndex:int The attribute index.

isSpecified

back to summary

public boolean isSpecified(int attrIndex)

Returns true if the attribute is specified in the instance document.

Parameters

attrIndex:int: The attribute index.

removeAllAttributes	back to summary
public void removeAllAttributes() Removes all of the attributes. This method will also remove all entities associated to the attributes.

removeAttributeAt	back to summary
public void removeAttributeAt(int attrIndex) Removes the attribute at the specified index. Note This operation changes the indexes of all attributes following the attribute at the specified index. Parameters attrIndex:int The attribute index.

removeAttributeAt

back to summary

public void removeAttributeAt(int attrIndex)

Removes the attribute at the specified index.

Note

This operation changes the indexes of all attributes following the attribute at the specified index.

Parameters

attrIndex:int: The attribute index.

setAugmentations	back to summary
public void setAugmentations(int attrIndex, Augmentations augs) Sets the augmentations of the attribute at the specified index. Parameters attrIndex:int The attribute index. augs:Augmentations The augmentations.

setAugmentations

back to summary

public void setAugmentations(int attrIndex, Augmentations augs)

Sets the augmentations of the attribute at the specified index.

Parameters

attrIndex:int: The attribute index.
augs:Augmentations: The augmentations.

setName	back to summary
public void setName(int attrIndex, QName attrName) Sets the name of the attribute at the specified index. Parameters attrIndex:int The attribute index. attrName:QName The new attribute name.

setName

back to summary

public void setName(int attrIndex, QName attrName)

Sets the name of the attribute at the specified index.

Parameters

attrIndex:int: The attribute index.
attrName:QName: The new attribute name.

setNonNormalizedValue	back to summary
public void setNonNormalizedValue(int attrIndex, String attrValue) Sets the non-normalized value of the attribute at the specified index. Parameters attrIndex:int The attribute index. attrValue:String The new non-normalized attribute value.

setNonNormalizedValue

back to summary

public void setNonNormalizedValue(int attrIndex, String attrValue)

Sets the non-normalized value of the attribute at the specified index.

Parameters

attrIndex:int: The attribute index.
attrValue:String: The new non-normalized attribute value.

setSpecified	back to summary
public void setSpecified(int attrIndex, boolean specified) Sets whether an attribute is specified in the instance document or not. Parameters attrIndex:int The attribute index. specified:boolean True if the attribute is specified in the instance document.

setSpecified

back to summary

public void setSpecified(int attrIndex, boolean specified)

Sets whether an attribute is specified in the instance document or not.

Parameters

attrIndex:int: The attribute index.
specified:boolean: True if the attribute is specified in the instance document.

setType	back to summary
public void setType(int attrIndex, String attrType) Sets the type of the attribute at the specified index. Parameters attrIndex:int The attribute index. attrType:String The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('\|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true\|false)".

setType

back to summary

public void setType(int attrIndex, String attrType)

Sets the type of the attribute at the specified index.

Parameters

attrIndex:int: The attribute index.
attrType:String: The attribute type. The type name is determined by the type specified for this attribute in the DTD. For example: "CDATA", "ID", "NMTOKEN", etc. However, attributes of type enumeration will have the type value specified as the pipe ('|') separated list of the enumeration values prefixed by an open parenthesis and suffixed by a close parenthesis. For example: "(true|false)".

setValue back to summary

setValue	back to summary
public void setValue(int attrIndex, String attrValue) Sets the value of the attribute at the specified index. This method will overwrite the non-normalized value of the attribute. Parameters attrIndex:int The attribute index. attrValue:String The new attribute value. See Also `setNonNormalizedValue`

public void setValue(int attrIndex, String attrValue)

Sets the value of the attribute at the specified index. This method will overwrite the non-normalized value of the attribute.

Parameters

attrIndex:int: The attribute index.
attrValue:String: The new attribute value.

See Also

setNonNormalizedValue

setValue	back to summary
public void setValue(int attrIndex, String attrValue, XMLString value)

public Interface XMLAttributes

Method Summary

Method Detail