Better description of Javadoc deprecation and add missing @deprecation

annotation at the package level.
This commit is contained in:
Gary Gregory 2021-12-08 09:28:58 -05:00
parent a71bab967a
commit 29839c2717
26 changed files with 32 additions and 29 deletions

View File

@ -36,7 +36,7 @@ import org.apache.commons.lang3.text.translate.UnicodeUnpairedSurrogateRemover;
* *
* <p>#ThreadSafe#</p> * <p>#ThreadSafe#</p>
* @since 2.0 * @since 2.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringEscapeUtils.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringEscapeUtils.html">
* StringEscapeUtils</a> instead * StringEscapeUtils</a> instead
*/ */

View File

@ -2128,7 +2128,7 @@ public class StringUtils {
* @return result score * @return result score
* @throws IllegalArgumentException if either String input {@code null} or Locale input {@code null} * @throws IllegalArgumentException if either String input {@code null} or Locale input {@code null}
* @since 3.4 * @since 3.4
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/similarity/FuzzyScore.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/similarity/FuzzyScore.html">
* FuzzyScore</a> instead * FuzzyScore</a> instead
*/ */
@ -2275,7 +2275,7 @@ public class StringUtils {
* @return result distance * @return result distance
* @throws IllegalArgumentException if either String input {@code null} * @throws IllegalArgumentException if either String input {@code null}
* @since 3.3 * @since 3.3
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/similarity/JaroWinklerDistance.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/similarity/JaroWinklerDistance.html">
* JaroWinklerDistance</a> instead * JaroWinklerDistance</a> instead
*/ */
@ -2328,7 +2328,7 @@ public class StringUtils {
* @throws IllegalArgumentException if either String input {@code null} * @throws IllegalArgumentException if either String input {@code null}
* @since 3.0 Changed signature from getLevenshteinDistance(String, String) to * @since 3.0 Changed signature from getLevenshteinDistance(String, String) to
* getLevenshteinDistance(CharSequence, CharSequence) * getLevenshteinDistance(CharSequence, CharSequence)
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/similarity/LevenshteinDistance.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/similarity/LevenshteinDistance.html">
* LevenshteinDistance</a> instead * LevenshteinDistance</a> instead
*/ */
@ -2419,7 +2419,7 @@ public class StringUtils {
* @param threshold the target threshold, must not be negative * @param threshold the target threshold, must not be negative
* @return result distance, or {@code -1} if the distance would be greater than the threshold * @return result distance, or {@code -1} if the distance would be greater than the threshold
* @throws IllegalArgumentException if either String input {@code null} or negative threshold * @throws IllegalArgumentException if either String input {@code null} or negative threshold
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/similarity/LevenshteinDistance.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/similarity/LevenshteinDistance.html">
* LevenshteinDistance</a> instead * LevenshteinDistance</a> instead
*/ */

View File

@ -25,7 +25,7 @@ import java.text.ParsePosition;
* Formats using one formatter and parses using a different formatter. An * 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 * example of use for this would be a webapp where data is taken in one way and
* stored in a database another way. * stored in a database another way.
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/CompositeFormat.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/CompositeFormat.html">
* CompositeFormat</a> instead * CompositeFormat</a> instead
*/ */

View File

@ -66,7 +66,7 @@ import org.apache.commons.lang3.Validate;
* </ul> * </ul>
* *
* @since 2.4 * @since 2.4
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/ExtendedMessageFormat.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/ExtendedMessageFormat.html">
* ExtendedMessageFormat</a> instead * ExtendedMessageFormat</a> instead
*/ */

View File

@ -23,7 +23,7 @@ import java.util.Locale;
* Format factory. * Format factory.
* *
* @since 2.4 * @since 2.4
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormatFactory.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormatFactory.html">
* FormatFactory</a> instead * FormatFactory</a> instead
*/ */

View File

@ -33,7 +33,7 @@ import org.apache.commons.lang3.Validate;
* and padding, and is not designed to allow generalised alternate formats.</p> * and padding, and is not designed to allow generalised alternate formats.</p>
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormattableUtils.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormattableUtils.html">
* FormattableUtils</a> instead * FormattableUtils</a> instead
*/ */

View File

@ -73,7 +73,7 @@ import org.apache.commons.lang3.builder.Builder;
* the interface. * the interface.
* *
* @since 2.2 * @since 2.2
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/TextStringBuilder.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/TextStringBuilder.html">
* TextStringBuilder</a> instead * TextStringBuilder</a> instead
*/ */

View File

@ -33,7 +33,7 @@ import java.util.Map;
* *
* @param <V> Unused. * @param <V> Unused.
* @since 2.2 * @since 2.2
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/lookup/StringLookupFactory.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/lookup/StringLookupFactory.html">
* StringLookupFactory</a> instead * StringLookupFactory</a> instead
*/ */

View File

@ -29,7 +29,7 @@ import org.apache.commons.lang3.StringUtils;
* If these do not suffice, you can subclass and implement your own matcher. * If these do not suffice, you can subclass and implement your own matcher.
* *
* @since 2.2 * @since 2.2
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/matcher/StringMatcherFactory.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/matcher/StringMatcherFactory.html">
* StringMatcherFactory</a> instead * StringMatcherFactory</a> instead
*/ */

View File

@ -121,7 +121,7 @@ import org.apache.commons.lang3.StringUtils;
* <p>This class is <b>not</b> thread safe.</p> * <p>This class is <b>not</b> thread safe.</p>
* *
* @since 2.2 * @since 2.2
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringSubstitutor.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringSubstitutor.html">
* StringSubstitutor</a> instead * StringSubstitutor</a> instead
*/ */

View File

@ -82,7 +82,7 @@ import org.apache.commons.lang3.StringUtils;
* </table> * </table>
* *
* @since 2.2 * @since 2.2
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringTokenizer.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringTokenizer.html">
* StringTokenizer</a> instead * StringTokenizer</a> instead
*/ */

View File

@ -30,7 +30,7 @@ import org.apache.commons.lang3.StringUtils;
* Each method documents its behavior in more detail.</p> * Each method documents its behavior in more detail.</p>
* *
* @since 2.0 * @since 2.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/WordUtils.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/WordUtils.html">
* WordUtils</a> instead * WordUtils</a> instead
*/ */

View File

@ -23,5 +23,8 @@
* While somewhat ungainly, the {@code Str} prefix has been used to ensure we don't clash with any current or future standard Java classes. </p> * While somewhat ungainly, the {@code Str} prefix has been used to ensure we don't clash with any current or future standard Java classes. </p>
* *
* @since 2.1 * @since 2.1
* @deprecated As of 3.6, use the Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/package-summary.html">
* text package</a>.
*/ */
package org.apache.commons.lang3.text; package org.apache.commons.lang3.text;

View File

@ -26,7 +26,7 @@ import org.apache.commons.lang3.ArrayUtils;
* the first translator consumes codepoints from the input. * the first translator consumes codepoints from the input.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/AggregateTranslator.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/AggregateTranslator.html">
* AggregateTranslator</a> instead * AggregateTranslator</a> instead
*/ */

View File

@ -27,7 +27,7 @@ import java.util.Locale;
* is completely contextual, the API does not present two separate signatures. * is completely contextual, the API does not present two separate signatures.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CharSequenceTranslator.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CharSequenceTranslator.html">
* CharSequenceTranslator</a> instead * CharSequenceTranslator</a> instead
*/ */

View File

@ -24,7 +24,7 @@ import java.io.Writer;
* will replace up to one character at a time. * will replace up to one character at a time.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html">
* CharSequenceTranslator</a> instead * CharSequenceTranslator</a> instead
*/ */

View File

@ -22,7 +22,7 @@ package org.apache.commons.lang3.text.translate;
* All arrays are of length [*][2]. * All arrays are of length [*][2].
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html">
* EntityArrays</a> instead * EntityArrays</a> instead
*/ */

View File

@ -20,7 +20,7 @@ package org.apache.commons.lang3.text.translate;
* Translates codepoints to their Unicode escaped value suitable for Java source. * Translates codepoints to their Unicode escaped value suitable for Java source.
* *
* @since 3.2 * @since 3.2
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html">
* UnicodeEscaper</a> instead * UnicodeEscaper</a> instead
*/ */

View File

@ -25,7 +25,7 @@ import java.util.HashSet;
* Translates a value using a lookup table. * Translates a value using a lookup table.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/LookupTranslator.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/LookupTranslator.html">
* LookupTranslator</a> instead * LookupTranslator</a> instead
*/ */

View File

@ -23,7 +23,7 @@ import java.io.Writer;
* Translates codepoints to their XML numeric entity escaped value. * Translates codepoints to their XML numeric entity escaped value.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityEscaper.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityEscaper.html">
* NumericEntityEscaper</a> instead * NumericEntityEscaper</a> instead
*/ */

View File

@ -29,7 +29,7 @@ import java.util.EnumSet;
* Note that the semicolon is optional. * Note that the semicolon is optional.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityUnescaper.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityUnescaper.html">
* NumericEntityUnescaper</a> instead * NumericEntityUnescaper</a> instead
*/ */

View File

@ -28,7 +28,7 @@ import java.io.Writer;
* 1 to 377. This is because parsing Java is the main use case. * 1 to 377. This is because parsing Java is the main use case.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/OctalUnescaper.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/OctalUnescaper.html">
* OctalUnescaper</a> instead * OctalUnescaper</a> instead
*/ */

View File

@ -23,7 +23,7 @@ import java.io.Writer;
* Translates codepoints to their Unicode escaped value. * Translates codepoints to their Unicode escaped value.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html">
* UnicodeEscaper</a> instead * UnicodeEscaper</a> instead
*/ */

View File

@ -25,7 +25,7 @@ import java.io.Writer;
* without the +. * without the +.
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnescaper.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnescaper.html">
* UnicodeUnescaper</a> instead * UnicodeUnescaper</a> instead
*/ */

View File

@ -22,7 +22,7 @@ import java.io.Writer;
/** /**
* Helper subclass to CharSequenceTranslator to remove unpaired surrogates. * Helper subclass to CharSequenceTranslator to remove unpaired surrogates.
* *
* @deprecated as of 3.6, use commons-text * @deprecated As of 3.6, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.html">
* UnicodeUnpairedSurrogateRemover</a> instead * UnicodeUnpairedSurrogateRemover</a> instead
*/ */

View File

@ -20,8 +20,8 @@
* <p>These classes are immutable, and therefore thread-safe.</p> * <p>These classes are immutable, and therefore thread-safe.</p>
* *
* @since 3.0 * @since 3.0
* @deprecated as of 3.6, use the commons-text * @deprecated As of 3.6, use the Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/package-summary.html"> * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/package-summary.html">
* translate package</a> instead * translate package</a>.
*/ */
package org.apache.commons.lang3.text.translate; package org.apache.commons.lang3.text.translate;