Class XMLAttributesImpl
- All Implemented Interfaces:
XMLAttributes
The attributes are read-write so that subsequent stages in the document pipeline can modify the values or change the attributes that are propogated to the next stage.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
Attribute information.(package private) static class
Attribute information. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ArrayList
<XMLAttributesImpl.Attribute> Attribute information. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
addAttribute
(QName name, String type, String value) Adds an attribute.void
addAttribute
(QName name, String type, String value, boolean specified) Adds an attribute.void
addAttribute
(QName name, String type, String value, String nonNormalizedValue, boolean specified) int
Look up the index of an attribute by XML 1.0 qualified name.int
Look up the index of an attribute by Namespace name.int
Return the number of attributes in the list.getLocalName
(int index) Look up an attribute's local name by index.getName
(int index) Returns the full QName of the name of this attribute.void
Sets the fields in the given QName structure with the values of the attribute name at the specified index.getNameRawName
(int index) Return the name of an attribute in this list (by position).getNonNormalizedValue
(int index) getQName
(int index) Look up an attribute's XML 1.0 qualified name by index.private static String
getReportableType
(String type) Returns the value passed in or NMTOKEN if it's an enumerated type.getType
(int index) Look up an attribute's type by index.Look up an attribute's type by XML 1.0 qualified name.Look up an attribute's type by Namespace name.getURI
(int index) Look up an attribute's Namespace URI by index.getValue
(int index) Look up an attribute's value by index.Look up an attribute's value by XML 1.0 qualified name.Look up an attribute's value by Namespace name.boolean
isSpecified
(int attrIndex) Returns true if the attribute is specified in the instance document.void
Removes all of the attributes.void
removeAttributeAt
(int attrIndex) Removes the attribute at the specified index.void
Sets the name of the attribute at the specified index.void
setSpecified
(int attrIndex, boolean specified) Sets whether an attribute is specified in the instance document or not.void
Sets the type of the attribute at the specified index.void
Sets the value of the attribute at the specified index.
-
Field Details
-
attributes_
Attribute information.
-
-
Constructor Details
-
XMLAttributesImpl
public XMLAttributesImpl()Default constructor.
-
-
Method Details
-
addAttribute
Adds an attribute. The attribute's non-normalized value of the attribute will have the same value as the attribute value. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using thesetSpecified
method.Note: If an attribute of the same name already exists, the old values for the attribute are replaced by the new values.
- Specified by:
addAttribute
in interfaceXMLAttributes
- Parameters:
name
- The attribute name.type
- 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)".value
- The attribute value.- Returns:
- Returns the attribute index.
- See Also:
-
addAttribute
Adds an attribute. The attribute's non-normalized value of the attribute will have the same value as the attribute value. Also, the added attribute will be marked as specified in the XML instance document unless set otherwise using thesetSpecified
method.This method differs from
addAttribute
in that it does not check if an attribute of the same name already exists in the list before adding it. In order to improve performance of namespace processing, this method allows uniqueness checks to be deferred until all the namespace information is available after the entire attribute specification has been read.Caution: If this method is called it should not be mixed with calls to
addAttribute
unless it has been determined that all the attribute names are unique.- Parameters:
name
- the attribute nametype
- the attribute typevalue
- the attribute valuespecified
- the specified attribute value
-
addAttribute
-
removeAllAttributes
public void removeAllAttributes()Removes all of the attributes. This method will also remove all entities associated to the attributes.- Specified by:
removeAllAttributes
in interfaceXMLAttributes
-
removeAttributeAt
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.
- Specified by:
removeAttributeAt
in interfaceXMLAttributes
- Parameters:
attrIndex
- The attribute index.
-
setName
Sets the name of the attribute at the specified index.- Specified by:
setName
in interfaceXMLAttributes
- Parameters:
attrIndex
- The attribute index.attrName
- The new attribute name.
-
getName
Sets the fields in the given QName structure with the values of the attribute name at the specified index.- Specified by:
getName
in interfaceXMLAttributes
- Parameters:
attrIndex
- The attribute index.attrName
- The attribute name structure to fill in.
-
setType
Sets the type of the attribute at the specified index.- Specified by:
setType
in interfaceXMLAttributes
- Parameters:
attrIndex
- The attribute index.attrType
- 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
Sets the value of the attribute at the specified index. This method will overwrite the non-normalized value of the attribute.- Specified by:
setValue
in interfaceXMLAttributes
- Parameters:
attrIndex
- The attribute index.attrValue
- The new attribute value.
-
setSpecified
public void setSpecified(int attrIndex, boolean specified) Sets whether an attribute is specified in the instance document or not.- Specified by:
setSpecified
in interfaceXMLAttributes
- Parameters:
attrIndex
- The attribute index.specified
- True if the attribute is specified in the instance document.
-
isSpecified
public boolean isSpecified(int attrIndex) Returns true if the attribute is specified in the instance document.- Specified by:
isSpecified
in interfaceXMLAttributes
- Parameters:
attrIndex
- The attribute index.- Returns:
- true if the attribute is specified in the instance document.
-
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.
- Specified by:
getLength
in interfaceXMLAttributes
- Returns:
- The number of attributes in the list.
- See Also:
-
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 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".
- Specified by:
getType
in interfaceXMLAttributes
- Parameters:
index
- The attribute index (zero-based).- Returns:
- The attribute's type as a string, or null if the index is out of range.
- See Also:
-
getType
Look up an attribute's type by XML 1.0 qualified name.See
getType(int)
for a description of the possible types.- Specified by:
getType
in interfaceXMLAttributes
- Parameters:
qname
- The XML 1.0 qualified name.- Returns:
- The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.
-
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.
- Specified by:
getValue
in interfaceXMLAttributes
- Parameters:
index
- The attribute index (zero-based).- Returns:
- The attribute's value as a string, or null if the index is out of range.
- See Also:
-
getValue
Look up an attribute's value by XML 1.0 qualified name.See
getValue(int)
for a description of the possible values.- Specified by:
getValue
in interfaceXMLAttributes
- Parameters:
qname
- The XML 1.0 qualified name.- Returns:
- The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.
-
getNameRawName
Return the name of an attribute in this list (by position).The names must be unique: the SAX parser shall not include the same attribute twice. Attributes without values (those declared #IMPLIED without a value specified in the start tag) will be omitted from the list.
If the attribute name has a namespace prefix, the prefix will still be attached.
- Parameters:
index
- The index of the attribute in the list (starting at 0).- Returns:
- The name of the indexed attribute, or null if the index is out of range.
- See Also:
-
getName
Returns the full QName of the name of this attribute.- Specified by:
getName
in interfaceXMLAttributes
- Parameters:
index
- The attribute index.
-
getIndex
Look up the index of an attribute by XML 1.0 qualified name.- Specified by:
getIndex
in interfaceXMLAttributes
- Parameters:
qName
- The qualified (prefixed) name.- Returns:
- The index of the attribute, or -1 if it does not appear in the list.
-
getIndex
Look up the index of an attribute by Namespace name.- Specified by:
getIndex
in interfaceXMLAttributes
- Parameters:
uri
- The Namespace URI, or null if the name has no Namespace URI.localPart
- The attribute's local name.- Returns:
- The index of the attribute, or -1 if it does not appear in the list.
-
getLocalName
Look up an attribute's local name by index.- Specified by:
getLocalName
in interfaceXMLAttributes
- Parameters:
index
- The attribute index (zero-based).- Returns:
- 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:
-
getQName
Look up an attribute's XML 1.0 qualified name by index.- Specified by:
getQName
in interfaceXMLAttributes
- Parameters:
index
- The attribute index (zero-based).- Returns:
- 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:
-
getType
Look up an attribute's type by Namespace name.See
getType(int)
for a description of the possible types.- Specified by:
getType
in interfaceXMLAttributes
- Parameters:
uri
- The Namespace URI, or null if the name has no Namespace URI.localName
- The local name of the attribute.- 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.
-
getURI
Look up an attribute's Namespace URI by index.- Specified by:
getURI
in interfaceXMLAttributes
- Parameters:
index
- The attribute index (zero-based).- Returns:
- The Namespace URI
- See Also:
-
getValue
Look up an attribute's value by Namespace name.See
getValue(int)
for a description of the possible values.- Specified by:
getValue
in interfaceXMLAttributes
- Parameters:
uri
- The Namespace URI, or null if thelocalName
- The local name of the attribute.- Returns:
- The attribute value as a string, or null if the attribute is not in the list.
-
getNonNormalizedValue
- Specified by:
getNonNormalizedValue
in interfaceXMLAttributes
- Parameters:
index
- The attribute index.- 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.
-
getReportableType
Returns the value passed in or NMTOKEN if it's an enumerated type.- Parameters:
type
- attribute type- Returns:
- the value passed in or NMTOKEN if it's an enumerated type.
-