You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commons-dev@ws.apache.org by ve...@apache.org on 2008/12/07 22:43:28 UTC
svn commit: r724209 -
/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
Author: veithen
Date: Sun Dec 7 13:43:28 2008
New Revision: 724209
URL: http://svn.apache.org/viewvc?rev=724209&view=rev
Log:
WSCOMMONS-239: Completed the Javadoc of the OMElement#getText method (based on the behavior of the LLOM and DOM implementations).
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java?rev=724209&r1=724208&r2=724209&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/OMElement.java Sun Dec 7 13:43:28 2008
@@ -245,9 +245,17 @@
void setText(QName text);
/**
- * Returns the non-empty text children as a String.
+ * Returns the non-empty text children as a string.
+ * <p>
+ * This method iterates over all the text children of the element and concatenates
+ * them to a single string. Only direct children will be considered, i.e. the text
+ * is not extracted recursively. For example the return value for
+ * <tt><element>A<child>B</child>C</element></tt> will be <tt>AC</tt>.
+ * <p>
+ * All whitespace will be preserved.
*
- * @return Returns a String representing the concatenation of the child text nodes.
+ * @return A string representing the concatenation of the child text nodes.
+ * If there are no child text nodes, an empty string is returned.
*/
String getText();