Package org.apache.harmony.xml.dom

Class CharacterDataImpl

java.lang.Object
org.apache.harmony.xml.dom.NodeImpl
org.apache.harmony.xml.dom.LeafNodeImpl
org.apache.harmony.xml.dom.CharacterDataImpl
All Implemented Interfaces:
CharacterData, Node
Direct Known Subclasses:
CommentImpl, TextImpl
public abstract class CharacterDataImpl
extends LeafNodeImpl
implements CharacterData
Provides a straightforward implementation of the corresponding W3C DOM interface. The class is used internally only, thus only notable members that are not in the original interface are documented (the W3C docs are quite extensive). Hope that's ok.

Some of the fields may have package visibility, so other classes belonging to the DOM implementation can easily access them while maintaining the DOM tree structure.

  • Field Details

  • Method Details

    • appendData

      public void appendData​(String arg) throws DOMException
      Description copied from interface: CharacterData
      Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the DOMString specified.
      Specified by:
      appendData in interface CharacterData
      Parameters:
      arg - The DOMString to append.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

    • deleteData

      public void deleteData​(int offset, int count) throws DOMException
      Description copied from interface: CharacterData
      Remove a range of 16-bit units from the node. Upon success, data and length reflect the change.
      Specified by:
      deleteData in interface CharacterData
      Parameters:
      offset - The offset from which to start removing.
      count - The number of 16-bit units to delete. If the sum of offset and count exceeds length then all 16-bit units from offset to the end of the data are deleted.
      Throws:
      DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
      NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

    • getData

      public String getData() throws DOMException
      Description copied from interface: CharacterData
      The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.
      Specified by:
      getData in interface CharacterData
      Throws:
      DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

    • appendDataTo

      public void appendDataTo​(StringBuilder stringBuilder)
      Appends this node's text content to the given builder.

    • getLength

      public int getLength()
      Description copied from interface: CharacterData
      The number of 16-bit units that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.
      Specified by:
      getLength in interface CharacterData

    • getNodeValue

      public String getNodeValue()
      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, including if the node is read-only.
      Specified by:
      getNodeValue in interface Node
      Overrides:
      getNodeValue in class NodeImpl

    • insertData

      public void insertData​(int offset, String arg) throws DOMException
      Description copied from interface: CharacterData
      Insert a string at the specified 16-bit unit offset.
      Specified by:
      insertData in interface CharacterData
      Parameters:
      offset - The character offset at which to insert.
      arg - The DOMString to insert.
      Throws:
      DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data.
      NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

    • replaceData

      public void replaceData​(int offset, int count, String arg) throws DOMException
      Description copied from interface: CharacterData
      Replace the characters starting at the specified 16-bit unit offset with the specified string.
      Specified by:
      replaceData in interface CharacterData
      Parameters:
      offset - The offset from which to start replacing.
      count - The number of 16-bit units to replace. If the sum of offset and count exceeds length, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as a remove method call with the same range, followed by an append method invocation).
      arg - The DOMString with which the range must be replaced.
      Throws:
      DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
      NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

    • setData

      public void setData​(String data) throws DOMException
      Description copied from interface: CharacterData
      The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.
      Specified by:
      setData in interface CharacterData
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

    • substringData

      public String substringData​(int offset, int count) throws DOMException
      Description copied from interface: CharacterData
      Extracts a range of data from the node.
      Specified by:
      substringData in interface CharacterData
      Parameters:
      offset - Start offset of substring to extract.
      count - The number of 16-bit units to extract.
      Returns:
      The specified substring. If the sum of offset and count exceeds the length, then all 16-bit units to the end of the data are returned.
      Throws:
      DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
      DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString.