Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc @see tags do not need to use a FQCN for classes in java.lang

This commit is contained in:
Gary Gregory 2022-08-29 07:17:06 -04:00
parent 34168aa99d
commit 843fa377c8
14 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/java/org/apache/commons/lang3/CharSetUtils.java
View File

@ -44,7 +44,7 @@ public class CharSetUtils {
* CharSetUtils.containsAny("hello", "a-d") = false
* </pre>
*
* @see CharSet#getInstance(java.lang.String...) for set-syntax.
* @see CharSet#getInstance(String...) for set-syntax.
* @param str String to look for characters in, may be null
* @param set String[] set of characters to identify, may be null
* @return whether or not the characters in the set are in the primary string
@ -76,7 +76,7 @@ public class CharSetUtils {
* CharSetUtils.count("hello", "a-e") = 1
* </pre>
*
* @see CharSet#getInstance(java.lang.String...) for set-syntax.
* @see CharSet#getInstance(String...) for set-syntax.
* @param str String to count characters in, may be null
* @param set String[] set of characters to count, may be null
* @return the character count, zero if null string input
@ -119,7 +119,7 @@ public class CharSetUtils {
* CharSetUtils.delete("hello", "le") = "ho"
* </pre>
*
* @see CharSet#getInstance(java.lang.String...) for set-syntax.
* @see CharSet#getInstance(String...) for set-syntax.
* @param str String to delete characters from, may be null
* @param set String[] set of characters to delete, may be null
* @return the modified String, {@code null} if null string input
@ -144,7 +144,7 @@ public class CharSetUtils {
* CharSetUtils.keep("hello", "le") = "ell"
* </pre>
*
* @see CharSet#getInstance(java.lang.String...) for set-syntax.
* @see CharSet#getInstance(String...) for set-syntax.
* @param str String to keep characters from, may be null
* @param set String[] set of characters to keep, may be null
* @return the modified String, {@code null} if null string input
@ -193,7 +193,7 @@ public class CharSetUtils {
* CharSetUtils.squeeze("hello", "a-e") = "hello"
* </pre>
*
* @see CharSet#getInstance(java.lang.String...) for set-syntax.
* @see CharSet#getInstance(String...) for set-syntax.
* @param str the string to squeeze, may be null
* @param set the character set to use for manipulation, may be null
* @return the modified String, {@code null} if null string input

6
src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
View File

@ -653,7 +653,7 @@ public class StringEscapeUtils {
*
* @param input the {@link String} to escape, may be null
* @return a new escaped {@link String}, {@code null} if null string input
* @see #unescapeXml(java.lang.String)
* @see #unescapeXml(String)
* @deprecated use {@link #escapeXml10(java.lang.String)} or {@link #escapeXml11(java.lang.String)} instead.
*/
@Deprecated
@ -686,7 +686,7 @@ public class StringEscapeUtils {
*
* @param input the {@link String} to escape, may be null
* @return a new escaped {@link String}, {@code null} if null string input
* @see #unescapeXml(java.lang.String)
* @see #unescapeXml(String)
* @since 3.3
*/
public static String escapeXml10(final String input) {
@ -716,7 +716,7 @@ public class StringEscapeUtils {
*
* @param input the {@link String} to escape, may be null
* @return a new escaped {@link String}, {@code null} if null string input
* @see #unescapeXml(java.lang.String)
* @see #unescapeXml(String)
* @since 3.3
*/
public static String escapeXml11(final String input) {

14
src/main/java/org/apache/commons/lang3/StringUtils.java
View File

@ -118,7 +118,7 @@ import org.apache.commons.lang3.stream.Streams;
* The symbol {@code *} is used to indicate any input including {@code null}.</p>
*
* <p>#ThreadSafe#</p>
* @see java.lang.String
* @see String
* @since 1.0
*/
//@Immutable
@ -1670,7 +1670,7 @@ public class StringUtils {
* StringUtils.endsWith("ABCDEF", "") = true
* </pre>
*
* @see java.lang.String#endsWith(String)
* @see String#endsWith(String)
* @param str the CharSequence to check, may be null
* @param suffix the suffix to find, may be null
* @return {@code true} if the CharSequence ends with the suffix, case-sensitive, or
@ -1685,7 +1685,7 @@ public class StringUtils {
/**
* Check if a CharSequence ends with a specified suffix (optionally case insensitive).
*
* @see java.lang.String#endsWith(String)
* @see String#endsWith(String)
* @param str the CharSequence to check, may be null
* @param suffix the suffix to find, may be null
* @param ignoreCase indicates whether the compare should ignore case
@ -1752,7 +1752,7 @@ public class StringUtils {
* StringUtils.endsWithIgnoreCase("ABCDEF", "cde") = false
* </pre>
*
* @see java.lang.String#endsWith(String)
* @see String#endsWith(String)
* @param str the CharSequence to check, may be null
* @param suffix the suffix to find, may be null
* @return {@code true} if the CharSequence ends with the suffix, case-insensitive, or
@ -7960,7 +7960,7 @@ public class StringUtils {
* StringUtils.startsWith("ABCDEF", "abc") = false
* </pre>
*
* @see java.lang.String#startsWith(String)
* @see String#startsWith(String)
* @param str the CharSequence to check, may be null
* @param prefix the prefix to find, may be null
* @return {@code true} if the CharSequence starts with the prefix, case-sensitive, or
@ -7975,7 +7975,7 @@ public class StringUtils {
/**
* Check if a CharSequence starts with a specified prefix (optionally case insensitive).
*
* @see java.lang.String#startsWith(String)
* @see String#startsWith(String)
* @param str the CharSequence to check, may be null
* @param prefix the prefix to find, may be null
* @param ignoreCase indicates whether the compare should ignore case
@ -8043,7 +8043,7 @@ public class StringUtils {
* StringUtils.startsWithIgnoreCase("ABCDEF", "abc") = true
* </pre>
*
* @see java.lang.String#startsWith(String)
* @see String#startsWith(String)
* @param str the CharSequence to check, may be null
* @param prefix the prefix to find, may be null
* @return {@code true} if the CharSequence starts with the prefix, case-insensitive, or

4
src/main/java/org/apache/commons/lang3/ThreadUtils.java
View File

@ -34,8 +34,8 @@ import org.apache.commons.lang3.time.DurationUtils;
* #ThreadSafe#
* </p>
*
* @see java.lang.Thread
* @see java.lang.ThreadGroup
* @see Thread
* @see ThreadGroup
* @since 3.5
*/
public class ThreadUtils {

6
src/main/java/org/apache/commons/lang3/Validate.java
View File

@ -41,7 +41,7 @@ import java.util.regex.Pattern;
* </pre>
*
* <p>#ThreadSafe#</p>
* @see java.lang.String#format(String, Object...)
* @see String#format(String, Object...)
* @since 2.0
*/
public class Validate {
@ -837,7 +837,7 @@ public class Validate {
*
* @param value the value to validate
* @throws IllegalArgumentException if the value is not a number
* @see #notNaN(double, java.lang.String, java.lang.Object...)
* @see #notNaN(double, java.lang.String, Object...)
*
* @since 3.5
*/
@ -875,7 +875,7 @@ public class Validate {
*
* @param value the value to validate
* @throws IllegalArgumentException if the value is infinite or Not-a-Number (NaN)
* @see #finite(double, java.lang.String, java.lang.Object...)
* @see #finite(double, java.lang.String, Object...)
*
* @since 3.5
*/

6
src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
View File

@ -87,9 +87,9 @@ import org.apache.commons.lang3.ObjectUtils;
* {@link Class#getDeclaredFields()}. The fields of the class are compared first, followed by those
* of its parent classes (in order from the bottom to the top of the class hierarchy).</p>
*
* @see java.lang.Comparable
* @see java.lang.Object#equals(Object)
* @see java.lang.Object#hashCode()
* @see Comparable
* @see Object#equals(Object)
* @see Object#hashCode()
* @see EqualsBuilder
* @see HashCodeBuilder
* @since 1.0

8
src/main/java/org/apache/commons/lang3/builder/package-info.java
View File

@ -23,10 +23,10 @@
* Well {@link org.apache.commons.lang3.builder.HashCodeBuilder} will save your day.
* It, and its buddies ({@link org.apache.commons.lang3.builder.EqualsBuilder}, {@link org.apache.commons.lang3.builder.CompareToBuilder}, {@link org.apache.commons.lang3.builder.ToStringBuilder}), take care of the nasty bits while you focus on the important bits, like which fields will go into making up the hashcode.</p>
*
* @see java.lang.Object#equals(Object)
* @see java.lang.Object#toString()
* @see java.lang.Object#hashCode()
* @see java.lang.Comparable#compareTo(Object)
* @see Object#equals(Object)
* @see Object#toString()
* @see Object#hashCode()
* @see Comparable#compareTo(Object)
*
* @since 1.0
*/

4
src/main/java/org/apache/commons/lang3/exception/ContextedException.java
View File

@ -224,7 +224,7 @@ public class ContextedException extends Exception implements ExceptionContext {
/**
* Provides the message explaining the exception, including the contextual data.
*
* @see java.lang.Throwable#getMessage()
* @see Throwable#getMessage()
* @return the message, never null
*/
@Override
@ -235,7 +235,7 @@ public class ContextedException extends Exception implements ExceptionContext {
/**
* Provides the message explaining the exception without the contextual data.
*
* @see java.lang.Throwable#getMessage()
* @see Throwable#getMessage()
* @return the message
* @since 3.0.1
*/

4
src/main/java/org/apache/commons/lang3/exception/ContextedRuntimeException.java
View File

@ -224,7 +224,7 @@ public class ContextedRuntimeException extends RuntimeException implements Excep
/**
* Provides the message explaining the exception, including the contextual data.
*
* @see java.lang.Throwable#getMessage()
* @see Throwable#getMessage()
* @return the message, never null
*/
@Override
@ -235,7 +235,7 @@ public class ContextedRuntimeException extends RuntimeException implements Excep
/**
* Provides the message explaining the exception without the contextual data.
*
* @see java.lang.Throwable#getMessage()
* @see Throwable#getMessage()
* @return the message
* @since 3.0.1
*/

2
src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
View File

@ -366,7 +366,7 @@ public class MutableFloat extends Number implements Comparable<MutableFloat>, Mu
*
* @param obj the object to compare with, null returns false
* @return {@code true} if the objects are the same; {@code false} otherwise.
* @see java.lang.Float#floatToIntBits(float)
* @see Float#floatToIntBits(float)
*/
@Override
public boolean equals(final Object obj) {

6
src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
View File

@ -73,7 +73,7 @@ public class ConstructorUtils {
* @throws IllegalAccessException if invocation is not permitted by security
* @throws InvocationTargetException if an error occurs on invocation
* @throws InstantiationException if an error occurs on instantiation
* @see #invokeConstructor(java.lang.Class, java.lang.Object[], java.lang.Class[])
* @see #invokeConstructor(java.lang.Class, java.lang.Object[], Class[])
*/
public static <T> T invokeConstructor(final Class<T> cls, Object... args)
throws NoSuchMethodException, IllegalAccessException, InvocationTargetException,
@ -136,7 +136,7 @@ public class ConstructorUtils {
* @throws IllegalAccessException if invocation is not permitted by security
* @throws InvocationTargetException if an error occurs on invocation
* @throws InstantiationException if an error occurs on instantiation
* @see #invokeExactConstructor(java.lang.Class, java.lang.Object[], java.lang.Class[])
* @see #invokeExactConstructor(java.lang.Class, java.lang.Object[], Class[])
*/
public static <T> T invokeExactConstructor(final Class<T> cls, Object... args)
throws NoSuchMethodException, IllegalAccessException, InvocationTargetException,
@ -210,7 +210,7 @@ public class ConstructorUtils {
* @param <T> the constructor type
* @param ctor the prototype constructor object, not {@code null}
* @return the constructor, {@code null} if no matching accessible constructor found
* @see java.lang.SecurityManager
* @see SecurityManager
* @throws NullPointerException if {@code ctor} is {@code null}
*/
public static <T> Constructor<T> getAccessibleConstructor(final Constructor<T> ctor) {

8
src/main/java/org/apache/commons/lang3/time/FastDateFormat.java
View File

@ -540,7 +540,7 @@ public class FastDateFormat extends Format implements DateParser, DatePrinter {
/* (non-Javadoc)
* @see DateParser#parse(java.lang.String)
* @see DateParser#parse(String)
*/
@Override
public Date parse(final String source) throws ParseException {
@ -548,7 +548,7 @@ public class FastDateFormat extends Format implements DateParser, DatePrinter {
}
/* (non-Javadoc)
* @see DateParser#parse(java.lang.String, java.text.ParsePosition)
* @see DateParser#parse(String, java.text.ParsePosition)
*/
@Override
public Date parse(final String source, final ParsePosition pos) {
@ -557,7 +557,7 @@ public class FastDateFormat extends Format implements DateParser, DatePrinter {
/*
* (non-Javadoc)
* @see org.apache.commons.lang3.time.DateParser#parse(java.lang.String, java.text.ParsePosition, java.util.Calendar)
* @see org.apache.commons.lang3.time.DateParser#parse(String, java.text.ParsePosition, java.util.Calendar)
*/
@Override
public boolean parse(final String source, final ParsePosition pos, final Calendar calendar) {
@ -565,7 +565,7 @@ public class FastDateFormat extends Format implements DateParser, DatePrinter {
}
/* (non-Javadoc)
* @see java.text.Format#parseObject(java.lang.String, java.text.ParsePosition)
* @see java.text.Format#parseObject(String, java.text.ParsePosition)
*/
@Override
public Object parseObject(final String source, final ParsePosition pos) {

8
src/main/java/org/apache/commons/lang3/time/FastDateParser.java
View File

@ -367,7 +367,7 @@ public class FastDateParser implements DateParser, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DateParser#parseObject(java.lang.String)
* @see org.apache.commons.lang3.time.DateParser#parseObject(String)
*/
@Override
public Object parseObject(final String source) throws ParseException {
@ -375,7 +375,7 @@ public class FastDateParser implements DateParser, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DateParser#parse(java.lang.String)
* @see org.apache.commons.lang3.time.DateParser#parse(String)
*/
@Override
public Date parse(final String source) throws ParseException {
@ -393,7 +393,7 @@ public class FastDateParser implements DateParser, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DateParser#parseObject(java.lang.String, java.text.ParsePosition)
* @see org.apache.commons.lang3.time.DateParser#parseObject(String, java.text.ParsePosition)
*/
@Override
public Object parseObject(final String source, final ParsePosition pos) {
@ -410,7 +410,7 @@ public class FastDateParser implements DateParser, Serializable {
* given by {@link ParsePosition#getIndex()} has been updated. If the input buffer has been fully
* parsed, then the index will point to just after the end of the input buffer.
*
* @see org.apache.commons.lang3.time.DateParser#parse(java.lang.String, java.text.ParsePosition)
* @see org.apache.commons.lang3.time.DateParser#parse(String, java.text.ParsePosition)
*/
@Override
public Date parse(final String source, final ParsePosition pos) {

12
src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
View File

@ -495,7 +495,7 @@ public class FastDatePrinter implements DatePrinter, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DatePrinter#format(long, java.lang.StringBuffer)
* @see org.apache.commons.lang3.time.DatePrinter#format(long, StringBuffer)
*/
@Override
public StringBuffer format(final long millis, final StringBuffer buf) {
@ -505,7 +505,7 @@ public class FastDatePrinter implements DatePrinter, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DatePrinter#format(java.util.Date, java.lang.StringBuffer)
* @see org.apache.commons.lang3.time.DatePrinter#format(java.util.Date, StringBuffer)
*/
@Override
public StringBuffer format(final Date date, final StringBuffer buf) {
@ -515,7 +515,7 @@ public class FastDatePrinter implements DatePrinter, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DatePrinter#format(java.util.Calendar, java.lang.StringBuffer)
* @see org.apache.commons.lang3.time.DatePrinter#format(java.util.Calendar, StringBuffer)
*/
@Override
public StringBuffer format(final Calendar calendar, final StringBuffer buf) {
@ -524,7 +524,7 @@ public class FastDatePrinter implements DatePrinter, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DatePrinter#format(long, java.lang.Appendable)
* @see org.apache.commons.lang3.time.DatePrinter#format(long, Appendable)
*/
@Override
public <B extends Appendable> B format(final long millis, final B buf) {
@ -534,7 +534,7 @@ public class FastDatePrinter implements DatePrinter, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DatePrinter#format(java.util.Date, java.lang.Appendable)
* @see org.apache.commons.lang3.time.DatePrinter#format(java.util.Date, Appendable)
*/
@Override
public <B extends Appendable> B format(final Date date, final B buf) {
@ -544,7 +544,7 @@ public class FastDatePrinter implements DatePrinter, Serializable {
}
/* (non-Javadoc)
* @see org.apache.commons.lang3.time.DatePrinter#format(java.util.Calendar, java.lang.Appendable)
* @see org.apache.commons.lang3.time.DatePrinter#format(java.util.Calendar, Appendable)
*/
@Override
public <B extends Appendable> B format(Calendar calendar, final B buf) {