org.w3c.tidy
Class DOMAttrImpl

java.lang.Object
  |
  +--org.w3c.tidy.DOMNodeImpl
        |
        +--org.w3c.tidy.DOMAttrImpl
All Implemented Interfaces:
Attr, Node

public class DOMAttrImpl
extends DOMNodeImpl
implements Attr

DOMAttrImpl (c) 1998-2000 (W3C) MIT, INRIA, Keio University See Tidy.java for the copyright notice. Derived from HTML Tidy Release 4 Aug 2000

Version:
1.4, 1999/09/04 DOM Support
Author:
Dave Raggett , Andy Quick (translation to Java)

Field Summary
protected  AttVal avAdaptee
           
 
Fields inherited from class org.w3c.tidy.DOMNodeImpl
adaptee
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
protected DOMAttrImpl(AttVal adaptee)
           
 
Method Summary
 Node appendChild(Node newChild)
          Adds the node newChild to the end of the list of children of this node.
 Node cloneNode(boolean deep)
          Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
 NamedNodeMap getAttributes()
          A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
 NodeList getChildNodes()
          A NodeList that contains all children of this node.
 Node getFirstChild()
          The first child of this node.
 Node getLastChild()
          The last child of this node.
 java.lang.String getName()
          Returns the name of this attribute.
 Node getNextSibling()
          The node immediately following this node.
 java.lang.String getNodeName()
          The name of this node, depending on its type; see the table above.
 short getNodeType()
          A code representing the type of the underlying object, as defined above.
 java.lang.String getNodeValue()
          The value of this node, depending on its type; see the table above.
 Document getOwnerDocument()
          The Document object associated with this node.
 Element getOwnerElement()
          DOM2 - not implemented.
 Node getParentNode()
          The parent of this node.
 Node getPreviousSibling()
          The node immediately preceding this node.
 boolean getSpecified()
          If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false.
 java.lang.String getValue()
          Returns value of this attribute.
 boolean hasChildNodes()
          Returns whether this node has any children.
 Node insertBefore(Node newChild, Node refChild)
          Inserts the node newChild before the existing child node refChild.
 Node removeChild(Node oldChild)
          Removes the child node indicated by oldChild from the list of children, and returns it.
 Node replaceChild(Node newChild, Node oldChild)
          Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
 void setNodeValue(java.lang.String nodeValue)
           
 void setValue(java.lang.String value)
           
 
Methods inherited from class org.w3c.tidy.DOMNodeImpl
getLocalName, getNamespaceURI, getPrefix, hasAttributes, isSupported, normalize, setPrefix, supports
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Node
getLocalName, getNamespaceURI, getPrefix, hasAttributes, isSupported, normalize, setPrefix
 

Field Detail

avAdaptee

protected AttVal avAdaptee
Constructor Detail

DOMAttrImpl

protected DOMAttrImpl(AttVal adaptee)
Method Detail

getNodeValue

public java.lang.String getNodeValue()
                              throws DOMException
Description copied from interface: Node
The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect.
Specified by:
getNodeValue in interface Node
Overrides:
getNodeValue in class DOMNodeImpl
Following copied from interface: org.w3c.dom.Node
Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setNodeValue

public void setNodeValue(java.lang.String nodeValue)
                  throws DOMException
Specified by:
setNodeValue in interface Node
Overrides:
setNodeValue in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.setNodeValue(java.lang.String)

getNodeName

public java.lang.String getNodeName()
Description copied from interface: Node
The name of this node, depending on its type; see the table above.
Specified by:
getNodeName in interface Node
Overrides:
getNodeName in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getNodeName()

getNodeType

public short getNodeType()
Description copied from interface: Node
A code representing the type of the underlying object, as defined above.
Specified by:
getNodeType in interface Node
Overrides:
getNodeType in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getNodeType()

getParentNode

public Node getParentNode()
Description copied from interface: Node
The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.
Specified by:
getParentNode in interface Node
Overrides:
getParentNode in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getParentNode()

getChildNodes

public NodeList getChildNodes()
Description copied from interface: Node
A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
Specified by:
getChildNodes in interface Node
Overrides:
getChildNodes in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getChildNodes()

getFirstChild

public Node getFirstChild()
Description copied from interface: Node
The first child of this node. If there is no such node, this returns null.
Specified by:
getFirstChild in interface Node
Overrides:
getFirstChild in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getFirstChild()

getLastChild

public Node getLastChild()
Description copied from interface: Node
The last child of this node. If there is no such node, this returns null.
Specified by:
getLastChild in interface Node
Overrides:
getLastChild in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getLastChild()

getPreviousSibling

public Node getPreviousSibling()
Description copied from interface: Node
The node immediately preceding this node. If there is no such node, this returns null.
Specified by:
getPreviousSibling in interface Node
Overrides:
getPreviousSibling in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getPreviousSibling()

getNextSibling

public Node getNextSibling()
Description copied from interface: Node
The node immediately following this node. If there is no such node, this returns null.
Specified by:
getNextSibling in interface Node
Overrides:
getNextSibling in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getNextSibling()

getAttributes

public NamedNodeMap getAttributes()
Description copied from interface: Node
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
Specified by:
getAttributes in interface Node
Overrides:
getAttributes in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getAttributes()

getOwnerDocument

public Document getOwnerDocument()
Description copied from interface: Node
The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
Specified by:
getOwnerDocument in interface Node
Overrides:
getOwnerDocument in class DOMNodeImpl
Following copied from class: org.w3c.tidy.DOMNodeImpl
See Also:
Node.getOwnerDocument()

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException
Description copied from interface: Node
Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.
Specified by:
insertBefore in interface Node
Overrides:
insertBefore in class DOMNodeImpl
Following copied from interface: org.w3c.dom.Node
Parameters:
newChildThe - node to insert.
refChildThe - reference node, i.e., the node before which the new node must be inserted.
Returns:
The node being inserted.
Throws:
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.
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.

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws DOMException
Description copied from interface: Node
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.
Specified by:
replaceChild in interface Node
Overrides:
replaceChild in class DOMNodeImpl
Following copied from interface: org.w3c.dom.Node
Parameters:
newChildThe - new node to put in the child list.
oldChildThe - node being replaced in the list.
Returns:
The node replaced.
Throws:
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.
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.

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException
Description copied from interface: Node
Removes the child node indicated by oldChild from the list of children, and returns it.
Specified by:
removeChild in interface Node
Overrides:
removeChild in class DOMNodeImpl
Following copied from interface: org.w3c.dom.Node
Parameters:
oldChildThe - node being removed.
Returns:
The node removed.
Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

appendChild

public Node appendChild(Node newChild)
                 throws DOMException
Description copied from interface: Node
Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.
Specified by:
appendChild in interface Node
Overrides:
appendChild in class DOMNodeImpl
Following copied from interface: org.w3c.dom.Node
Parameters:
newChildThe - node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node
Returns:
The node added.
Throws:
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 append is one of this node's ancestors.
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.

hasChildNodes

public boolean hasChildNodes()
Description copied from interface: Node
Returns whether this node has any children.
Specified by:
hasChildNodes in interface Node
Overrides:
hasChildNodes in class DOMNodeImpl
Following copied from interface: org.w3c.dom.Node
Returns:
true if this node has any children, false otherwise.

cloneNode

public Node cloneNode(boolean deep)
Description copied from interface: Node
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.).
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 text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning an Attribute directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute ( specified is true). 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.
Specified by:
cloneNode in interface Node
Overrides:
cloneNode in class DOMNodeImpl
Following copied from interface: org.w3c.dom.Node
Parameters:
deepIf - true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
Returns:
The duplicate node.

getName

public java.lang.String getName()
Description copied from interface: Attr
Returns the name of this attribute.
Specified by:
getName in interface Attr
See Also:
Attr.getName()

getSpecified

public boolean getSpecified()
Description copied from interface: Attr
If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false. Note that the implementation is in charge of this attribute, not the user. If the user changes the value of the attribute (even if it ends up having the same value as the default value) then the specified flag is automatically flipped to true. To re-specify the attribute as the default value from the DTD, the user must delete the attribute. The implementation will then make a new attribute available with specified set to false and the default value (if one exists).
In summary: If the attribute has an assigned value in the document then specified is true, and the value is the assigned value. If the attribute has no assigned value in the document and has a default value in the DTD, then specified is false, and the value is the default value in the DTD. If the attribute has no assigned value in the document and has a value of #IMPLIED in the DTD, then the attribute does not appear in the structure model of the document. If the ownerElement attribute is null (i.e. because it was just created or was set to null by the various removal and cloning operations) specified is true.
Specified by:
getSpecified in interface Attr
See Also:
Attr.getSpecified()

getValue

public java.lang.String getValue()
Returns value of this attribute. If this attribute has a null value, then the attribute name is returned instead. Thanks to Brett Knights for this fix.
Specified by:
getValue in interface Attr
See Also:
Attr.getValue()

setValue

public void setValue(java.lang.String value)
Specified by:
setValue in interface Attr
See Also:
Attr.setValue(java.lang.String)

getOwnerElement

public Element getOwnerElement()
DOM2 - not implemented.
Specified by:
getOwnerElement in interface Attr