This class is not part of the public API.

Class: com.sun.org.apache.xerces.internal.dom.AttrImpl

Attribute represents an XML-style attribute of an Element. Typically, the allowable values are controlled by its declaration in the Document Type Definition (DTD) governing this kind of document.

If the attribute has not been explicitly assigned a value, but has been declared in the DTD, it will exist and have that default. Only if neither the document nor the DTD specifies a value will the Attribute really be considered absent and have no value; in that case, querying the attribute will return null.

Attributes may have multiple children that contain their data. (XML allows attributes to contain entity references, and tokenized attribute types such as NMTOKENS may have a child for each token.) For convenience, the Attribute object's getValue() method returns the string version of the attribute's value.

Attributes are not children of the Elements they belong to, in the usual sense, and have no valid Parent reference. However, the spec says they _do_ belong to a specific Element, and an INUSE exception is to be thrown if the user attempts to explicitly share them between elements.

Note that Elements do not permit attributes to appear to be shared (see the INUSE exception), so this object's mutability is officially not an issue.

Note: The ownerNode attribute is used to store the Element the Attr node is associated with. Attr nodes do not have parent nodes. Besides, the getOwnerElement() method can be used to get the element node this attribute is associated with.

AttrImpl does not support Namespaces. AttrNSImpl, which inherits from it, does.

AttrImpl used to inherit from ParentNode. It now directly inherits from NodeImpl and provide its own implementation of the ParentNode's behavior. The reason is that we now try and avoid to always create a Text node to hold the value of an attribute. The DOM spec requires it, so we still have to do it in case getFirstChild() is called for instance. The reason attribute values are stored as a list of nodes is so that they can carry more than a simple string. They can also contain EntityReference nodes. However, most of the times people only have a single string that they only set and get through Element.set/getAttribute or Attr.set/getValue. In this new version, the Attr node has a value pointer which can either be the String directly or a pointer to the first ChildNode. A flag tells which one it currently is. Note that while we try to stick with the direct String as much as possible once we've switched to a node there is no going back. This is because we have no way to know whether the application keeps referring to the node we once returned.

The gain in memory varies on the density of attributes in the document. But in the tests I've run I've seen up to 12% of memory gain. And the good thing is that it also leads to a slight gain in speed because we allocate fewer objects! I mean, that's until we have to actually create the node...

To avoid too much duplicated code, I got rid of ParentNode and renamed ChildAndParentNode, which I never really liked, to ParentNode for simplicity, this doesn't make much of a difference in memory usage because there are only very few objects that are only a Parent. This is only true now because AttrImpl now inherits directly from NodeImpl and has its own implementation of the ParentNode's node behavior. So there is still some duplicated code there.

This class doesn't directly support mutation events, however, it notifies the document when mutations are performed so that the document class do so.

WARNING: Some of the code here is partially duplicated in ParentNode, be careful to keep these two classes in sync!

Authors:
@author Arnaud Le Hors, IBM
@author Joe Kesselman, IBM
@author Andy Clark, IBM
See:
@see com.sun.org.apache.xerces.internal.dom.AttrNSImpl
Since:
@since PR-DOM-Level-1-19980818.
Misc:
@xerces.internal

Inheritance

Superclass tree: Implements:

Methods

  • AttrImpltop

    protected AttrImpl()
    Related Links:
    Google Code Search
    Stack Overflow

  • AttrImpltop

    protected AttrImpl(CoreDocumentImpl ownerDocument, String name)
    Attribute has no public constructor. Please use the factory method in the Document class.
    Related Links:
    Google Code Search
    Stack Overflow

  • checkNormalizationAfterInserttop

    void checkNormalizationAfterInsert(ChildNode insertedChild)
    Checks the normalized state of this node after inserting a child. If the inserted child causes this node to be unnormalized, then this node is flagged accordingly. The conditions for changing the normalized state are:
    • The inserted child is a text node and one of its adjacent siblings is also a text node.
    • The inserted child is is itself unnormalized.
    Parameters:
    @param insertedChild the child node that was inserted into this node
    Exceptions:
    @throws NullPointerException if the inserted child is null
    Related Links:
    Google Code Search
    Stack Overflow

  • checkNormalizationAfterRemovetop

    void checkNormalizationAfterRemove(ChildNode previousSibling)
    Checks the normalized of this node after removing a child. If the removed child causes this node to be unnormalized, then this node is flagged accordingly. The conditions for changing the normalized state are:
    • The removed child had two adjacent siblings that were text nodes.
    Parameters:
    @param previousSibling the previous sibling of the removed child, or null
    Related Links:
    Google Code Search
    Stack Overflow

  • cloneNodetop

    public Node cloneNode(boolean deep)
    Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent ( parentNode is null) and no user data. User data associated to the imported node is not carried over. However, if any UserDataHandlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
    Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any children it contains unless it is a deep clone. This includes text contained in an the Element since the text is contained in a child Text node. Cloning an Attr directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is true). Cloning an Attr always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning an EntityReference automatically constructs its subtree if a corresponding Entity is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node.
    Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly . In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.
    Parameters:
    @param deep If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
    Return:
    @return The duplicate node.
    Specified by:
    cloneNode from Node
    Override hierarchy:
    cloneNode from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • getChildNodestop

    public NodeList getChildNodes()
    Obtain a NodeList enumerating all children of this node. If there are none, an (initially) empty NodeList is returned.

    NodeLists are "live"; as children are added/removed the NodeList will immediately reflect those changes. Also, the NodeList refers to the actual nodes, so changes to those nodes made via the DOM tree will be reflected in the NodeList and vice versa.

    In this implementation, Nodes implement the NodeList interface and provide their own getChildNodes() support. Other DOMs may solve this differently.

    Specified by:
    getChildNodes from Node
    Override hierarchy:
    getChildNodes from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • getElementtop

    public Element getElement()
    Returns the element node that this attribute is associated with, or null if the attribute has not been added to an element.
    Deprecated:
    @deprecated Previous working draft of DOM Level 2. New method is getOwnerElement().
    See:
    @see com.sun.org.apache.xerces.internal.dom.AttrImpl.getOwnerElement()
    Related Links:
    Google Code Search
    Stack Overflow

  • getFirstChildtop

    public Node getFirstChild()
    The first child of this Node, or null if none.
    Specified by:
    getFirstChild from Node
    Override hierarchy:
    getFirstChild from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • getLastChildtop

    public Node getLastChild()
    The last child of this Node, or null if none.
    Specified by:
    getLastChild from Node
    Override hierarchy:
    getLastChild from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • getLengthtop

    public int getLength()
    NodeList method: Count the immediate children of this node
    Return:
    @return int
    Specified by:
    getLength from NodeList
    Override hierarchy:
    getLength from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • getNametop

    public String getName()
    In Attributes, NodeName is considered a synonym for the attribute's Name
    Specified by:
    getName from Attr
    Related Links:
    Google Code Search
    Stack Overflow

  • getNodeNametop

    public String getNodeName()
    Returns the attribute name
    Specified by:
    getNodeName from Node
    Override hierarchy:
    getNodeName from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • getNodeTypetop

    public short getNodeType()
    A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface.
    Specified by:
    getNodeType from Node
    Override hierarchy:
    getNodeType from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • getNodeValuetop

    public String getNodeValue()
    In Attribute objects, NodeValue is considered a synonym for Value.
    See:
    @see com.sun.org.apache.xerces.internal.dom.AttrImpl.getValue()
    Specified by:
    getNodeValue from Node
    Override hierarchy:
    getNodeValue from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • getOwnerElementtop

    public Element getOwnerElement()
    Returns the element node that this attribute is associated with, or null if the attribute has not been added to an element.
    Since:
    @since WD-DOM-Level-2-19990719
    Specified by:
    getOwnerElement from Attr
    Related Links:
    Google Code Search
    Stack Overflow

  • getSchemaTypeInfotop

    public TypeInfo getSchemaTypeInfo()
    Method getSchemaTypeInfo.
    Return:
    @return TypeInfo
    Specified by:
    getSchemaTypeInfo from Attr
    Related Links:
    Google Code Search
    Stack Overflow

  • getSpecifiedtop

    public boolean getSpecified()
    The "specified" flag is true if and only if this attribute's value was explicitly specified in the original document. Note that the implementation, not the user, is in charge of this property. If the user asserts an Attribute value (even if it ends up having the same value as the default), it is considered a specified attribute. If you really want to revert to the default, delete the attribute from the Element, and the Implementation will re-assert the default (if any) in its place, with the appropriate specified=false setting.
    Specified by:
    getSpecified from Attr
    Related Links:
    Google Code Search
    Stack Overflow

  • getTypeNametop

    public String getTypeName()
    The name of a type declared for the associated element or attribute, or null if unknown.
    See:
    @see org.w3c.dom.TypeInfo.getTypeName()
    Specified by:
    getTypeName from TypeInfo
    Related Links:
    Google Code Search
    Stack Overflow

  • getTypeNamespacetop

    public String getTypeNamespace()
    The namespace of the type declared for the associated element or attribute or null if the element does not have declaration or if no namespace information is available.
    See:
    @see org.w3c.dom.TypeInfo.getTypeNamespace()
    Specified by:
    getTypeNamespace from TypeInfo
    Related Links:
    Google Code Search
    Stack Overflow

  • getValuetop

    public String getValue()
    The "string value" of an Attribute is its text representation, which in turn is a concatenation of the string values of its children.
    Specified by:
    getValue from Attr
    Related Links:
    Google Code Search
    Stack Overflow

  • hasChildNodestop

    public boolean hasChildNodes()
    Test whether this node has any children. Convenience shorthand for (Node.getFirstChild()!=null)
    Return:
    @return Returns true if this node has any children, false otherwise.
    Specified by:
    hasChildNodes from Node
    Override hierarchy:
    hasChildNodes from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • insertBeforetop

    public Node insertBefore(Node newChild, Node refChild) throws DOMException
    Move one or more node(s) to our list of children. Note that this implicitly removes them from their previous parent.
    Parameters:
    @param newChild The Node to be moved to our subtree. As a convenience feature, inserting a DocumentNode will instead insert all its children.
    @param refChild Current child which newChild should be placed immediately before. If refChild is null, the insertion occurs after all existing Nodes, like appendChild().
    Return:
    @return newChild, in its new state (relocated, or emptied in the case of DocumentNode.)
    Exceptions:
    @throws DOMException(HIERARCHY_REQUEST_ERR) if newChild is of a type that shouldn't be a child of this node, or if newChild is an ancestor of this node.
    @throws DOMException(WRONG_DOCUMENT_ERR) if newChild has a different owner document than we do.
    @throws DOMException(NOT_FOUND_ERR) if refChild is not a child of this node.
    @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) if this node is read-only.
    @exception DOMException HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors or this node itself, or if this node is of type Document and the DOM application attempts to insert a second DocumentType or Element node.
    WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
    NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
    NOT_FOUND_ERR: Raised if refChild is not a child of this node.
    NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the insertion of a DocumentType or Element node.
    Specified by:
    insertBefore from Node
    Override hierarchy:
    insertBefore from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • internalInsertBeforetop

    Node internalInsertBefore(Node newChild, Node refChild, boolean replace) throws DOMException
    NON-DOM INTERNAL: Within DOM actions,we sometimes need to be able to control which mutation events are spawned. This version of the insertBefore operation allows us to do so. It is not intended for use by application programs.
    Related Links:
    Google Code Search
    Stack Overflow

  • internalRemoveChildtop

    Node internalRemoveChild(Node oldChild, boolean replace) throws DOMException
    NON-DOM INTERNAL: Within DOM actions,we sometimes need to be able to control which mutation events are spawned. This version of the removeChild operation allows us to do so. It is not intended for use by application programs.
    Related Links:
    Google Code Search
    Stack Overflow

  • isDerivedFromtop

    public boolean isDerivedFrom(String typeNamespaceArg, String typeNameArg, int derivationMethod)
    Introduced in DOM Level 3.

    Checks if a type is derived from another by restriction. See: http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom

    Parameters:
    @param ancestorNS The namspace of the ancestor type declaration
    @param ancestorName The name of the ancestor type declaration
    @param type The reference type definition
    @param typeNamespaceArg the namespace of the other type definition.
    @param typeNameArg the name of the other type definition.
    @param derivationMethod the type of derivation and conditions applied between two types, as described in the list of constants provided in this interface.
    Return:
    @return boolean True if the type is derived by restriciton for the reference type
    Specified by:
    isDerivedFrom from TypeInfo
    Related Links:
    Google Code Search
    Stack Overflow

  • isEqualNodetop

    public boolean isEqualNode(Node arg)
    DOM Level 3 WD- Experimental. Override inherited behavior from ParentNode to support deep equal. isEqualNode is always deep on Attr nodes.
    Parameters:
    @param arg The node to compare equality with.
    Return:
    @return Returns true if the nodes are equal, false otherwise.
    Specified by:
    isEqualNode from Node
    Override hierarchy:
    isEqualNode from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • isIdtop

    public boolean isId()
    DOM Level 3: isId
    Specified by:
    isId from Attr
    Related Links:
    Google Code Search
    Stack Overflow

  • itemtop

    public Node item(int index)
    NodeList method: Return the Nth immediate child of this node, or null if the index is out of bounds.
    Parameters:
    @param Index int
    @param index Index into the collection.
    Return:
    @return org.w3c.dom.Node
    Specified by:
    item from NodeList
    Override hierarchy:
    item from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • lastChildtop

    final ChildNode lastChild()
    Related Links:
    Google Code Search
    Stack Overflow

  • lastChildtop

    final void lastChild(ChildNode node)
    Related Links:
    Google Code Search
    Stack Overflow

  • makeChildNodetop

    protected void makeChildNode()
    Related Links:
    Google Code Search
    Stack Overflow

  • normalizetop

    public void normalize()
    Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer [XPointer] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of the DOMConfiguration object attached to the Node.ownerDocument is true, this method will also fully normalize the characters of the Text nodes.

    Note: In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

    Specified by:
    normalize from Node
    Override hierarchy:
    normalize from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • readObjecttop

    private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException
    Deserialize object.
    Related Links:
    Google Code Search
    Stack Overflow

  • removeChildtop

    public Node removeChild(Node oldChild) throws DOMException
    Remove a child from this Node. The removed child's subtree remains intact so it may be re-inserted elsewhere.
    Parameters:
    @param oldChild The node being removed.
    Return:
    @return oldChild, in its new state (removed).
    Exceptions:
    @throws DOMException(NOT_FOUND_ERR) if oldChild is not a child of this node.
    @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) if this node is read-only.
    @exception DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
    NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
    NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or the Element child.
    Specified by:
    removeChild from Node
    Override hierarchy:
    removeChild from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • renametop

    void rename(String name)
    Related Links:
    Google Code Search
    Stack Overflow

  • replaceChildtop

    public Node replaceChild(Node newChild, Node oldChild) throws DOMException
    Make newChild occupy the location that oldChild used to have. Note that newChild will first be removed from its previous parent, if any. Equivalent to inserting newChild before oldChild, then removing oldChild.
    Parameters:
    @param newChild The new node to put in the child list.
    @param oldChild The node being replaced in the list.
    Return:
    @return oldChild, in its new state (removed).
    Exceptions:
    @throws DOMException(HIERARCHY_REQUEST_ERR) if newChild is of a type that shouldn't be a child of this node, or if newChild is one of our ancestors.
    @throws DOMException(WRONG_DOCUMENT_ERR) if newChild has a different owner document than we do.
    @throws DOMException(NOT_FOUND_ERR) if oldChild is not a child of this node.
    @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) if this node is read-only.
    @exception DOMException HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors or this node itself, or if this node is of type Document and the result of the replacement operation would add a second DocumentType or Element on the Document node.
    WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
    NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
    NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
    NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the replacement of the DocumentType child or Element child.
    Specified by:
    replaceChild from Node
    Override hierarchy:
    replaceChild from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • setIdAttributetop

    public void setIdAttribute(boolean id)
    NON-DOM: set the type of this attribute to be ID type.
    Parameters:
    @param id
    Related Links:
    Google Code Search
    Stack Overflow

  • setNodeValuetop

    public void setNodeValue(String value) throws DOMException
    Implicit in the rerouting of getNodeValue to getValue is the need to redefine setNodeValue, for symmetry's sake. Note that since we're explicitly providing a value, Specified should be set true.... even if that value equals the default.
    Exceptions:
    @exception DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to be null.
    Specified by:
    setNodeValue from Node
    Override hierarchy:
    setNodeValue from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • setOwnerDocumenttop

    void setOwnerDocument(CoreDocumentImpl doc)
    NON-DOM set the ownerDocument of this node and its children
    Override hierarchy:
    setOwnerDocument from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • setReadOnlytop

    public void setReadOnly(boolean readOnly, boolean deep)
    Override default behavior so that if deep is true, children are also toggled.
    Parameters:
    @param readOnly True or false as desired.
    @param deep If true, children are also toggled. Note that this will not change the state of an EntityReference or its children, which are always read-only.
    See:
    @see

    Note: this will not change the state of an EntityReference or its children, which are always read-only.

    Override hierarchy:
    setReadOnly from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

  • setSpecifiedtop

    public void setSpecified(boolean arg)
    NON-DOM, for use by parser
    Related Links:
    Google Code Search
    Stack Overflow

  • setTypetop

    public void setType(Object type)
    NON-DOM: used by the parser
    Parameters:
    @param type
    Related Links:
    Google Code Search
    Stack Overflow

  • setValuetop

    public void setValue(String newvalue)
    The DOM doesn't clearly define what setValue(null) means. I've taken it as "remove all children", which from outside should appear similar to setting it to the empty string.
    Specified by:
    setValue from Attr
    Related Links:
    Google Code Search
    Stack Overflow

  • synchronizeChildrentop

    protected void synchronizeChildren()
    Override this method in subclass to hook in efficient internal data structure.
    Related Links:
    Google Code Search
    Stack Overflow

  • toStringtop

    public String toString()
    NON-DOM method for debugging convenience
    Return:
    @return a string representation of the object.
    Override hierarchy:
    toString from NodeImpl
    toString from Object
    Related Links:
    Google Code Search
    Stack Overflow

  • writeObjecttop

    private void writeObject(ObjectOutputStream out) throws IOException
    Serialize object.
    Override hierarchy:
    writeObject from NodeImpl
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • DTD_URI

    static final String DTD_URI = "http://www.w3.org/TR/REC-xml"
    DTD namespace.

  • name

    protected String name
    Attribute name.

  • serialVersionUID

    static final long serialVersionUID = 7277707688218972102
    Serialization version.

  • textNode

    static protected TextImpl textNode

  • type

    transient Object type
    Type information

  • value

    protected Object value
    This can either be a String or the first child node.