org.apache.axis2.saaj.TextImplEx Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of axis2-saaj Show documentation
Show all versions of axis2-saaj Show documentation
Axis2 SAAJ implementation
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.axis2.saaj;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMNode;
import org.w3c.dom.DOMException;
import javax.xml.soap.Text;
public class TextImplEx extends NodeImpl implements Text {
public TextImplEx(String data) {
this(OMAbstractFactory.getMetaFactory(OMAbstractFactory.FEATURE_DOM).getOMFactory().createOMText(data));
}
public TextImplEx(OMNode textNode) {
super((org.w3c.dom.CharacterData)textNode, textNode);
}
/**
* Retrieves whether this Text object represents a comment.
*
* @return true if this Text object is a comment; false
* otherwise
*/
public boolean isComment() {
String value = target.getData();
return value.startsWith("");
}
/**
* Breaks this node into two nodes at the specified offset, keeping both in the
* tree as siblings. After being split, this node will contain all the content up to the
* offset point. A new node of the same type, which contains all the content at and
* after the offset point, is returned. If the original node had a parent node, the
* new node is inserted as the next sibling of the original node. When the offset
* is equal to the length of this node, the new node has no data.
*
* @param offset The 16-bit unit offset at which to split, starting from 0.
* @return The new node, of the same type as this node.
* @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.
*/
public org.w3c.dom.Text splitText(int offset) throws DOMException {
return ((Text)target).splitText(offset);
}
public boolean isElementContentWhitespace() {
// TODO - Fixme.
throw new UnsupportedOperationException("TODO");
}
public String getWholeText() {
// TODO - Fixme.
throw new UnsupportedOperationException("TODO");
}
public org.w3c.dom.Text replaceWholeText(String content) throws DOMException {
// TODO - Fixme.
throw new UnsupportedOperationException("TODO");
}
/**
* 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.
*
* @throws DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
* @throws DOMException DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit
* in a DOMString variable on the implementation platform.
*/
public String getData() throws DOMException {
return target.getData();
}
/**
* 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.
*
* @throws DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
* @throws DOMException DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit
* in a DOMString variable on the implementation platform.
*/
public void setData(String data) throws DOMException {
target.setData(data);
}
/**
* Extracts a range of data from the node.
*
* @param offset Start offset of substring to extract.
* @param count The number of 16-bit units to extract.
* @return 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.
*/
public String substringData(int offset, int count) throws DOMException {
return target.substringData(offset, count);
}
/**
* 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.
*
* @param value The DOMString to append.
* @throws DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*/
public void appendData(String value) throws DOMException {
target.appendData(value);
}
/**
* Insert a string at the specified 16-bit unit offset.
*
* @param offset The character offset at which to insert.
* @param data 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.
*/
public void insertData(int offset, String data) throws DOMException {
target.insertData(offset, data);
}
/**
* Remove a range of 16-bit units from the node. Upon success, data and
* length reflect the change.
*
* @param offset The offset from which to start removing.
* @param 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.
*/
public void deleteData(int offset, int count) throws DOMException {
target.deleteData(offset, count);
}
/**
* Replace the characters starting at the specified 16-bit unit offset with the specified
* string.
*
* @param offset The offset from which to start replacing.
* @param 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).
* @param data 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.
*/
public void replaceData(int offset, int count, String data) throws DOMException {
target.replaceData(offset, count, data);
}
/**
* Retrieve the text value (data) of this
*
* @return The text value (data) of this
*/
public String getValue() {
return target.getData();
}
/**
* If this is a Text node then this method will set its value, otherwise it sets the value of
* the immediate (Text) child of this node. The value of the immediate child of this node can be
* set only if, there is one child node and that node is a Text node, or if there are no
* children in which case a child Text node will be created.
*
* @param value the text to set
* @throws IllegalStateException if the node is not a Text node and either has more than one
* child node or has a child node that is not a Text node
*/
public void setValue(String value) {
target.setData(value);
}
public String toString() {
return getValue();
}
public int getLength() {
return target.getLength();
}
}