Package org.aspectj.org.eclipse.jdt.internal.core.jdom

Class DOMNode

java.lang.Object
org.aspectj.org.eclipse.jdt.internal.core.jdom.DOMNode
All Implemented Interfaces:
Cloneable, IDOMNode
public abstract class DOMNode extends Object implements IDOMNode
Deprecated.
The JDOM was made obsolete by the addition in 2.0 of the more powerful, fine-grained DOM/AST API found in the org.aspectj.org.eclipse.jdt.core.dom package.
DOMNode provides an implementation for IDOMNode.

A node represents a document fragment. When a node is created, its contents are located in a contiguous range of a shared document. A shared document is a char array, and is shared in the sense that the contents of other document fragments may also be contained in the array.

A node maintains indicies of relevant portions of its contents in the shared document. Thus the original document and indicies create a form from which to generate the contents of the document fragment. As attributes of a node are changed, the node attempts to maintain the original formatting by only replacing relevant portions of the shared document with the value of new attributes (that is, filling in the form with replacement values).

When a node is first created, it is considered unfragmented. When any attribute of the node is altered, the node is then considered fragmented from that point on. A node is also considered fragmented if any of its descendants are fragmented. When a node is unfragmented, the contents of the node can be efficiently generated from the original shared document. When a node is fragmented, the contents of the node must be created using the original document and indicies as a form, filling in replacement values as required.

Generally, a node's contents consists of complete lines in a shared document. The contents of the node are normalized on creation to include any whitespace preceding the node on the line where the node begins, and to include and trailing whitespace up to the line where the next node begins. Any trailing // comments that begin on the line where the current node ends, are considered part of that node.

See Also:
IDOMNode

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected char[]
    fDocument
    Deprecated.
    The shared document that the contents for this node are contained in.
    protected DOMNode
    fFirstChild
    Deprecated.
    The first child of this node - null when this node has no children.
    protected int
    fInsertionPosition
    Deprecated.
    This position is the position of the end of the last line separator before the closing brace starting position of the receiver.
    protected boolean
    fIsFragmented
    Deprecated.
    True when this node has attributes that have been altered from their original state in the shared document, or when the attributes of a descendant have been altered.
    protected DOMNode
    fLastChild
    Deprecated.
    The last child of this node - null when this node has no children.
    protected String
    fName
    Deprecated.
    The name of this node.
    protected int[]
    fNameRange
    Deprecated.
    The original inclusive indicies of this node's name in the shared document.
    protected DOMNode
    fNextNode
    Deprecated.
    The sibling node following this node - null for the last node in the sibling list.
    protected DOMNode
    fParent
    Deprecated.
    The parent of this node.
    protected DOMNode
    fPreviousNode
    Deprecated.
    The sibling node preceding this node - null for the first node in the sibling list.
    protected int[]
    fSourceRange
    Deprecated.
    The original entire inclusive range of this node's contents within its document.
    protected int
    fStateMask
    Deprecated.
    The current state of bit masks defined by this node.
    protected static int
    MASK_DETAILED_SOURCE_INDEXES
    Deprecated.
    A bit mask indicating this node has detailed source indexes
    protected static int
    MASK_FIELD_HAS_INITIALIZER
    Deprecated.
    A bit mask indicating this field has an initializer expression
    protected static int
    MASK_FIELD_IS_VARIABLE_DECLARATOR
    Deprecated.
    A bit mask indicating this field is a secondary variable declarator for a previous field declaration.
    protected static int
    MASK_FIELD_TYPE_ALTERED
    Deprecated.
    A bit mask indicating this field's type has been altered from its original contents in the document.
    protected static int
    MASK_HAS_BODY
    Deprecated.
    A bit mask indicating this node currently has a body.
    protected static int
    MASK_HAS_COMMENT
    Deprecated.
    A bit mask indicating this node currently has a preceding comment.
    protected static int
    MASK_IS_CONSTRUCTOR
    Deprecated.
    A bit mask indicating this method is a constructor.
    protected static int
    MASK_NAME_ALTERED
    Deprecated.
    A bit mask indicating this node's name has been altered from its original contents in the document.
    protected static int
    MASK_RETURN_TYPE_ALTERED
    Deprecated.
    A bit mask indicating this return type of this method has been altered from the original contents.
    protected static int
    MASK_TYPE_HAS_INTERFACES
    Deprecated.
    A bit mask indicating this type implements or extends some interfaces
    protected static int
    MASK_TYPE_HAS_SUPERCLASS
    Deprecated.
    A bit mask indicating this type has a superclass (requires or has an 'extends' clause).
    protected static int
    MASK_TYPE_IS_CLASS
    Deprecated.
    A bit mask indicating this type is a class.

    Fields inherited from interface org.aspectj.org.eclipse.jdt.core.jdom.IDOMNode

    COMPILATION_UNIT, FIELD, IMPORT, INITIALIZER, METHOD, PACKAGE, TYPE

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addChild​(IDOMNode child)
    Deprecated.
    Adds the given un-parented node (document fragment) as the last child of this node.
    protected void
    appendContents​(CharArrayBuffer buffer)
    Deprecated.
    Appends the current contents of this document fragment to the given CharArrayBuffer.
    protected void
    appendContentsOfChildren​(CharArrayBuffer buffer)
    Deprecated.
    Appends the contents of all children of this node to the given CharArrayBuffer.
    protected abstract void
    appendFragmentedContents​(CharArrayBuffer buffer)
    Deprecated.
    Appends the contents of this node to the given CharArrayBufer, using the original document and indicies as a form for the current attribute values of this node.
    protected void
    becomeDetailed()
    Deprecated.
    Generates detailed source indexes for this node if possible.
    boolean
    canHaveChildren()
    Deprecated.
    Returns true if this node is allowed to have children, otherwise false.
    Object
    clone()
    Deprecated.
    Returns a stand-alone copy of the document fragment represented by this node that is in no way dependent on the document this node is part of.
    protected void
    fragment()
    Deprecated.
    Sets this node's fragmented flag and all ancestor fragmented flags to true.
    char[]
    getCharacters()
    Deprecated.
    Returns the current contents of this document fragment as a character array.
    IDOMNode
    getChild​(String name)
    Deprecated.
    Returns the first named child of this node with the given name.
    Enumeration
    getChildren()
    Deprecated.
    Returns an enumeration of children of this node.
    String
    getContents()
    Deprecated.
    Returns the current contents of this document fragment, or null if this node has no contents.
    protected DOMNode
    getDetailedNode()
    Deprecated.
    Returns a new document fragment representing this node with detailed source indexes.
    protected char[]
    getDocument()
    Deprecated.
    Returns the document containing this node's original contents.
    int
    getEndPosition()
    Deprecated.
    Returns the original position of the last character of this node's contents in its document.
    protected IDOMFactory
    getFactory()
    Deprecated.
    Returns a factory with which to create new document fragments.
    IDOMNode
    getFirstChild()
    Deprecated.
    Returns the first child of this node.
    int
    getInsertionPosition()
    Deprecated.
    Returns the position at which the first child of this node should be inserted.
    protected boolean
    getMask​(int mask)
    Deprecated.
    Returns true if the given mask of this node's state flag is turned on, otherwise false.
    String
    getName()
    Deprecated.
    Returns the name of this node.
    protected char[]
    getNameContents()
    Deprecated.
    Returns the source code to be used for this node's name.
    IDOMNode
    getNextNode()
    Deprecated.
    Returns the sibling node immediately following this node.
    IDOMNode
    getParent()
    Deprecated.
    Returns the parent of this node.
    protected int
    getParentEndDeclaration()
    Deprecated.
    Answers a source position which corresponds to the end of the parent element's declaration.
    IDOMNode
    getPreviousNode()
    Deprecated.
    Returns the sibling node immediately preceding this node.
    protected IDOMNode
    getRoot()
    Deprecated.
    Returns the root node of this document fragment.
    int
    getStartPosition()
    Deprecated.
    Returns the original position of the first character of this node's contents in its document.
    void
    insertSibling​(IDOMNode sibling)
    Deprecated.
    Inserts the given un-parented node as a sibling of this node, immediately before this node.
    boolean
    isAllowableChild​(IDOMNode node)
    Deprecated.
    Returns whether the given node is an allowable child for this node.
    protected boolean
    isContentMergableWith​(DOMNode node)
    Deprecated.
    Returns true if the contents of this node are from the same document as the given node, the contents of this node immediately follow the contents of the given node, and neither this node or the given node are fragmented - otherwise false.
    protected boolean
    isDetailed()
    Deprecated.
    Returns true if this node has detailed source index information, or false if this node has limited source index information.
    protected boolean
    isFragmented()
    Deprecated.
    Returns true if this node's or a descendant node's contents have been altered since this node was created.
    protected boolean
    isNameAltered()
    Deprecated.
    Returns true if this noed's name has been altered from the original document contents.
    boolean
    isSignatureEqual​(IDOMNode node)
    Deprecated.
    Returns whether this node's signature is equivalent to the given node's signature.
    protected void
    localizeContents()
    Deprecated.
    Localizes the contents of this node and all descendant nodes, such that this node is no longer dependent on its original document in order to generate its contents.
    protected abstract DOMNode
    newDOMNode()
    Deprecated.
    Returns a new empty DOMNode for this instance.
    protected void
    offset​(int offset)
    Deprecated.
    Offsets all the source indexes in this node by the given amount.
    protected void
    offsetRange​(int[] range, int offset)
    Deprecated.
    Offsets the source range by the given amount
    protected int[]
    rangeCopy​(int[] range)
    Deprecated.
    Returns a copy of the given range.
    void
    remove()
    Deprecated.
    Separates this node from its parent and siblings, maintaining any ties that this node has to the underlying document fragment.
    protected void
    setMask​(int mask, boolean on)
    Deprecated.
    Sets the specified mask of this node's state mask on or off based on the boolean value - true -> on, false -> off.
    void
    setName​(String name)
    Deprecated.
    Sets the name of this node.
    protected void
    setNameAltered​(boolean altered)
    Deprecated.
    Sets the state of this node as having its name attribute altered from the original document contents.
    protected void
    setSourceRangeEnd​(int end)
    Deprecated.
    Sets the original position of the last character of this node's contents in its document.
    protected void
    setStartPosition​(int start)
    Deprecated.
    Sets the original position of the first character of this node's contents in its document.
    protected void
    shareContents​(DOMNode node)
    Deprecated.
    Sets the contents of this node and descendant nodes to be the (identical) contents of the given node and its descendants.
    abstract String
    toString()
    Deprecated.
    Returns a String representing this node - for Debug purposes only.

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.aspectj.org.eclipse.jdt.core.jdom.IDOMNode

    getJavaElement, getNodeType

  • Field Details

    • fFirstChild

      protected DOMNode fFirstChild
      Deprecated.
      The first child of this node - null when this node has no children. (Children of a node are implemented as a doubly linked list).

    • fLastChild

      protected DOMNode fLastChild
      Deprecated.
      The last child of this node - null when this node has no children. Used for efficient access to the last child when adding new children at the end of the linked list of children.

    • fNextNode

      protected DOMNode fNextNode
      Deprecated.
      The sibling node following this node - null for the last node in the sibling list.

    • fParent

      protected DOMNode fParent
      Deprecated.
      The parent of this node. A null parent indicates that this node is a root node of a document fragment.

    • fPreviousNode

      protected DOMNode fPreviousNode
      Deprecated.
      The sibling node preceding this node - null for the first node in the sibling list.

    • fIsFragmented

      protected boolean fIsFragmented
      Deprecated.
      True when this node has attributes that have been altered from their original state in the shared document, or when the attributes of a descendant have been altered. False when the contents of this node and all descendants are consistent with the content of the shared document.

    • fName

      protected String fName
      Deprecated.
      The name of this node. For efficiency, the name of a node is duplicated in this variable on creation, rather than always having to fetch the name from the shared document.

    • fNameRange

      protected int[] fNameRange
      Deprecated.
      The original inclusive indicies of this node's name in the shared document. Values of -1 indiciate the name does not exist in the document.

    • fDocument

      protected char[] fDocument
      Deprecated.
      The shared document that the contents for this node are contained in. Attribute indicies are positions in this character array.

    • fSourceRange

      protected int[] fSourceRange
      Deprecated.
      The original entire inclusive range of this node's contents within its document. Values of -1 indicate the contents of this node do not exist in the document.

    • fStateMask

      protected int fStateMask
      Deprecated.
      The current state of bit masks defined by this node. Initially all bit flags are turned off. All bit masks are defined by this class to avoid overlap, although bit masks are node type specific.
      See Also:
      setMask(int, boolean), getMask(int)

    • fInsertionPosition

      protected int fInsertionPosition
      Deprecated.
      This position is the position of the end of the last line separator before the closing brace starting position of the receiver.

    • MASK_FIELD_HAS_INITIALIZER

      protected static final int MASK_FIELD_HAS_INITIALIZER
      Deprecated.
      A bit mask indicating this field has an initializer expression
      See Also:
      Constant Field Values

    • MASK_FIELD_IS_VARIABLE_DECLARATOR

      protected static final int MASK_FIELD_IS_VARIABLE_DECLARATOR
      Deprecated.
      A bit mask indicating this field is a secondary variable declarator for a previous field declaration.
      See Also:
      Constant Field Values

    • MASK_FIELD_TYPE_ALTERED

      protected static final int MASK_FIELD_TYPE_ALTERED
      Deprecated.
      A bit mask indicating this field's type has been altered from its original contents in the document.
      See Also:
      Constant Field Values

    • MASK_NAME_ALTERED

      protected static final int MASK_NAME_ALTERED
      Deprecated.
      A bit mask indicating this node's name has been altered from its original contents in the document.
      See Also:
      Constant Field Values

    • MASK_HAS_BODY

      protected static final int MASK_HAS_BODY
      Deprecated.
      A bit mask indicating this node currently has a body.
      See Also:
      Constant Field Values

    • MASK_HAS_COMMENT

      protected static final int MASK_HAS_COMMENT
      Deprecated.
      A bit mask indicating this node currently has a preceding comment.
      See Also:
      Constant Field Values

    • MASK_IS_CONSTRUCTOR

      protected static final int MASK_IS_CONSTRUCTOR
      Deprecated.
      A bit mask indicating this method is a constructor.
      See Also:
      Constant Field Values

    • MASK_TYPE_IS_CLASS

      protected static final int MASK_TYPE_IS_CLASS
      Deprecated.
      A bit mask indicating this type is a class.
      See Also:
      Constant Field Values

    • MASK_TYPE_HAS_SUPERCLASS

      protected static final int MASK_TYPE_HAS_SUPERCLASS
      Deprecated.
      A bit mask indicating this type has a superclass (requires or has an 'extends' clause).
      See Also:
      Constant Field Values

    • MASK_TYPE_HAS_INTERFACES

      protected static final int MASK_TYPE_HAS_INTERFACES
      Deprecated.
      A bit mask indicating this type implements or extends some interfaces
      See Also:
      Constant Field Values

    • MASK_RETURN_TYPE_ALTERED

      protected static final int MASK_RETURN_TYPE_ALTERED
      Deprecated.
      A bit mask indicating this return type of this method has been altered from the original contents.
      See Also:
      Constant Field Values

    • MASK_DETAILED_SOURCE_INDEXES

      protected static final int MASK_DETAILED_SOURCE_INDEXES
      Deprecated.
      A bit mask indicating this node has detailed source indexes
      See Also:
      Constant Field Values

  • Method Details

    • addChild

      public void addChild​(IDOMNode child) throws IllegalArgumentException, DOMException
      Deprecated.
      Adds the given un-parented node (document fragment) as the last child of this node.

      When a child is added, this node must be considered fragmented such that the contents of this node are properly generated.

      Specified by:
      addChild in interface IDOMNode
      Parameters:
      child - the new child node
      Throws:
      IllegalArgumentException - if the child is null
      DOMException - if any of the following conditions hold:
      • this node is not allowed to have children,
      • the child is not of an allowable type
      • the child already has a parent
      • the child is an ancestor of this node
      See Also:
      IDOMNode.addChild(IDOMNode)

    • appendContents

      protected void appendContents​(CharArrayBuffer buffer)
      Deprecated.
      Appends the current contents of this document fragment to the given CharArrayBuffer.

      If this node is fragmented, contents must be generated by using the original document and indicies as a form for the current attribute values of this node. If this node not fragmented, the contents can be obtained from the document.

    • appendContentsOfChildren

      protected void appendContentsOfChildren​(CharArrayBuffer buffer)
      Deprecated.
      Appends the contents of all children of this node to the given CharArrayBuffer.

      This algorithm used minimizes String generation by merging adjacent unfragmented children into one substring operation.

    • appendFragmentedContents

      protected abstract void appendFragmentedContents​(CharArrayBuffer buffer)
      Deprecated.
      Appends the contents of this node to the given CharArrayBufer, using the original document and indicies as a form for the current attribute values of this node.

    • becomeDetailed

      protected void becomeDetailed() throws DOMException
      Deprecated.
      Generates detailed source indexes for this node if possible.
      Throws:
      DOMException - if unable to generate detailed source indexes for this node

    • canHaveChildren

      public boolean canHaveChildren()
      Deprecated.
      Returns true if this node is allowed to have children, otherwise false.

      Default implementation of IDOMNode interface method returns false; this method must be overridden by subclasses that implement nodes that allow children.

      Specified by:
      canHaveChildren in interface IDOMNode
      Returns:
      true if this node can have children
      See Also:
      IDOMNode.canHaveChildren()

    • clone

      public Object clone()
      Deprecated.
      Description copied from interface: IDOMNode
      Returns a stand-alone copy of the document fragment represented by this node that is in no way dependent on the document this node is part of.
      Specified by:
      clone in interface IDOMNode
      Overrides:
      clone in class Object
      Returns:
      a copy of type IDOMNode
      See Also:
      IDOMNode.clone()

    • fragment

      protected void fragment()
      Deprecated.
      Sets this node's fragmented flag and all ancestor fragmented flags to true. This happens when an attribute of this node or a descendant node has been altered. When a node is fragmented, its contents must be generated from its attributes and original "form" rather than from the original contents in the document.

    • getCharacters

      public char[] getCharacters()
      Deprecated.
      Description copied from interface: IDOMNode
      Returns the current contents of this document fragment as a character array.

      Note: To obtain complete source for the source file, ask a compilation unit node for its contents.

      Specified by:
      getCharacters in interface IDOMNode
      Returns:
      the contents, or null if this node has no contents
      See Also:
      IDOMNode.getCharacters()

    • getChild

      public IDOMNode getChild​(String name)
      Deprecated.
      Description copied from interface: IDOMNode
      Returns the first named child of this node with the given name.
      Specified by:
      getChild in interface IDOMNode
      Parameters:
      name - the name
      Returns:
      the child node, or null if no such child exists
      See Also:
      IDOMNode.getChild(String)

    • getChildren

      public Enumeration getChildren()
      Deprecated.
      Description copied from interface: IDOMNode
      Returns an enumeration of children of this node. Returns an empty enumeration if this node has no children (including nodes that cannot have children). Children appear in the order in which they are declared in the source code.
      Specified by:
      getChildren in interface IDOMNode
      Returns:
      an enumeration of the children
      See Also:
      IDOMNode.getChildren()

    • getContents

      public String getContents()
      Deprecated.
      Returns the current contents of this document fragment, or null if this node has no contents.

      If this node is fragmented, contents must be generated by using the original document and indicies as a form for the current attribute values of this node. If this node not fragmented, the contents can be obtained from the document.

      Specified by:
      getContents in interface IDOMNode
      Returns:
      the contents, or null if this node has no contents
      See Also:
      IDOMNode.getContents()

    • getDetailedNode

      protected DOMNode getDetailedNode()
      Deprecated.
      Returns a new document fragment representing this node with detailed source indexes. Subclasses that provide a detailed implementation must override this method.

    • getDocument

      protected char[] getDocument()
      Deprecated.
      Returns the document containing this node's original contents. The document may be shared by other nodes.

    • getEndPosition

      public int getEndPosition()
      Deprecated.
      Returns the original position of the last character of this node's contents in its document.

    • getFactory

      protected IDOMFactory getFactory()
      Deprecated.
      Returns a factory with which to create new document fragments.

    • getFirstChild

      public IDOMNode getFirstChild()
      Deprecated.
      Description copied from interface: IDOMNode
      Returns the first child of this node. Children appear in the order in which they exist in the source code.
      Specified by:
      getFirstChild in interface IDOMNode
      Returns:
      the first child, or null if this node has no children
      See Also:
      IDOMNode.getFirstChild()

    • getInsertionPosition

      public int getInsertionPosition()
      Deprecated.
      Returns the position at which the first child of this node should be inserted.

    • getMask

      protected boolean getMask​(int mask)
      Deprecated.
      Returns true if the given mask of this node's state flag is turned on, otherwise false.

    • getName

      public String getName()
      Deprecated.
      Description copied from interface: IDOMNode
      Returns the name of this node. More details are provided in each of the subtypes.
      Specified by:
      getName in interface IDOMNode
      Returns:
      the name, or null if it has no name
      See Also:
      IDOMNode.getName()

    • getNameContents

      protected char[] getNameContents()
      Deprecated.
      Returns the source code to be used for this node's name.

    • getNextNode

      public IDOMNode getNextNode()
      Deprecated.
      Description copied from interface: IDOMNode
      Returns the sibling node immediately following this node.
      Specified by:
      getNextNode in interface IDOMNode
      Returns:
      the next node, or null if there is no following node
      See Also:
      IDOMNode.getNextNode()

    • getParent

      public IDOMNode getParent()
      Deprecated.
      Description copied from interface: IDOMNode
      Returns the parent of this node.
      Specified by:
      getParent in interface IDOMNode
      Returns:
      the parent node, or null if this node does not have a parent
      See Also:
      IDOMNode.getParent()

    • getParentEndDeclaration

      protected int getParentEndDeclaration()
      Deprecated.
      Answers a source position which corresponds to the end of the parent element's declaration.

    • getPreviousNode

      public IDOMNode getPreviousNode()
      Deprecated.
      Description copied from interface: IDOMNode
      Returns the sibling node immediately preceding this node.
      Specified by:
      getPreviousNode in interface IDOMNode
      Returns:
      the previous node, or null if there is no preceding node
      See Also:
      IDOMNode.getPreviousNode()

    • getRoot

      protected IDOMNode getRoot()
      Deprecated.
      Returns the root node of this document fragment.

    • getStartPosition

      public int getStartPosition()
      Deprecated.
      Returns the original position of the first character of this node's contents in its document.

    • insertSibling

      public void insertSibling​(IDOMNode sibling) throws IllegalArgumentException, DOMException
      Deprecated.
      Description copied from interface: IDOMNode
      Inserts the given un-parented node as a sibling of this node, immediately before this node.
      Specified by:
      insertSibling in interface IDOMNode
      Parameters:
      sibling - the new sibling node
      Throws:
      IllegalArgumentException - if the sibling is null
      DOMException - if any of the following conditions hold:
      • this node is a document fragment root
      • the sibling is not of the correct type
      • the sibling already has a parent
      • this sibling is an ancestor of this node
      See Also:
      IDOMNode.insertSibling(IDOMNode)

    • isAllowableChild

      public boolean isAllowableChild​(IDOMNode node)
      Deprecated.
      Description copied from interface: IDOMNode
      Returns whether the given node is an allowable child for this node.
      Specified by:
      isAllowableChild in interface IDOMNode
      Parameters:
      node - the potential child node
      Returns:
      true if the given node is an allowable child
      See Also:
      IDOMNode

    • isContentMergableWith

      protected boolean isContentMergableWith​(DOMNode node)
      Deprecated.
      Returns true if the contents of this node are from the same document as the given node, the contents of this node immediately follow the contents of the given node, and neither this node or the given node are fragmented - otherwise false.

    • isDetailed

      protected boolean isDetailed()
      Deprecated.
      Returns true if this node has detailed source index information, or false if this node has limited source index information. To perform some manipulations, detailed indexes are required.

    • isFragmented

      protected boolean isFragmented()
      Deprecated.
      Returns true if this node's or a descendant node's contents have been altered since this node was created. This indicates that the contents of this node are no longer consistent with the contents of this node's document.

    • isNameAltered

      protected boolean isNameAltered()
      Deprecated.
      Returns true if this noed's name has been altered from the original document contents.

    • isSignatureEqual

      public boolean isSignatureEqual​(IDOMNode node)
      Deprecated.
      Description copied from interface: IDOMNode
      Returns whether this node's signature is equivalent to the given node's signature. In other words, if the nodes were siblings, would the declarations collide because they represent the same declaration.
      Specified by:
      isSignatureEqual in interface IDOMNode
      Parameters:
      node - the other node
      Returns:
      true if the nodes have equivalent signatures
      See Also:
      By default, the signatures of two nodes are equal if their type and names are equal. Node types that have other requirements for equality must override this method.

    • localizeContents

      protected void localizeContents()
      Deprecated.
      Localizes the contents of this node and all descendant nodes, such that this node is no longer dependent on its original document in order to generate its contents. This node and all descendant nodes become unfragmented and share a new document.

    • newDOMNode

      protected abstract DOMNode newDOMNode()
      Deprecated.
      Returns a new empty DOMNode for this instance.

    • offset

      protected void offset​(int offset)
      Deprecated.
      Offsets all the source indexes in this node by the given amount.

    • offsetRange

      protected void offsetRange​(int[] range, int offset)
      Deprecated.
      Offsets the source range by the given amount

    • rangeCopy

      protected int[] rangeCopy​(int[] range)
      Deprecated.
      Returns a copy of the given range.

    • remove

      public void remove()
      Deprecated.
      Separates this node from its parent and siblings, maintaining any ties that this node has to the underlying document fragment.

      When a child is removed, its parent is fragmented such that it properly generates its contents.

      Specified by:
      remove in interface IDOMNode
      See Also:
      IDOMNode.remove()

    • setMask

      protected void setMask​(int mask, boolean on)
      Deprecated.
      Sets the specified mask of this node's state mask on or off based on the boolean value - true -> on, false -> off.

    • setName

      public void setName​(String name)
      Deprecated.
      Description copied from interface: IDOMNode
      Sets the name of this node. Name format depends on node type. More details are provided in each of the subtypes.
      Specified by:
      setName in interface IDOMNode
      Parameters:
      name - the name, or null to clear the name
      See Also:
      IDOMNode.setName(java.lang.String)

    • setNameAltered

      protected void setNameAltered​(boolean altered)
      Deprecated.
      Sets the state of this node as having its name attribute altered from the original document contents.

    • setSourceRangeEnd

      protected void setSourceRangeEnd​(int end)
      Deprecated.
      Sets the original position of the last character of this node's contents in its document. This method is only used during DOM creation while normalizing the source range of each node.

    • setStartPosition

      protected void setStartPosition​(int start)
      Deprecated.
      Sets the original position of the first character of this node's contents in its document. This method is only used during DOM creation while normalizing the source range of each node.

    • shareContents

      protected void shareContents​(DOMNode node)
      Deprecated.
      Sets the contents of this node and descendant nodes to be the (identical) contents of the given node and its descendants. This does not effect this node's parent and sibling configuration, only the contents of this node. This is used only to localize the contents of this node.

    • toString

      public abstract String toString()
      Deprecated.
      Returns a String representing this node - for Debug purposes only.
      Overrides:
      toString in class Object