commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chtom...@apache.org
Subject [text] TEXT-33: Consolidating since tags at 1.0, removing deprecated methods
Date Sat, 17 Dec 2016 15:34:37 GMT
Repository: commons-text
Updated Branches:
  refs/heads/master 2b0a1ebd8 -> 9d5e6d891


TEXT-33: Consolidating since tags at 1.0, removing deprecated methods


Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/9d5e6d89
Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/9d5e6d89
Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/9d5e6d89

Branch: refs/heads/master
Commit: 9d5e6d8914a9bef5accb422880166daccf8c5125
Parents: 2b0a1eb
Author: Rob Tompkins <chtompki@gmail.com>
Authored: Sat Dec 17 10:21:15 2016 -0500
Committer: Rob Tompkins <chtompki@gmail.com>
Committed: Sat Dec 17 10:26:32 2016 -0500

----------------------------------------------------------------------
 src/changes/changes.xml                         |   1 +
 .../apache/commons/text/AlphabetConverter.java  |   3 +-
 .../java/org/apache/commons/text/Builder.java   |   1 +
 .../apache/commons/text/CompositeFormat.java    |   2 +
 .../commons/text/ExtendedMessageFormat.java     |   2 +
 .../org/apache/commons/text/FormatFactory.java  |   2 +
 .../apache/commons/text/FormattableUtils.java   |   2 +
 .../org/apache/commons/text/StrBuilder.java     |  42 +------
 .../java/org/apache/commons/text/StrLookup.java |   2 +
 .../org/apache/commons/text/StrMatcher.java     |   3 +-
 .../org/apache/commons/text/StrSubstitutor.java |  18 +--
 .../org/apache/commons/text/StrTokenizer.java   |   2 +
 .../apache/commons/text/StringEscapeUtils.java  | 119 ++-----------------
 .../java/org/apache/commons/text/WordUtils.java |   8 +-
 .../commons/text/diff/CommandVisitor.java       |   1 +
 .../apache/commons/text/diff/DeleteCommand.java |   1 +
 .../apache/commons/text/diff/EditCommand.java   |   1 +
 .../apache/commons/text/diff/EditScript.java    |   1 +
 .../apache/commons/text/diff/InsertCommand.java |   1 +
 .../apache/commons/text/diff/KeepCommand.java   |   1 +
 .../commons/text/diff/ReplacementsFinder.java   |   1 +
 .../commons/text/diff/ReplacementsHandler.java  |   1 +
 .../commons/text/diff/StringsComparator.java    |   1 +
 .../commons/text/similarity/CosineDistance.java |   3 +
 .../text/similarity/CosineSimilarity.java       |   2 +
 .../apache/commons/text/similarity/Counter.java |   2 +
 .../commons/text/similarity/EditDistance.java   |   1 +
 .../text/similarity/EditDistanceFrom.java       |   1 +
 .../commons/text/similarity/FuzzyScore.java     |   2 +
 .../text/similarity/HammingDistance.java        |   2 +
 .../text/similarity/JaccardDistance.java        |   2 +
 .../text/similarity/JaccardSimilarity.java      |   2 +
 .../text/similarity/JaroWinklerDistance.java    |   2 +
 .../similarity/LevenshteinDetailedDistance.java |   2 +
 .../text/similarity/LevenshteinDistance.java    |   2 +
 .../commons/text/similarity/RegexTokenizer.java |   2 +
 .../text/similarity/SimilarityScore.java        |   1 +
 .../text/similarity/SimilarityScoreFrom.java    |   1 +
 .../commons/text/similarity/Tokenizer.java      |   1 +
 .../text/translate/AggregateTranslator.java     |   2 +
 .../text/translate/CharSequenceTranslator.java  |   2 +
 .../text/translate/CodePointTranslator.java     |   2 +
 .../commons/text/translate/EntityArrays.java    |   2 +
 .../text/translate/JavaUnicodeEscaper.java      |   2 +
 .../text/translate/LookupTranslator.java        |   2 +
 .../text/translate/NumericEntityEscaper.java    |   2 +
 .../text/translate/NumericEntityUnescaper.java  |   2 +
 .../commons/text/translate/OctalUnescaper.java  |   2 +
 .../commons/text/translate/UnicodeEscaper.java  |   3 +-
 .../text/translate/UnicodeUnescaper.java        |   2 +
 .../UnicodeUnpairedSurrogateRemover.java        |   2 +
 .../commons/text/translate/package-info.java    |   2 +
 .../commons/text/StringEscapeUtilsTest.java     |  94 ---------------
 53 files changed, 100 insertions(+), 265 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 9837894..cabf16e 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -22,6 +22,7 @@
   <body>
 
   <release version="1.0" date="tba" description="tba">
+    <action issue="TEXT-33" type="update" dev="chtompki">Consolidating since tags at 1.0, removing deprecated methods</action>
     <action issue="TEXT-29" type="add" dev="chtompki">Add a builder to StringEscapeUtils</action>
     <action issue="TEXT-28" type="add" dev="chtompki">Add shell/XSI escape/unescape support</action>
     <action issue="TEXT-22" type="fix" dev="chtompki">LevenshteinDistance reduce memory consumption</action>

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/AlphabetConverter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/AlphabetConverter.java b/src/main/java/org/apache/commons/text/AlphabetConverter.java
index 0979bec..8823c47 100644
--- a/src/main/java/org/apache/commons/text/AlphabetConverter.java
+++ b/src/main/java/org/apache/commons/text/AlphabetConverter.java
@@ -62,7 +62,8 @@ import java.util.Set;
  * #ThreadSafe# AlphabetConverter class methods are threadsafe as they do not change internal state.
  * </p>
  *
- * @since 0.1
+ * @since 1.0
+ *
  */
 public final class AlphabetConverter {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/Builder.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/Builder.java b/src/main/java/org/apache/commons/text/Builder.java
index 8d9a34d..4b46a35 100644
--- a/src/main/java/org/apache/commons/text/Builder.java
+++ b/src/main/java/org/apache/commons/text/Builder.java
@@ -73,6 +73,7 @@ package org.apache.commons.text;
  *
  *
  * @param <T> the type of object that the builder will construct or compute.
+ * @since 1.0
  *
  */
 public interface Builder<T> {

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/CompositeFormat.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/CompositeFormat.java b/src/main/java/org/apache/commons/text/CompositeFormat.java
index 6239561..3cbeebd 100644
--- a/src/main/java/org/apache/commons/text/CompositeFormat.java
+++ b/src/main/java/org/apache/commons/text/CompositeFormat.java
@@ -25,6 +25,8 @@ import java.text.ParsePosition;
  * Formats using one formatter and parses using a different formatter. An
  * example of use for this would be a webapp where data is taken in one way and
  * stored in a database another way.
+ *
+ * @since 1.0
  */
 public class CompositeFormat extends Format {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
index c88752a..617018f 100644
--- a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
@@ -62,6 +62,8 @@ import java.util.Objects;
  * <li>Thread-safety of <code>Format</code>s, including <code>MessageFormat</code> and thus
  *     <code>ExtendedMessageFormat</code>, is not guaranteed.</li>
  * </ul>
+ *
+ * @since 1.0
  */
 public class ExtendedMessageFormat extends MessageFormat {
     private static final long serialVersionUID = -2362048321261811743L;

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/FormatFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/FormatFactory.java b/src/main/java/org/apache/commons/text/FormatFactory.java
index 1f85b0f..dc3d05f 100644
--- a/src/main/java/org/apache/commons/text/FormatFactory.java
+++ b/src/main/java/org/apache/commons/text/FormatFactory.java
@@ -21,6 +21,8 @@ import java.util.Locale;
 
 /**
  * Format factory.
+ *
+ * @since 1.0
  */
 public interface FormatFactory {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/FormattableUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/FormattableUtils.java b/src/main/java/org/apache/commons/text/FormattableUtils.java
index 887f593..4ebf72c 100644
--- a/src/main/java/org/apache/commons/text/FormattableUtils.java
+++ b/src/main/java/org/apache/commons/text/FormattableUtils.java
@@ -28,6 +28,8 @@ import static java.util.FormattableFlags.LEFT_JUSTIFY;
  * when using a {@code Formatter}. It is primarily concerned with numeric precision
  * and padding, and is not designed to allow generalised alternate formats.</p>
  *
+ * @since 1.0
+ *
  */
 public class FormattableUtils {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/StrBuilder.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/StrBuilder.java b/src/main/java/org/apache/commons/text/StrBuilder.java
index 8221e07..daf15b2 100644
--- a/src/main/java/org/apache/commons/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/text/StrBuilder.java
@@ -64,6 +64,8 @@ import java.util.Objects;
  * 'null'. This can be controlled by a property, {@link #setNullText(String)}.
  * </p>
  *
+ * @since 1.0
+ *
  */
 public class StrBuilder implements CharSequence, Appendable, Serializable, Builder<String> {
 
@@ -423,7 +425,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @return the number of characters read
      * @throws IOException if an I/O error occurs
      *
-     * @since 3.4
      * @see #appendTo(Appendable)
      */
     public int readFrom(final Readable readable) throws IOException {
@@ -509,7 +510,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param seq  the CharSequence to append
      * @return this, to enable chaining
-     * @since 3.0
      */
     @Override
     public StrBuilder append(final CharSequence seq) {
@@ -539,7 +539,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param startIndex  the start index, inclusive, must be valid
      * @param length  the length to append, must be valid
      * @return this, to enable chaining
-     * @since 3.0
      */
     @Override
     public StrBuilder append(final CharSequence seq, final int startIndex, final int length) {
@@ -606,7 +605,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param objs the objects to use in the format string
      * @return {@code this} to enable chaining
      * @see String#format(String, Object...)
-     * @since 3.2
      */
     public StrBuilder append(final String format, final Object... objs) {
         return append(String.format(format, objs));
@@ -618,7 +616,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param buf  the char buffer to append
      * @return this, to enable chaining
-     * @since 3.4
      */
     public StrBuilder append(final CharBuffer buf) {
         if (buf == null) {
@@ -644,7 +641,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param startIndex  the start index, inclusive, must be valid
      * @param length  the length to append, must be valid
      * @return this, to enable chaining
-     * @since 3.4
      */
     public StrBuilder append(final CharBuffer buf, final int startIndex, final int length) {
         if (buf == null) {
@@ -723,7 +719,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param str the StringBuilder to append
      * @return this, to enable chaining
-     * @since 3.2
      */
     public StrBuilder append(final StringBuilder str) {
         if (str == null) {
@@ -747,7 +742,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param startIndex the start index, inclusive, must be valid
      * @param length the length to append, must be valid
      * @return this, to enable chaining
-     * @since 3.2
      */
     public StrBuilder append(final StringBuilder str, final int startIndex, final int length) {
         if (str == null) {
@@ -895,7 +889,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param ch  the value to append
      * @return this, to enable chaining
-     * @since 3.0
      */
     @Override
     public StrBuilder append(final char ch) {
@@ -952,7 +945,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param obj  the object to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final Object obj) {
         return append(obj).appendNewLine();
@@ -964,7 +956,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param str  the string to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final String str) {
         return append(str).appendNewLine();
@@ -978,7 +969,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param startIndex  the start index, inclusive, must be valid
      * @param length  the length to append, must be valid
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final String str, final int startIndex, final int length) {
         return append(str, startIndex, length).appendNewLine();
@@ -991,7 +981,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param objs the objects to use in the format string
      * @return {@code this} to enable chaining
      * @see String#format(String, Object...)
-     * @since 3.2
      */
     public StrBuilder appendln(final String format, final Object... objs) {
         return append(format, objs).appendNewLine();
@@ -1003,7 +992,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param str  the string buffer to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final StringBuffer str) {
         return append(str).appendNewLine();
@@ -1015,7 +1003,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param str  the string builder to append
      * @return this, to enable chaining
-     * @since 3.2
      */
     public StrBuilder appendln(final StringBuilder str) {
         return append(str).appendNewLine();
@@ -1029,7 +1016,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param startIndex  the start index, inclusive, must be valid
      * @param length  the length to append, must be valid
      * @return this, to enable chaining
-     * @since 3.2
      */
     public StrBuilder appendln(final StringBuilder str, final int startIndex, final int length) {
         return append(str, startIndex, length).appendNewLine();
@@ -1043,7 +1029,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param startIndex  the start index, inclusive, must be valid
      * @param length  the length to append, must be valid
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final StringBuffer str, final int startIndex, final int length) {
         return append(str, startIndex, length).appendNewLine();
@@ -1055,7 +1040,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param str  the string builder to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final StrBuilder str) {
         return append(str).appendNewLine();
@@ -1069,7 +1053,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param startIndex  the start index, inclusive, must be valid
      * @param length  the length to append, must be valid
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final StrBuilder str, final int startIndex, final int length) {
         return append(str, startIndex, length).appendNewLine();
@@ -1081,7 +1064,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param chars  the char array to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final char[] chars) {
         return append(chars).appendNewLine();
@@ -1095,7 +1077,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param startIndex  the start index, inclusive, must be valid
      * @param length  the length to append, must be valid
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final char[] chars, final int startIndex, final int length) {
         return append(chars, startIndex, length).appendNewLine();
@@ -1106,7 +1087,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param value  the value to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final boolean value) {
         return append(value).appendNewLine();
@@ -1117,7 +1097,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param ch  the value to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final char ch) {
         return append(ch).appendNewLine();
@@ -1128,7 +1107,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param value  the value to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final int value) {
         return append(value).appendNewLine();
@@ -1139,7 +1117,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param value  the value to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final long value) {
         return append(value).appendNewLine();
@@ -1150,7 +1127,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param value  the value to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final float value) {
         return append(value).appendNewLine();
@@ -1161,7 +1137,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param value  the value to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendln(final double value) {
         return append(value).appendNewLine();
@@ -1176,7 +1151,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param <T>  the element type
      * @param array  the array to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public <T> StrBuilder appendAll(final T... array) {
         if (array != null && array.length > 0) {
@@ -1194,7 +1168,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param iterable  the iterable to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendAll(final Iterable<?> iterable) {
         if (iterable != null) {
@@ -1212,7 +1185,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param it  the iterator to append
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendAll(final Iterator<?> it) {
         if (it != null) {
@@ -1312,7 +1284,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param separator  the separator to use, null means no separator
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendSeparator(final String separator) {
         return appendSeparator(separator, null);
@@ -1343,7 +1314,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param standard the separator if builder is not empty, null means no separator
      * @param defaultIfEmpty the separator if builder is empty, null means no separator
      * @return this, to enable chaining
-     * @since 2.5
      */
     public StrBuilder appendSeparator(final String standard, final String defaultIfEmpty) {
         final String str = isEmpty() ? defaultIfEmpty : standard;
@@ -1370,7 +1340,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      *
      * @param separator  the separator to use
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendSeparator(final char separator) {
         if (size() > 0) {
@@ -1388,7 +1357,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param standard the separator if builder is not empty
      * @param defaultIfEmpty the separator if builder is empty
      * @return this, to enable chaining
-     * @since 2.5
      */
     public StrBuilder appendSeparator(final char standard, final char defaultIfEmpty) {
         if (size() > 0) {
@@ -1418,7 +1386,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param separator  the separator to use, null means no separator
      * @param loopIndex  the loop index
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendSeparator(final String separator, final int loopIndex) {
         if (separator != null && loopIndex > 0) {
@@ -1446,7 +1413,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param separator  the separator to use
      * @param loopIndex  the loop index
      * @return this, to enable chaining
-     * @since 2.3
      */
     public StrBuilder appendSeparator(final char separator, final int loopIndex) {
         if (loopIndex > 0) {
@@ -2222,7 +2188,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
     //-----------------------------------------------------------------------
     /**
      * {@inheritDoc}
-     * @since 3.0
      */
     @Override
     public CharSequence subSequence(final int startIndex, final int endIndex) {
@@ -2722,7 +2687,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * @param appendable  the appendable to append data to
      * @throws IOException  if an I/O error occurs
      *
-     * @since 3.4
      * @see #readFrom(Readable)
      */
     public void appendTo(final Appendable appendable) throws IOException {
@@ -2881,7 +2845,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
      * new instance each time the method is called.
      *
      * @return the builder as a StringBuilder
-     * @since 3.2
      */
     public StringBuilder toStringBuilder() {
         return new StringBuilder(size).append(buffer, 0, size);
@@ -2890,7 +2853,6 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
     /**
      * Implement the {@link Builder} interface.
      * @return the builder as a String
-     * @since 3.2
      * @see #toString()
      */
     @Override

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/StrLookup.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/StrLookup.java b/src/main/java/org/apache/commons/text/StrLookup.java
index 4626713..f9bffb5 100644
--- a/src/main/java/org/apache/commons/text/StrLookup.java
+++ b/src/main/java/org/apache/commons/text/StrLookup.java
@@ -30,6 +30,8 @@ import java.util.Map;
  * <p>
  * For example, it would be possible to implement a lookup that used the
  * key as a primary key, and looked up the value on demand from the database
+ *
+ * @since 1.0
  */
 public abstract class StrLookup<V> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/StrMatcher.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/StrMatcher.java b/src/main/java/org/apache/commons/text/StrMatcher.java
index a115a9d..97d6673 100644
--- a/src/main/java/org/apache/commons/text/StrMatcher.java
+++ b/src/main/java/org/apache/commons/text/StrMatcher.java
@@ -24,6 +24,8 @@ import java.util.Arrays;
  * <p>
  * This class comes complete with various factory methods.
  * If these do not suffice, you can subclass and implement your own matcher.
+ *
+ * @since 1.0
  */
 public abstract class StrMatcher {
 
@@ -257,7 +259,6 @@ public abstract class StrMatcher {
      * @param buffer  the text content to match against, do not change
      * @param pos  the starting position for the match, valid for buffer
      * @return the number of matching characters, zero for no match
-     * @since 2.4
      */
     public int isMatch(final char[] buffer, final int pos) {
         return isMatch(buffer, pos, 0, buffer.length);

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/StrSubstitutor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/StrSubstitutor.java b/src/main/java/org/apache/commons/text/StrSubstitutor.java
index 73a3cc1..00d05f7 100644
--- a/src/main/java/org/apache/commons/text/StrSubstitutor.java
+++ b/src/main/java/org/apache/commons/text/StrSubstitutor.java
@@ -117,6 +117,8 @@ import java.util.Properties;
  * {@link #setEnableSubstitutionInVariables(boolean) enableSubstitutionInVariables}
  * property to <b>true</b>.
  * <p>This class is <b>not</b> thread safe.</p>
+ *
+ * @since 1.0
  */
 public class StrSubstitutor {
 
@@ -134,7 +136,6 @@ public class StrSubstitutor {
     public static final StrMatcher DEFAULT_SUFFIX = StrMatcher.stringMatcher("}");
     /**
      * Constant for the default value delimiter of a variable.
-     * @since 3.2
      */
     public static final StrMatcher DEFAULT_VALUE_DELIMITER = StrMatcher.stringMatcher(":-");
 
@@ -289,7 +290,6 @@ public class StrSubstitutor {
      * @param escape  the escape character
      * @param valueDelimiter  the variable default value delimiter, may be null
      * @throws IllegalArgumentException if the prefix or suffix is null
-     * @since 3.2
      */
     public <V> StrSubstitutor(final Map<String, V> valueMap, final String prefix, final String suffix,
                               final char escape, final String valueDelimiter) {
@@ -332,7 +332,6 @@ public class StrSubstitutor {
      * @param escape  the escape character
      * @param valueDelimiter  the variable default value delimiter string, may be null
      * @throws IllegalArgumentException if the prefix or suffix is null
-     * @since 3.2
      */
     public StrSubstitutor(final StrLookup<?> variableResolver, final String prefix, final String suffix,
                           final char escape, final String valueDelimiter) {
@@ -367,7 +366,6 @@ public class StrSubstitutor {
      * @param escape  the escape character
      * @param valueDelimiterMatcher  the variable default value delimiter matcher, may be null
      * @throws IllegalArgumentException if the prefix or suffix is null
-     * @since 3.2
      */
     public StrSubstitutor(
             final StrLookup<?> variableResolver, final StrMatcher prefixMatcher, final StrMatcher suffixMatcher,
@@ -508,7 +506,6 @@ public class StrSubstitutor {
      *
      * @param source  the buffer to use as a template, not changed, null returns null
      * @return the result of the replace operation
-     * @since 3.2
      */
     public String replace(final CharSequence source) {
         if (source == null) {
@@ -529,7 +526,6 @@ public class StrSubstitutor {
      * @param offset  the start offset within the array, must be valid
      * @param length  the length within the array to be processed, must be valid
      * @return the result of the replace operation
-     * @since 3.2
      */
     public String replace(final CharSequence source, final int offset, final int length) {
         if (source == null) {
@@ -647,7 +643,6 @@ public class StrSubstitutor {
      *
      * @param source  the buffer to replace in, updated, null returns zero
      * @return true if altered
-     * @since 3.2
      */
     public boolean replaceIn(final StringBuilder source) {
         if (source == null) {
@@ -668,7 +663,6 @@ public class StrSubstitutor {
      * @param offset  the start offset within the array, must be valid
      * @param length  the length within the buffer to be processed, must be valid
      * @return true if altered
-     * @since 3.2
      */
     public boolean replaceIn(final StringBuilder source, final int offset, final int length) {
         if (source == null) {
@@ -1090,7 +1084,6 @@ public class StrSubstitutor {
      * If it returns null, then the variable default value resolution is disabled.
      *
      * @return the variable default value delimiter matcher in use, may be null
-     * @since 3.2
      */
     public StrMatcher getValueDelimiterMatcher() {
         return valueDelimiterMatcher;
@@ -1108,7 +1101,6 @@ public class StrSubstitutor {
      *
      * @param valueDelimiterMatcher  variable default value delimiter matcher to use, may be null
      * @return this, to enable chaining
-     * @since 3.2
      */
     public StrSubstitutor setValueDelimiterMatcher(final StrMatcher valueDelimiterMatcher) {
         this.valueDelimiterMatcher = valueDelimiterMatcher;
@@ -1124,7 +1116,6 @@ public class StrSubstitutor {
      *
      * @param valueDelimiter  the variable default value delimiter character to use
      * @return this, to enable chaining
-     * @since 3.2
      */
     public StrSubstitutor setValueDelimiter(final char valueDelimiter) {
         return setValueDelimiterMatcher(StrMatcher.charMatcher(valueDelimiter));
@@ -1142,7 +1133,6 @@ public class StrSubstitutor {
      *
      * @param valueDelimiter  the variable default value delimiter string to use, may be null or empty
      * @return this, to enable chaining
-     * @since 3.2
      */
     public StrSubstitutor setValueDelimiter(final String valueDelimiter) {
         if (valueDelimiter == null || valueDelimiter.length() == 0) {
@@ -1178,7 +1168,6 @@ public class StrSubstitutor {
      * Returns a flag whether substitution is done in variable names.
      *
      * @return the substitution in variable names flag
-     * @since 3.0
      */
     public boolean isEnableSubstitutionInVariables() {
         return enableSubstitutionInVariables;
@@ -1191,7 +1180,6 @@ public class StrSubstitutor {
      * <code>${jre-${java.version}}</code>. The default value is <b>false</b>.
      *
      * @param enableSubstitutionInVariables the new value of the flag
-     * @since 3.0
      */
     public void setEnableSubstitutionInVariables(
             final boolean enableSubstitutionInVariables) {
@@ -1203,7 +1191,6 @@ public class StrSubstitutor {
      * substitution.
      * 
      * @return the preserve escape flag
-     * @since 3.5
      */
     public boolean isPreserveEscapes() {
         return preserveEscapes;
@@ -1219,7 +1206,6 @@ public class StrSubstitutor {
      * <code>${this-is-escaped}</code>).  The default value is <b>false</b>
      * 
      * @param preserveEscapes true if escapes are to be preserved
-     * @since 3.5
      */
     public void setPreserveEscapes(final boolean preserveEscapes) {
         this.preserveEscapes = preserveEscapes;

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/StrTokenizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/StrTokenizer.java b/src/main/java/org/apache/commons/text/StrTokenizer.java
index a980bf9..055556d 100644
--- a/src/main/java/org/apache/commons/text/StrTokenizer.java
+++ b/src/main/java/org/apache/commons/text/StrTokenizer.java
@@ -78,6 +78,8 @@ import java.util.NoSuchElementException;
  *   <td>ignoreEmptyTokens</td><td>boolean</td><td>true</td>
  *  </tr>
  * </table>
+ *
+ * @since 1.0
  */
 public class StrTokenizer implements ListIterator<String>, Cloneable {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/StringEscapeUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/StringEscapeUtils.java b/src/main/java/org/apache/commons/text/StringEscapeUtils.java
index 3e07abd..18b4a7e 100644
--- a/src/main/java/org/apache/commons/text/StringEscapeUtils.java
+++ b/src/main/java/org/apache/commons/text/StringEscapeUtils.java
@@ -43,6 +43,8 @@ import org.apache.commons.text.translate.UnicodeUnpairedSurrogateRemover;
  * <p>
  * This code has been adapted from Apache Commons Lang 3.5.
  * </p>
+ *
+ * @since 1.0
  */
 public class StringEscapeUtils {
 
@@ -53,9 +55,7 @@ public class StringEscapeUtils {
      *
      * While {@link #escapeJava(String)} is the expected method of use, this 
      * object allows the Java escaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator ESCAPE_JAVA =
             new LookupTranslator(
@@ -73,9 +73,7 @@ public class StringEscapeUtils {
      *
      * While {@link #escapeEcmaScript(String)} is the expected method of use, this 
      * object allows the EcmaScript escaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator ESCAPE_ECMASCRIPT =
             new AggregateTranslator(
@@ -96,8 +94,6 @@ public class StringEscapeUtils {
      * While {@link #escapeJson(String)} is the expected method of use, this
      * object allows the Json escaping functionality to be used
      * as the foundation for a custom translator.
-     *
-     * @since 3.2
      */
     public static final CharSequenceTranslator ESCAPE_JSON =
             new AggregateTranslator(
@@ -112,30 +108,11 @@ public class StringEscapeUtils {
             );
 
     /**
-     * Translator object for escaping XML.
-     *
-     * While {@link #escapeXml(String)} is the expected method of use, this 
-     * object allows the XML escaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
-     * @deprecated use {@link #ESCAPE_XML10} or {@link #ESCAPE_XML11} instead.
-     */
-    @Deprecated
-    public static final CharSequenceTranslator ESCAPE_XML =
-            new AggregateTranslator(
-                    new LookupTranslator(EntityArrays.BASIC_ESCAPE()),
-                    new LookupTranslator(EntityArrays.APOS_ESCAPE())
-            );
-
-    /**
      * Translator object for escaping XML 1.0.
      *
      * While {@link #escapeXml10(String)} is the expected method of use, this
      * object allows the XML escaping functionality to be used
      * as the foundation for a custom translator.
-     *
-     * @since 3.3
      */
     public static final CharSequenceTranslator ESCAPE_XML10 =
             new AggregateTranslator(
@@ -186,8 +163,6 @@ public class StringEscapeUtils {
      * While {@link #escapeXml11(String)} is the expected method of use, this
      * object allows the XML escaping functionality to be used
      * as the foundation for a custom translator.
-     *
-     * @since 3.3
      */
     public static final CharSequenceTranslator ESCAPE_XML11 =
             new AggregateTranslator(
@@ -213,9 +188,7 @@ public class StringEscapeUtils {
      *
      * While {@link #escapeHtml3(String)} is the expected method of use, this 
      * object allows the HTML escaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator ESCAPE_HTML3 =
             new AggregateTranslator(
@@ -228,9 +201,7 @@ public class StringEscapeUtils {
      *
      * While {@link #escapeHtml4(String)} is the expected method of use, this 
      * object allows the HTML escaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator ESCAPE_HTML4 =
             new AggregateTranslator(
@@ -244,9 +215,7 @@ public class StringEscapeUtils {
      *
      * While {@link #escapeCsv(String)} is the expected method of use, this 
      * object allows the CSV escaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator ESCAPE_CSV = new CsvEscaper();
 
@@ -319,9 +288,7 @@ public class StringEscapeUtils {
      *
      * While {@link #unescapeJava(String)} is the expected method of use, this 
      * object allows the Java unescaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     // TODO: throw "illegal character: \92" as an Exception if a \ on the end of the Java (as per the compiler)?
     public static final CharSequenceTranslator UNESCAPE_JAVA =
@@ -343,9 +310,7 @@ public class StringEscapeUtils {
      *
      * While {@link #unescapeEcmaScript(String)} is the expected method of use, this 
      * object allows the EcmaScript unescaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator UNESCAPE_ECMASCRIPT = UNESCAPE_JAVA;
 
@@ -355,8 +320,6 @@ public class StringEscapeUtils {
      * While {@link #unescapeJson(String)} is the expected method of use, this
      * object allows the Json unescaping functionality to be used
      * as the foundation for a custom translator.
-     *
-     * @since 3.2
      */
     public static final CharSequenceTranslator UNESCAPE_JSON = UNESCAPE_JAVA;
 
@@ -365,9 +328,7 @@ public class StringEscapeUtils {
      *
      * While {@link #unescapeHtml3(String)} is the expected method of use, this 
      * object allows the HTML unescaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator UNESCAPE_HTML3 =
             new AggregateTranslator(
@@ -381,9 +342,7 @@ public class StringEscapeUtils {
      *
      * While {@link #unescapeHtml4(String)} is the expected method of use, this 
      * object allows the HTML unescaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator UNESCAPE_HTML4 =
             new AggregateTranslator(
@@ -398,9 +357,7 @@ public class StringEscapeUtils {
      *
      * While {@link #unescapeXml(String)} is the expected method of use, this 
      * object allows the XML unescaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator UNESCAPE_XML =
             new AggregateTranslator(
@@ -414,9 +371,7 @@ public class StringEscapeUtils {
      *
      * While {@link #unescapeCsv(String)} is the expected method of use, this 
      * object allows the CSV unescaping functionality to be used 
-     * as the foundation for a custom translator. 
-     *
-     * @since 3.0
+     * as the foundation for a custom translator.
      */
     public static final CharSequenceTranslator UNESCAPE_CSV = new CsvUnescaper();
 
@@ -457,8 +412,6 @@ public class StringEscapeUtils {
 
     /**
      * Translator object for unescaping backslash escaped entries.
-     *
-     * @since 3.6
      */
     static class XsiUnescaper extends CharSequenceTranslator {
 
@@ -624,8 +577,6 @@ public class StringEscapeUtils {
      *
      * @param input  String to escape values in, may be null
      * @return String with escaped values, {@code null} if null string input
-     *
-     * @since 3.0
      */
     public static final String escapeEcmaScript(final String input) {
         return ESCAPE_ECMASCRIPT.translate(input);
@@ -652,8 +603,6 @@ public class StringEscapeUtils {
      *
      * @param input  String to escape values in, may be null
      * @return String with escaped values, {@code null} if null string input
-     *
-     * @since 3.2
      */
     public static final String escapeJson(final String input) {
         return ESCAPE_JSON.translate(input);
@@ -682,8 +631,6 @@ public class StringEscapeUtils {
      * @see #unescapeJava(String)
      * @param input  the {@code String} to unescape, may be null
      * @return A new unescaped {@code String}, {@code null} if null string input
-     *
-     * @since 3.0
      */
     public static final String unescapeEcmaScript(final String input) {
         return UNESCAPE_ECMASCRIPT.translate(input);
@@ -699,8 +646,6 @@ public class StringEscapeUtils {
      * @see #unescapeJava(String)
      * @param input  the {@code String} to unescape, may be null
      * @return A new unescaped {@code String}, {@code null} if null string input
-     *
-     * @since 3.2
      */
     public static final String unescapeJson(final String input) {
         return UNESCAPE_JSON.translate(input);
@@ -732,8 +677,6 @@ public class StringEscapeUtils {
      * @see <a href="http://www.w3.org/TR/REC-html40/sgml/entities.html">HTML 4.0 Character entity references</a>
      * @see <a href="http://www.w3.org/TR/html401/charset.html#h-5.3">HTML 4.01 Character References</a>
      * @see <a href="http://www.w3.org/TR/html401/charset.html#code-position">HTML 4.01 Code positions</a>
-     *
-     * @since 3.0
      */
     public static final String escapeHtml4(final String input) {
         return ESCAPE_HTML4.translate(input);
@@ -745,8 +688,6 @@ public class StringEscapeUtils {
      *
      * @param input  the {@code String} to escape, may be null
      * @return a new escaped {@code String}, {@code null} if null string input
-     *
-     * @since 3.0
      */
     public static final String escapeHtml3(final String input) {
         return ESCAPE_HTML3.translate(input);
@@ -767,8 +708,6 @@ public class StringEscapeUtils {
      *
      * @param input  the {@code String} to unescape, may be null
      * @return a new unescaped {@code String}, {@code null} if null string input
-     *
-     * @since 3.0
      */
     public static final String unescapeHtml4(final String input) {
         return UNESCAPE_HTML4.translate(input);
@@ -781,39 +720,11 @@ public class StringEscapeUtils {
      *
      * @param input  the {@code String} to unescape, may be null
      * @return a new unescaped {@code String}, {@code null} if null string input
-     *
-     * @since 3.0
      */
     public static final String unescapeHtml3(final String input) {
         return UNESCAPE_HTML3.translate(input);
     }
 
-    //-----------------------------------------------------------------------
-    /**
-     * <p>Escapes the characters in a {@code String} using XML entities.</p>
-     *
-     * <p>For example: {@code "bread" & "butter"} =&gt;
-     * {@code &quot;bread&quot; &amp; &quot;butter&quot;}.
-     * </p>
-     *
-     * <p>Supports only the five basic XML entities (gt, lt, quot, amp, apos).
-     * Does not support DTDs or external entities.</p>
-     *
-     * <p>Note that Unicode characters greater than 0x7f are as of 3.0, no longer
-     *    escaped. If you still wish this functionality, you can achieve it
-     *    via the following:
-     * {@code StringEscapeUtils.ESCAPE_XML.with( NumericEntityEscaper.between(0x7f, Integer.MAX_VALUE) );}</p>
-     *
-     * @param input  the {@code String} to escape, may be null
-     * @return a new escaped {@code String}, {@code null} if null string input
-     * @see #unescapeXml(java.lang.String)
-     * @deprecated use {@link #escapeXml10(java.lang.String)} or {@link #escapeXml11(java.lang.String)} instead.
-     */
-    @Deprecated
-    public static final String escapeXml(final String input) {
-        return ESCAPE_XML.translate(input);
-    }
-
     /**
      * <p>Escapes the characters in a {@code String} using XML entities.</p>
      *
@@ -840,7 +751,6 @@ public class StringEscapeUtils {
      * @param input  the {@code String} to escape, may be null
      * @return a new escaped {@code String}, {@code null} if null string input
      * @see #unescapeXml(java.lang.String)
-     * @since 3.3
      */
     public static String escapeXml10(final String input) {
         return ESCAPE_XML10.translate(input);
@@ -870,7 +780,6 @@ public class StringEscapeUtils {
      * @param input  the {@code String} to escape, may be null
      * @return a new escaped {@code String}, {@code null} if null string input
      * @see #unescapeXml(java.lang.String)
-     * @since 3.3
      */
     public static String escapeXml11(final String input) {
         return ESCAPE_XML11.translate(input);
@@ -918,7 +827,6 @@ public class StringEscapeUtils {
      * @param input the input CSV column String, may be null
      * @return the input String, enclosed in double quotes if the value contains a comma,
      * newline or double quote, {@code null} if null string input
-     * @since 2.4
      */
     public static final String escapeCsv(final String input) {
         return ESCAPE_CSV.translate(input);
@@ -943,7 +851,6 @@ public class StringEscapeUtils {
      * @param input the input CSV column String, may be null
      * @return the input String, with enclosing double quotes removed and embedded double 
      * quotes unescaped, {@code null} if null string input
-     * @since 2.4
      */
     public static final String unescapeCsv(final String input) {
         return UNESCAPE_CSV.translate(input);

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/WordUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/WordUtils.java b/src/main/java/org/apache/commons/text/WordUtils.java
index a2605ea..7292d89 100644
--- a/src/main/java/org/apache/commons/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/text/WordUtils.java
@@ -26,6 +26,8 @@ import java.util.regex.Pattern;
  * <p>This class tries to handle <code>null</code> input gracefully.
  * An exception will not be thrown for a <code>null</code> input.
  * Each method documents its behaviour in more detail.</p>
+ *
+ * @since 1.0
  */
 public class WordUtils {
 
@@ -392,7 +394,6 @@ public class WordUtils {
      * @return capitalized String, <code>null</code> if null String input
      * @see #uncapitalize(String)
      * @see #capitalizeFully(String)
-     * @since 2.1
      */
     public static String capitalize(final String str, final char... delimiters) {
         final int delimLen = delimiters == null ? -1 : delimiters.length;
@@ -461,7 +462,6 @@ public class WordUtils {
      * @param str  the String to capitalize, may be null
      * @param delimiters  set of characters to determine capitalization, null means whitespace
      * @return capitalized String, <code>null</code> if null String input
-     * @since 2.1
      */
     public static String capitalizeFully(String str, final char... delimiters) {
         final int delimLen = delimiters == null ? -1 : delimiters.length;
@@ -517,7 +517,6 @@ public class WordUtils {
      * @param delimiters  set of characters to determine uncapitalization, null means whitespace
      * @return uncapitalized String, <code>null</code> if null String input
      * @see #capitalize(String)
-     * @since 2.1
      */
     public static String uncapitalize(final String str, final char... delimiters) {
         final int delimLen = delimiters == null ? -1 : delimiters.length;
@@ -611,7 +610,6 @@ public class WordUtils {
      * @param str  the String to get initials from, may be null
      * @return String of initial letters, <code>null</code> if null String input
      * @see #initials(String,char[])
-     * @since 2.2
      */
     public static String initials(final String str) {
         return initials(str, null);
@@ -641,7 +639,6 @@ public class WordUtils {
      * @param delimiters  set of characters to determine words, null means whitespace
      * @return String of initial characters, <code>null</code> if null String input
      * @see #initials(String)
-     * @since 2.2
      */
     public static String initials(final String str, final char... delimiters) {
         if (str == null || str.length() == 0) {
@@ -691,7 +688,6 @@ public class WordUtils {
      * @param word The CharSequence to check, may be null
      * @param words The array of String words to search for, may be null
      * @return {@code true} if all search words are found, {@code false} otherwise
-     * @since 3.5
      */
     public static boolean containsAllWords(final CharSequence word, final CharSequence... words) {
         if (word == null || word.length() == 0 || words == null || Array.getLength(words) == 0) {

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/CommandVisitor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/CommandVisitor.java b/src/main/java/org/apache/commons/text/diff/CommandVisitor.java
index c0daed4..7e5f40f 100644
--- a/src/main/java/org/apache/commons/text/diff/CommandVisitor.java
+++ b/src/main/java/org/apache/commons/text/diff/CommandVisitor.java
@@ -118,6 +118,7 @@ package org.apache.commons.text.diff;
  * </pre>
  *
  * @param <T> object type
+ * @since 1.0
  */
 public interface CommandVisitor<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/DeleteCommand.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/DeleteCommand.java b/src/main/java/org/apache/commons/text/diff/DeleteCommand.java
index 3e0d8df..8173718 100644
--- a/src/main/java/org/apache/commons/text/diff/DeleteCommand.java
+++ b/src/main/java/org/apache/commons/text/diff/DeleteCommand.java
@@ -30,6 +30,7 @@ package org.apache.commons.text.diff;
  * @see EditScript
  *
  * @param <T> object type
+ * @since 1.0
  */
 public class DeleteCommand<T> extends EditCommand<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/EditCommand.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/EditCommand.java b/src/main/java/org/apache/commons/text/diff/EditCommand.java
index 49f795c..7920206 100644
--- a/src/main/java/org/apache/commons/text/diff/EditCommand.java
+++ b/src/main/java/org/apache/commons/text/diff/EditCommand.java
@@ -49,6 +49,7 @@ package org.apache.commons.text.diff;
  * @see EditScript
  *
  * @param <T> object type
+ * @since 1.0
  */
 public abstract class EditCommand<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/EditScript.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/EditScript.java b/src/main/java/org/apache/commons/text/diff/EditScript.java
index 800f044..bf4b185 100644
--- a/src/main/java/org/apache/commons/text/diff/EditScript.java
+++ b/src/main/java/org/apache/commons/text/diff/EditScript.java
@@ -41,6 +41,7 @@ import java.util.List;
  * @see ReplacementsHandler
  *
  * @param <T> object type
+ * @since 1.0
  */
 public class EditScript<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/InsertCommand.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/InsertCommand.java b/src/main/java/org/apache/commons/text/diff/InsertCommand.java
index b23cabf..f0337dc 100644
--- a/src/main/java/org/apache/commons/text/diff/InsertCommand.java
+++ b/src/main/java/org/apache/commons/text/diff/InsertCommand.java
@@ -30,6 +30,7 @@ package org.apache.commons.text.diff;
  * @see EditScript
  *
  * @param <T> object type
+ * @since 1.0
  */
 public class InsertCommand<T> extends EditCommand<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/KeepCommand.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/KeepCommand.java b/src/main/java/org/apache/commons/text/diff/KeepCommand.java
index 01e950f..34c6fe7 100644
--- a/src/main/java/org/apache/commons/text/diff/KeepCommand.java
+++ b/src/main/java/org/apache/commons/text/diff/KeepCommand.java
@@ -30,6 +30,7 @@ package org.apache.commons.text.diff;
  * @see EditScript
  *
  * @param <T> object type
+ * @since 1.0
  */
 public class KeepCommand<T> extends EditCommand<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java b/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java
index d58d460..46f1b88 100644
--- a/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java
+++ b/src/main/java/org/apache/commons/text/diff/ReplacementsFinder.java
@@ -48,6 +48,7 @@ import java.util.List;
  * @see StringsComparator
  *
  * @param <T> object type
+ * @since 1.0
  */
 public class ReplacementsFinder<T> implements CommandVisitor<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java b/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java
index f486e5e..3beb716 100644
--- a/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java
+++ b/src/main/java/org/apache/commons/text/diff/ReplacementsHandler.java
@@ -23,6 +23,7 @@ import java.util.List;
  *
  * @param <T> object type
  * @see ReplacementsFinder
+ * @since 1.0
  */
 public interface ReplacementsHandler<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/diff/StringsComparator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/diff/StringsComparator.java b/src/main/java/org/apache/commons/text/diff/StringsComparator.java
index 7825df9..a286c4a 100644
--- a/src/main/java/org/apache/commons/text/diff/StringsComparator.java
+++ b/src/main/java/org/apache/commons/text/diff/StringsComparator.java
@@ -48,6 +48,7 @@ package org.apache.commons.text.diff;
  * @see EditScript
  * @see EditCommand
  * @see CommandVisitor
+ * @since 1.0
  */
 public class StringsComparator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/CosineDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/CosineDistance.java b/src/main/java/org/apache/commons/text/similarity/CosineDistance.java
index 4b595ce..7887063 100644
--- a/src/main/java/org/apache/commons/text/similarity/CosineDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/CosineDistance.java
@@ -23,6 +23,9 @@ import java.util.Map;
  *
  * <p>It utilizes the CosineSimilarity to compute the distance. Character sequences
  * are converted into vectors through a simple tokenizer that works with </p>
+ *
+ * @since 1.0
+ *
  */
 public class CosineDistance implements EditDistance<Double> {
     /**

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java b/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java
index 7fe9414..7288f3e 100644
--- a/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java
+++ b/src/main/java/org/apache/commons/text/similarity/CosineSimilarity.java
@@ -28,6 +28,8 @@ import java.util.Set;
  * For further explanation about the Cosine Similarity, refer to
  * http://en.wikipedia.org/wiki/Cosine_similarity.
  * </p>
+ *
+ * @since 1.0
  */
 public class CosineSimilarity {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/Counter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/Counter.java b/src/main/java/org/apache/commons/text/similarity/Counter.java
index 7f2a064..d259d6b 100644
--- a/src/main/java/org/apache/commons/text/similarity/Counter.java
+++ b/src/main/java/org/apache/commons/text/similarity/Counter.java
@@ -27,6 +27,8 @@ import java.util.Map;
  *
  * @see <a href="https://docs.python.org/dev/library/collections.html#collections.Counter">
  * https://docs.python.org/dev/library/collections.html#collections.Counter</a>
+ *
+ * @since 1.0
  */
 final class Counter {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/EditDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/EditDistance.java b/src/main/java/org/apache/commons/text/similarity/EditDistance.java
index 35571e0..cf4e2c0 100644
--- a/src/main/java/org/apache/commons/text/similarity/EditDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/EditDistance.java
@@ -42,6 +42,7 @@ package org.apache.commons.text.similarity;
  * </p>
  *
  * @param <R> The type of similarity score unit used by this EditDistance.
+ * @since 1.0
  */
 public interface EditDistance<R> extends SimilarityScore<R> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/EditDistanceFrom.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/EditDistanceFrom.java b/src/main/java/org/apache/commons/text/similarity/EditDistanceFrom.java
index 3462895..b67a41f 100644
--- a/src/main/java/org/apache/commons/text/similarity/EditDistanceFrom.java
+++ b/src/main/java/org/apache/commons/text/similarity/EditDistanceFrom.java
@@ -48,6 +48,7 @@ package org.apache.commons.text.similarity;
  * </pre>
  *
  * @param <R> This is the type of similarity score used by the EditDistance function.
+ * @since 1.0
  */
 public class EditDistanceFrom<R> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java b/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java
index 3393028..8356960 100644
--- a/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java
+++ b/src/main/java/org/apache/commons/text/similarity/FuzzyScore.java
@@ -30,6 +30,8 @@ import java.util.Locale;
  * <p>
  * This code has been adapted from Apache Commons Lang 3.3.
  * </p>
+ *
+ * @since 1.0
  */
 public class FuzzyScore {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/HammingDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/HammingDistance.java b/src/main/java/org/apache/commons/text/similarity/HammingDistance.java
index 87ad8d7..8d88fe8 100644
--- a/src/main/java/org/apache/commons/text/similarity/HammingDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/HammingDistance.java
@@ -24,6 +24,8 @@ package org.apache.commons.text.similarity;
  * For further explanation about the Hamming Distance, take a look at its
  * Wikipedia page at http://en.wikipedia.org/wiki/Hamming_distance.
  * </p>
+ *
+ * @since 1.0
  */
 public class HammingDistance implements EditDistance<Integer> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/JaccardDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/JaccardDistance.java b/src/main/java/org/apache/commons/text/similarity/JaccardDistance.java
index 669382a..4a3d5cc 100644
--- a/src/main/java/org/apache/commons/text/similarity/JaccardDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/JaccardDistance.java
@@ -25,6 +25,8 @@ package org.apache.commons.text.similarity;
  * For further explanation about Jaccard Distance, refer
  * https://en.wikipedia.org/wiki/Jaccard_index
  * </p>
+ *
+ * @since 1.0
  */
 public class JaccardDistance implements EditDistance<Double> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/JaccardSimilarity.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/JaccardSimilarity.java b/src/main/java/org/apache/commons/text/similarity/JaccardSimilarity.java
index 7ccf91c..ffacb3f 100644
--- a/src/main/java/org/apache/commons/text/similarity/JaccardSimilarity.java
+++ b/src/main/java/org/apache/commons/text/similarity/JaccardSimilarity.java
@@ -28,6 +28,8 @@ import java.util.Set;
  * For further explanation about Jaccard Similarity, refer
  * https://en.wikipedia.org/wiki/Jaccard_index
  * </p>
+ *
+ * @since 1.0
  */
 public class JaccardSimilarity implements SimilarityScore<Double> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java b/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
index b2a65d1..403d8a7 100644
--- a/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
@@ -34,6 +34,8 @@ package org.apache.commons.text.similarity;
  * <p>
  * This code has been adapted from Apache Commons Lang 3.3.
  * </p>
+ *
+ * @since 1.0
  */
 public class JaroWinklerDistance implements SimilarityScore<Double> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java b/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
index a5d1a5b..ec27426 100644
--- a/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
@@ -26,6 +26,8 @@ import java.util.Arrays;
  * where each change is a single character modification (deletion, insertion
  * or substitution).
  * </p>
+ *
+ * @since 1.0
  */
 public class LevenshteinDetailedDistance implements EditDistance<LevenshteinResults> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
index 01ec3dc..01964bb 100644
--- a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
@@ -30,6 +30,8 @@ import java.util.Arrays;
  * <p>
  * This code has been adapted from Apache Commons Lang 3.3.
  * </p>
+ *
+ * @since 1.0
  */
 public class LevenshteinDistance implements EditDistance<Integer> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/RegexTokenizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/RegexTokenizer.java b/src/main/java/org/apache/commons/text/similarity/RegexTokenizer.java
index a849cde..1c9e268 100644
--- a/src/main/java/org/apache/commons/text/similarity/RegexTokenizer.java
+++ b/src/main/java/org/apache/commons/text/similarity/RegexTokenizer.java
@@ -25,6 +25,8 @@ import java.util.regex.Pattern;
  * A simple word tokenizer that utilizes regex to find words. It applies a regex
  * {@code}(\w)+{@code} over the input text to extract words from a given character
  * sequence.
+ *
+ * @since 1.0
  */
 class RegexTokenizer implements Tokenizer<CharSequence> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java b/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
index a1f8dff..77a32f7 100644
--- a/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
+++ b/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
@@ -31,6 +31,7 @@ package org.apache.commons.text.similarity;
  * </p>
  *
  * @param <R> The type of similarity score unit used by this EditDistance.
+ * @since 1.0
  */
 public interface SimilarityScore<R> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java b/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java
index e4fe794..b58ea4a 100644
--- a/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java
+++ b/src/main/java/org/apache/commons/text/similarity/SimilarityScoreFrom.java
@@ -48,6 +48,7 @@ package org.apache.commons.text.similarity;
  * </pre>
  *
  * @param <R> This is the type of similarity score used by the SimilarityScore function.
+ * @since 1.0
  */
 public class SimilarityScoreFrom<R> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/similarity/Tokenizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/Tokenizer.java b/src/main/java/org/apache/commons/text/similarity/Tokenizer.java
index 0a69d24..fa8fda4 100644
--- a/src/main/java/org/apache/commons/text/similarity/Tokenizer.java
+++ b/src/main/java/org/apache/commons/text/similarity/Tokenizer.java
@@ -20,6 +20,7 @@ package org.apache.commons.text.similarity;
  * A tokenizer. Can produce arrays of tokens from a given type.
  *
  * @param <T> given type
+ * @since 1.0
  */
 interface Tokenizer<T> {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java b/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java
index d209b3c..74eb6de 100644
--- a/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/AggregateTranslator.java
@@ -22,6 +22,8 @@ import java.io.Writer;
 /**
  * Executes a sequence of translators one after the other. Execution ends whenever 
  * the first translator consumes codepoints from the input.
+ *
+ * @since 1.0
  */
 public class AggregateTranslator extends CharSequenceTranslator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java b/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
index 6c40dbe..baec844 100644
--- a/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/CharSequenceTranslator.java
@@ -25,6 +25,8 @@ import java.util.Locale;
  * An API for translating text. 
  * Its core use is to escape and unescape text. Because escaping and unescaping 
  * is completely contextual, the API does not present two separate signatures.
+ *
+ * @since 1.0
  */
 public abstract class CharSequenceTranslator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java b/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
index c63165c..3318261 100644
--- a/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/CodePointTranslator.java
@@ -22,6 +22,8 @@ import java.io.Writer;
 /**
  * Helper subclass to CharSequenceTranslator to allow for translations that 
  * will replace up to one character at a time.
+ *
+ * @since 1.0
  */
 public abstract class CodePointTranslator extends CharSequenceTranslator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/EntityArrays.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/EntityArrays.java b/src/main/java/org/apache/commons/text/translate/EntityArrays.java
index 99626e6..5e5ccef 100644
--- a/src/main/java/org/apache/commons/text/translate/EntityArrays.java
+++ b/src/main/java/org/apache/commons/text/translate/EntityArrays.java
@@ -20,6 +20,8 @@ package org.apache.commons.text.translate;
  * Class holding various entity data for HTML and XML - generally for use with
  * the LookupTranslator.
  * All arrays are of length [*][2].
+ *
+ * @since 1.0
  */
 public class EntityArrays {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java b/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java
index 8c5b2b6..22549fa 100644
--- a/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java
+++ b/src/main/java/org/apache/commons/text/translate/JavaUnicodeEscaper.java
@@ -18,6 +18,8 @@ package org.apache.commons.text.translate;
 
 /**
  * Translates codepoints to their Unicode escaped value suitable for Java source.
+ *
+ * @since 1.0
  */
 public class JavaUnicodeEscaper extends UnicodeEscaper {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/LookupTranslator.java b/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
index df8161d..8a79580 100644
--- a/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
@@ -23,6 +23,8 @@ import java.util.HashSet;
 
 /**
  * Translates a value using a lookup table.
+ *
+ * @since 1.0
  */
 public class LookupTranslator extends CharSequenceTranslator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java b/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java
index 3e4bbd0..a852964 100644
--- a/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java
+++ b/src/main/java/org/apache/commons/text/translate/NumericEntityEscaper.java
@@ -21,6 +21,8 @@ import java.io.Writer;
 
 /**
  * Translates codepoints to their XML numeric entity escaped value.
+ *
+ * @since 1.0
  */
 public class NumericEntityEscaper extends CodePointTranslator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java b/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java
index 6e2016e..8b3d7c7 100644
--- a/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java
+++ b/src/main/java/org/apache/commons/text/translate/NumericEntityUnescaper.java
@@ -26,6 +26,8 @@ import java.util.EnumSet;
  * the specific codepoint.
  *
  * Note that the semi-colon is optional.
+ *
+ * @since 1.0
  */
 public class NumericEntityUnescaper extends CharSequenceTranslator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java b/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java
index f9c0c14..e49cdd5 100644
--- a/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java
+++ b/src/main/java/org/apache/commons/text/translate/OctalUnescaper.java
@@ -26,6 +26,8 @@ import java.io.Writer;
  *
  * Note that this currently only supports the viable range of octal for Java; namely 
  * 1 to 377. This is because parsing Java is the main use case.
+ *
+ * @since 1.0
  */
 public class OctalUnescaper extends CharSequenceTranslator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java b/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
index 0c90f6d..04b24e2 100644
--- a/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
+++ b/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
@@ -21,6 +21,8 @@ import java.io.Writer;
 
 /**
  * Translates codepoints to their Unicode escaped value.
+ *
+ * @since 1.0
  */
 public class UnicodeEscaper extends CodePointTranslator {
 
@@ -128,7 +130,6 @@ public class UnicodeEscaper extends CodePointTranslator {
      *            a Unicode code point
      * @return the hex string for the given codepoint
      *
-     * @since 3.2
      */
     protected String toUtf16Escape(final int codepoint) {
         return "\\u" + hex(codepoint);

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/UnicodeUnescaper.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/UnicodeUnescaper.java b/src/main/java/org/apache/commons/text/translate/UnicodeUnescaper.java
index e8fda68..3a91d6c 100644
--- a/src/main/java/org/apache/commons/text/translate/UnicodeUnescaper.java
+++ b/src/main/java/org/apache/commons/text/translate/UnicodeUnescaper.java
@@ -23,6 +23,8 @@ import java.io.Writer;
  * Translates escaped Unicode values of the form \\u+\d\d\d\d back to 
  * Unicode. It supports multiple 'u' characters and will work with or 
  * without the +.
+ *
+ * @since 1.0
  */
 public class UnicodeUnescaper extends CharSequenceTranslator {
 

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java b/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java
index cf18d62..ca90b89 100644
--- a/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java
+++ b/src/main/java/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.java
@@ -21,6 +21,8 @@ import java.io.Writer;
 
 /**
  * Helper subclass to CharSequenceTranslator to remove unpaired surrogates.
+ *
+ * @since 1.0
  */
 public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator {
     /**

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/main/java/org/apache/commons/text/translate/package-info.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/translate/package-info.java b/src/main/java/org/apache/commons/text/translate/package-info.java
index 3ef4d48..5ccb000 100644
--- a/src/main/java/org/apache/commons/text/translate/package-info.java
+++ b/src/main/java/org/apache/commons/text/translate/package-info.java
@@ -18,5 +18,7 @@
  * <p> An API for creating text translation routines from a set of smaller building blocks. Initially created to make it
  * possible for the user to customize the rules in the StringEscapeUtils class.</p>
  * <p>These classes are immutable, and therefore thread-safe.</p>
+ *
+ * @since 1.0
  */
 package org.apache.commons.text.translate;

http://git-wip-us.apache.org/repos/asf/commons-text/blob/9d5e6d89/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java b/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java
index cf9ee7b..0d2de24 100644
--- a/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java
+++ b/src/test/java/org/apache/commons/text/StringEscapeUtilsTest.java
@@ -297,43 +297,7 @@ public class StringEscapeUtilsTest {
         // TODO: refine API for escaping/unescaping specific HTML versions
     }
 
-    @Test
-    @SuppressWarnings( "deprecation" ) // ESCAPE_XML has been replaced by ESCAPE_XML10 and ESCAPE_XML11 in 3.3
-    public void testEscapeXml() throws Exception {
-        assertEquals("&lt;abc&gt;", StringEscapeUtils.escapeXml("<abc>"));
-        assertEquals("<abc>", StringEscapeUtils.unescapeXml("&lt;abc&gt;"));
-
-        assertEquals("XML should not escape >0x7f values",
-                "\u00A1", StringEscapeUtils.escapeXml("\u00A1"));
-        assertEquals("XML should be able to unescape >0x7f values",
-                "\u00A0", StringEscapeUtils.unescapeXml("&#160;"));
-        assertEquals("XML should be able to unescape >0x7f values with one leading 0",
-                "\u00A0", StringEscapeUtils.unescapeXml("&#0160;"));
-        assertEquals("XML should be able to unescape >0x7f values with two leading 0s",
-                "\u00A0", StringEscapeUtils.unescapeXml("&#00160;"));
-        assertEquals("XML should be able to unescape >0x7f values with three leading 0s",
-                "\u00A0", StringEscapeUtils.unescapeXml("&#000160;"));
-
-        assertEquals("ain't", StringEscapeUtils.unescapeXml("ain&apos;t"));
-        assertEquals("ain&apos;t", StringEscapeUtils.escapeXml("ain't"));
-        assertEquals("", StringEscapeUtils.escapeXml(""));
-        assertEquals(null, StringEscapeUtils.escapeXml(null));
-        assertEquals(null, StringEscapeUtils.unescapeXml(null));
-
-        StringWriter sw = new StringWriter();
-        try {
-            StringEscapeUtils.ESCAPE_XML.translate("<abc>", sw);
-        } catch (final IOException e) {
-        }
-        assertEquals("XML was escaped incorrectly", "&lt;abc&gt;", sw.toString() );
 
-        sw = new StringWriter();
-        try {
-            StringEscapeUtils.UNESCAPE_XML.translate("&lt;abc&gt;", sw);
-        } catch (final IOException e) {
-        }
-        assertEquals("XML was unescaped incorrectly", "<abc>", sw.toString() );
-    }
 
     @Test
     public void testEscapeXml10() throws Exception {
@@ -368,53 +332,6 @@ public class StringEscapeUtilsTest {
     }
 
     /**
-     * Tests Supplementary characters. 
-     * <p>
-     * From http://www.w3.org/International/questions/qa-escapes
-     * </p>
-     * <blockquote>
-     * Supplementary characters are those Unicode characters that have code points higher than the characters in
-     * the Basic Multilingual Plane (BMP). In UTF-16 a supplementary character is encoded using two 16-bit surrogate code points from the
-     * BMP. Because of this, some people think that supplementary characters need to be represented using two escapes, but this is incorrect
-     * - you must use the single, code point value for that character. For example, use &amp;&#35;x233B4&#59; rather than
-     * &amp;&#35;xD84C&#59;&amp;&#35;xDFB4&#59;.
-     * </blockquote>
-     * @see <a href="http://www.w3.org/International/questions/qa-escapes">Using character escapes in markup and CSS</a>
-     * @see <a href="https://issues.apache.org/jira/browse/LANG-728">LANG-728</a>
-     */
-    @Test
-    @SuppressWarnings( "deprecation" ) // ESCAPE_XML has been replaced by ESCAPE_XML10 and ESCAPE_XML11 in 3.3
-    public void testEscapeXmlSupplementaryCharacters() {
-        final CharSequenceTranslator escapeXml =
-                StringEscapeUtils.ESCAPE_XML.with( NumericEntityEscaper.between(0x7f, Integer.MAX_VALUE) );
-
-        assertEquals("Supplementary character must be represented using a single escape", "&#144308;",
-                escapeXml.translate("\uD84C\uDFB4"));
-
-        assertEquals("Supplementary characters mixed with basic characters should be encoded correctly", "a b c &#144308;",
-                escapeXml.translate("a b c \uD84C\uDFB4"));
-    }
-
-    @Test
-    @SuppressWarnings( "deprecation" ) // ESCAPE_XML has been replaced by ESCAPE_XML10 and ESCAPE_XML11 in 3.3
-    public void testEscapeXmlAllCharacters() {
-        // http://www.w3.org/TR/xml/#charsets says:
-        // Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] /* any Unicode character,
-        // excluding the surrogate blocks, FFFE, and FFFF. */
-        final CharSequenceTranslator escapeXml = StringEscapeUtils.ESCAPE_XML
-                .with(NumericEntityEscaper.below(9), NumericEntityEscaper.between(0xB, 0xC), NumericEntityEscaper.between(0xE, 0x19),
-                        NumericEntityEscaper.between(0xD800, 0xDFFF), NumericEntityEscaper.between(0xFFFE, 0xFFFF), NumericEntityEscaper.above(0x110000));
-
-        assertEquals("&#0;&#1;&#2;&#3;&#4;&#5;&#6;&#7;&#8;", escapeXml.translate("\u0000\u0001\u0002\u0003\u0004\u0005\u0006\u0007\u0008"));
-        assertEquals("\t", escapeXml.translate("\t")); // 0x9
-        assertEquals("\n", escapeXml.translate("\n")); // 0xA
-        assertEquals("&#11;&#12;", escapeXml.translate("\u000B\u000C"));
-        assertEquals("\r", escapeXml.translate("\r")); // 0xD
-        assertEquals("Hello World! Ain&apos;t this great?", escapeXml.translate("Hello World! Ain't this great?"));
-        assertEquals("&#14;&#15;&#24;&#25;", escapeXml.translate("\u000E\u000F\u0018\u0019"));
-    }
-
-    /**
      * Reverse of the above.
      *
      * @see <a href="https://issues.apache.org/jira/browse/LANG-729">LANG-729</a>
@@ -574,17 +491,6 @@ public class StringEscapeUtilsTest {
     }
 
     /**
-     * Tests https://issues.apache.org/jira/browse/LANG-720
-     */
-    @Test
-    @SuppressWarnings( "deprecation" ) // escapeXml(String) has been replaced by escapeXml10(String) and escapeXml11(String) in 3.3
-    public void testLang720() {
-        final String input = "\ud842\udfb7" + "A";
-        final String escaped = StringEscapeUtils.escapeXml(input);
-        assertEquals(input, escaped);
-    }
-
-    /**
      * Tests https://issues.apache.org/jira/browse/LANG-911
      */
     @Test


Mime
View raw message