com.gargoylesoftware.htmlunit.html.DomCharacterData Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of htmlunit Show documentation
Show all versions of htmlunit Show documentation
A headless browser intended for use in testing web-based applications.
/*
* Copyright (c) 2002-2011 Gargoyle Software Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.gargoylesoftware.htmlunit.html;
import org.w3c.dom.CharacterData;
import com.gargoylesoftware.htmlunit.SgmlPage;
/**
* Wrapper for the DOM node CharacterData.
*
* @version $Revision: 6204 $
* @author David K. Taylor
* @author Christian Sell
* @author Ahmed Ashour
* @author Philip Graf
*/
public abstract class DomCharacterData extends DomNode implements CharacterData {
/** The data string. */
private String data_;
/**
* Creates an instance of DomCharacterData.
*
* @param page the Page that contains this element
* @param data the data string wrapped by this node
*/
public DomCharacterData(final SgmlPage page, final String data) {
super(page);
data_ = data;
}
/**
* Gets the data character string for this character data node.
* @return the data character string
*/
public String getData() {
return data_;
}
/**
* Sets the data character string for this character data node.
* @param data the new data character string
*/
public void setData(final String data) {
data_ = data;
}
/**
* Sets the data character string to the new string.
* @param newValue the new string of data
*/
@Override
public void setNodeValue(final String newValue) {
data_ = newValue;
}
/**
* {@inheritDoc}
*/
@Override
public void setTextContent(final String textContent) {
data_ = textContent;
}
/**
* Returns the number of characters in the character data.
* @return the number of characters
*/
public int getLength() {
return data_.length();
}
/**
* Appends a string to character data.
* @param newData the string to be appended to the character data
*/
public void appendData(final String newData) {
data_ += newData;
}
/**
* Deletes characters from character data.
* @param offset the position of the first character to be deleted
* @param count the number of characters to be deleted
*/
public void deleteData(final int offset, final int count) {
if (offset < 0 || count < 0) {
throw new IllegalArgumentException("offset: " + offset + " count: " + count);
}
final int tailLength = Math.max(data_.length() - count - offset, 0);
if (tailLength > 0) {
data_ = data_.substring(0, offset) + data_.substring(offset + count, offset + count + tailLength);
}
else {
data_ = "";
}
}
/**
* Inserts a string into character data.
* @param offset the position within the first character at which the string is to be inserted
* @param arg the string to insert
*/
public void insertData(final int offset, final String arg) {
data_ = new StringBuilder(data_).insert(offset, arg).toString();
}
/**
* Replaces characters of character data with a string.
* @param offset the position within the first character at which the string is to be replaced
* @param count the number of characters to be replaced
* @param arg the string that replaces the count characters beginning at the character at offset
*/
public void replaceData(final int offset, final int count, final String arg) {
deleteData(offset, count);
insertData(offset, arg);
}
/**
* Extracts a substring from character data.
* @param offset the position of the first character to be extracted
* @param count the number of characters to be extracted
* @return a string that consists of the count characters of the character data starting
* from the character at position offset
*/
public String substringData(final int offset, final int count) {
final int length = data_.length();
if (count < 0 || offset < 0 || offset > length - 1) {
throw new IllegalArgumentException("offset: " + offset + " count: " + count);
}
final int tailIndex = Math.min(offset + count, length);
return data_.substring(offset, tailIndex);
}
/**
* {@inheritDoc}
* @return the string data held by this node
*/
@Override
public String getNodeValue() {
return data_;
}
/**
* {@inheritDoc}
*/
@Override
public String getCanonicalXPath() {
return getParentNode().getCanonicalXPath() + '/' + getXPathToken();
}
/**
* Returns the XPath token for this node only.
*/
private String getXPathToken() {
final DomNode parent = getParentNode();
// If there are other siblings of the same node type, we have to provide
// the node's index.
int siblingsOfSameType = 0;
int nodeIndex = 0;
for (final DomNode child : parent.getChildren()) {
if (child == this) {
nodeIndex = ++siblingsOfSameType;
if (nodeIndex > 1) {
// Optimization: if the node index is greater than 1, there
// are at least two nodes of the same type.
break;
}
}
else if (child.getNodeType() == getNodeType()) {
siblingsOfSameType++;
if (nodeIndex > 0) {
// Optimization: if the node index is greater than 0, there
// are at least two nodes of the same type.
break;
}
}
}
final String nodeName = getNodeName().substring(1) + "()";
if (siblingsOfSameType == 1) {
return nodeName;
}
return nodeName + '[' + nodeIndex + ']';
}
}