summaryrefslogtreecommitdiff
path: root/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/TextNodeIterator.java
diff options
context:
space:
mode:
authorrbuj <robert.buj@gmail.com>2014-09-04 15:58:32 +0200
committerNoel Grandin <noelgrandin@gmail.com>2014-09-04 09:08:09 -0500
commita5a9457609e8bbe76a8c6d620b81b8666c2e4491 (patch)
tree9651dc29fa39243b87b0ffc79b20b6d5305f0a42 /xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/TextNodeIterator.java
parent8e4dc1d760d85e09bbc3f3bbb5b8be2947db1b63 (diff)
xmerge: javadoc maintenance and minor code formatting
Javadoc: * Replaces <code>..</code> tags with {@code ..}. * Replaces HTML entities with {@literal ..} * Removes <p>..</p> tags in the first sentence. * Reduces code snippet spacing. * Adds tables. * Uses only one space after a comment delimiter. * Adjusts the margins. Minor code formating: * Removes some extra blank lines (very few). * Fixes some indentations (very few). * Adjusts the margins in some method headers (very few). Change-Id: I01bd9df58e4cb41bc3a38a2b2d3d7d2612081c32 Reviewed-on: https://gerrit.libreoffice.org/11202 Reviewed-by: Noel Grandin <noelgrandin@gmail.com> Tested-by: Noel Grandin <noelgrandin@gmail.com>
Diffstat (limited to 'xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/TextNodeIterator.java')
-rw-r--r--xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/TextNodeIterator.java40
1 files changed, 19 insertions, 21 deletions
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/TextNodeIterator.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/TextNodeIterator.java
index 791122c398dc..fa7c6086c36b 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/TextNodeIterator.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/TextNodeIterator.java
@@ -22,43 +22,42 @@ import org.w3c.dom.Node;
import org.openoffice.xmerge.converter.xml.OfficeConstants;
-
/**
- * <p>This is an implementation of the <code>Iterator</code> interface.
- * It will traverse the tree and find text/space/tab <code>Node</code>
- * sequences.</p>
+ * This is an implementation of the {@code Iterator} interface.
+ *
+ * <p>It will traverse the tree and find text/space/tab {@code Node} sequences.
+ * </p>
*
- * <p>Note: Once the XML Tree is parsed, then the <code>Iterator</code>
- * will be a snap shot of that tree. That means even the tree is modified
- * later, than the cached paragraph <code>Node</code> list will not be
- * updated accordingly. For this reason and for performance reasons
- * this <code>Iterator</code> does not support any operation methods
- * such as insert, remove or replace. The main purpose of this
- * <code>Iterator</code> is to be used with difference, not with merge.</p>
+ * <p>Note: Once the XML Tree is parsed, then the {@code Iterator} will be a
+ * snap shot of that tree. That means even the tree is modified later, than the
+ * cached paragraph {@code Node} list will not be updated accordingly. For this
+ * reason and for performance reasons this {@code Iterator} does not support
+ * any operation methods such as insert, remove or replace. The main purpose of
+ * this {@code Iterator} is to be used with difference, not with merge.</p>
*/
public final class TextNodeIterator extends NodeIterator {
/**
- * Standard constructor.
+ * Standard constructor.
*
- * @param node The initial root <code>Node</code>.
+ * @param node The initial root {@code Node}.
*/
public TextNodeIterator(Node node) {
super(null, node);
}
/**
- * Overwrite the parent <code>nodeSupported</code> method. Only text
- * <code>Node</code> objects are supported.
+ * Overwrite the parent {@code nodeSupported} method.
+ *
+ * <p>Only text {@code Node} objects are supported.</p>
*
- * @param node <code>Node</code> to check.
+ * @param node {@code Node} to check.
*
- * @return true if the <code>Node</code> is supported, false
- * otherwise.
+ * @return {@code true} if the {@code Node} is supported, {@code false}
+ * otherwise.
*/
@Override
protected boolean nodeSupported(Node node) {
-
// can use an array later to check all possible tags for
// future expansion
return node.getNodeType() == Node.TEXT_NODE ||
@@ -66,5 +65,4 @@ public final class TextNodeIterator extends NodeIterator {
node.getNodeName().equals(OfficeConstants.TAG_TAB_STOP) ||
node.getNodeName().equals(OfficeConstants.TAG_LINE_BREAK);
}
-}
-
+} \ No newline at end of file