Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Feb 5, 2025
1 parent 1286cc2 commit 9923a60
Show file tree
Hide file tree
Showing 24 changed files with 51 additions and 51 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
* 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.
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/CompositeFormat.html">
* CompositeFormat</a> instead
* CompositeFormat</a>.
*/
@Deprecated
public class CompositeFormat extends Format {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@
* </ul>
*
* @since 2.4
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/ExtendedMessageFormat.html">
* ExtendedMessageFormat</a> instead
* ExtendedMessageFormat</a>.
*/
@Deprecated
public class ExtendedMessageFormat extends MessageFormat {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
* Format factory.
*
* @since 2.4
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormatFactory.html">
* FormatFactory</a> instead
* FormatFactory</a>.
*/
@Deprecated
public interface FormatFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
* and padding, and is not designed to allow generalized alternate formats.</p>
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormattableUtils.html">
* FormattableUtils</a> instead
* FormattableUtils</a>.
*/
@Deprecated
public class FormattableUtils {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/lang3/text/StrBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@
* </p>
*
* @since 2.2
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/TextStringBuilder.html">
* TextStringBuilder</a> instead
* TextStringBuilder</a>.
*/
@Deprecated
public class StrBuilder implements CharSequence, Appendable, Serializable, Builder<String> {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/lang3/text/StrLookup.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@
*
* @param <V> Unused.
* @since 2.2
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/lookup/StringLookupFactory.html">
* StringLookupFactory</a> instead
* StringLookupFactory</a>.
*/
@Deprecated
public abstract class StrLookup<V> {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/lang3/text/StrMatcher.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
* </p>
*
* @since 2.2
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/matcher/StringMatcherFactory.html">
* StringMatcherFactory</a> instead
* StringMatcherFactory</a>.
*/
@Deprecated
public abstract class StrMatcher {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@
* </p>
*
* @since 2.2
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringSubstitutor.html">
* StringSubstitutor</a> instead
* StringSubstitutor</a>.
*/
@Deprecated
public class StrSubstitutor {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,9 @@
* </table>
*
* @since 2.2
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringTokenizer.html">
* StringTokenizer</a> instead
* StringTokenizer</a>.
*/
@Deprecated
public class StrTokenizer implements ListIterator<String>, Cloneable {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/lang3/text/WordUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
* Each method documents its behavior in more detail.</p>
*
* @since 2.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/WordUtils.html">
* WordUtils</a> instead
* WordUtils</a>.
*/
@Deprecated
public class WordUtils {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/lang3/text/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*/

/**
* Provides classes for handling and manipulating text, partly as an extension to {@link java.text}. The classes in this package are, for the most part,
* Deprecated: Provides classes for handling and manipulating text, partly as an extension to {@link java.text}. The classes in this package are, for the most part,
* intended to be instantiated (i.e. they are not utility classes with lots of static methods).
*
* <p>
Expand All @@ -26,7 +26,7 @@
* ensure we don't clash with any current or future standard Java classes.
* </p>
* <p>
* <strong>Deprecated</strong> As of 3.6, use the Apache Commons Text
* <strong>Deprecated</strong> As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, 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>.
* </p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
* the first translator consumes code points from the input.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/AggregateTranslator.html">
* AggregateTranslator</a> instead
* AggregateTranslator</a>.
*/
@Deprecated
public class AggregateTranslator extends CharSequenceTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@
* is completely contextual, the API does not present two separate signatures.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CharSequenceTranslator.html">
* CharSequenceTranslator</a> instead
* CharSequenceTranslator</a>.
*/
@Deprecated
public abstract class CharSequenceTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
* will replace up to one character at a time.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html">
* CharSequenceTranslator</a> instead
* CharSequenceTranslator</a>.
*/
@Deprecated
public abstract class CodePointTranslator extends CharSequenceTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
* All arrays are of length [*][2].
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html">
* EntityArrays</a> instead
* EntityArrays</a>.
*/
@Deprecated
public class EntityArrays {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
* Translates code points to their Unicode escaped value suitable for Java source.
*
* @since 3.2
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html">
* UnicodeEscaper</a> instead
* UnicodeEscaper</a>.
*/
@Deprecated
public class JavaUnicodeEscaper extends UnicodeEscaper {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
* Translates a value using a lookup table.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/LookupTranslator.html">
* LookupTranslator</a> instead
* LookupTranslator</a>.
*/
@Deprecated
public class LookupTranslator extends CharSequenceTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
* Translates code points to their XML numeric entity escaped value.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityEscaper.html">
* NumericEntityEscaper</a> instead
* NumericEntityEscaper</a>.
*/
@Deprecated
public class NumericEntityEscaper extends CodePointTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,14 @@
import java.util.EnumSet;

/**
* Translate XML numeric entities of the form &amp;#[xX]?\d+;? to
* the specific code point.
* Translate XML numeric entities of the form &amp;#[xX]?\d+;? to the specific code point.
*
* Note that the semicolon is optional.
*
* @since 3.0
* @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">
* NumericEntityUnescaper</a> instead
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityUnescaper.html">
* NumericEntityUnescaper</a>.
*/
@Deprecated
public class NumericEntityUnescaper extends CharSequenceTranslator {
Expand All @@ -41,6 +40,7 @@ public class NumericEntityUnescaper extends CharSequenceTranslator {
*
* @deprecated As of 3.18.0, use Apache Commons Text <a href=
* "https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityUnescaper.OPTION.html">
* NumericEntityUnescaper.OPTION</a>.
*/
@Deprecated
public enum OPTION {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@
* 1 to 377. This is because parsing Java is the main use case.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/OctalUnescaper.html">
* OctalUnescaper</a> instead
* OctalUnescaper</a>.
*/
@Deprecated
public class OctalUnescaper extends CharSequenceTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
* Translates code points to their Unicode escaped value.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html">
* UnicodeEscaper</a> instead
* UnicodeEscaper</a>.
*/
@Deprecated
public class UnicodeEscaper extends CodePointTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
* without the +.
*
* @since 3.0
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnescaper.html">
* UnicodeUnescaper</a> instead
* UnicodeUnescaper</a>.
*/
@Deprecated
public class UnicodeUnescaper extends CharSequenceTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
/**
* Helper subclass to CharSequenceTranslator to remove unpaired surrogates.
*
* @deprecated As of 3.6, use Apache Commons Text
* @deprecated As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, use Apache Commons Text
* <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.html">
* UnicodeUnpairedSurrogateRemover</a> instead
* UnicodeUnpairedSurrogateRemover</a>.
*/
@Deprecated
public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
*/

/**
* 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
* Deprecated: Provides 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>
* These classes are immutable, and therefore thread-safe.
* </p>
* <p>
* <strong>Deprecated</strong> As of 3.6, use the Apache Commons Text
* <strong>Deprecated</strong> As of <a href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6">3.6</a>, 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"> translate package</a>.
* </p>
*
Expand Down

0 comments on commit 9923a60

Please sign in to comment.