Changeset 175 for trunk/JavaHelperLib/src/de/ugoe/cs/util/StringTools.java

Timestamp:

09/09/11 23:52:51 (13 years ago)

Author:

sherbold

Message:

• code documentation and formatting

File:

• trunk/JavaHelperLib/src/de/ugoe/cs/util/StringTools.java (modified) (1 diff)

trunk/JavaHelperLib/src/de/ugoe/cs/util/StringTools.java

@@ -1 +1 @@
 package de.ugoe.cs.util;
 
+/**
+ * <p>
+ * Helper class that provides methods to simplify working with {@link String}s.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ * @version 1.0
+ */
 final public class StringTools {
 
-        public final static String ENDLINE = System.getProperty("line.separator");
-        
         /**
          * <p>
-         * Replaces all occurences of {@literal &, <, >, ', and "} with their
-         * respective XML entites {@literal &amp;, &lt;, &gt;, &apos;, and &quot;}
+         * Simplifies use of operation system specific line separators.
+         * </p>
+         */
+        public final static String ENDLINE = System.getProperty("line.separator");
+
+        /**
+         * <p>
+         * Replaces all occurrences of {@literal &, <, >, ', and "} with their
+         * respective XML entities {@literal &amp;, &lt;, &gt;, &apos;, and &quot;}
          * without destroying already existing entities.
          * </p>
          * 
          * @param str
-         *            String where the XML entites are to be replaced
-         * @return new String, where the XML entites are used instead of the
+         *            String where the XML entities are to be replaced
+         * @return new String, where the XML entities are used instead of the
          *         literals
          */