clean up javadoc; fix complaints from maven-javadoc-plugin
This commit is contained in:
Chas Honton
parent
3c92830ec5
commit
ac1c341558
File diff suppressed because it is too large
Load Diff
|
|
@ -4743,8 +4743,8 @@ public class StringUtils {
|
|||
* StringUtils.removeAll("any", ".*") = ""
|
||||
* StringUtils.removeAll("any", ".+") = ""
|
||||
* StringUtils.removeAll("abc", ".?") = ""
|
||||
* StringUtils.removeAll("A<__>\n<__>B", "<.*>") = "A\nB"
|
||||
* StringUtils.removeAll("A<__>\n<__>B", "(?s)<.*>") = "AB"
|
||||
* StringUtils.removeAll("A<__>\n<__>B", "<.*>") = "A\nB"
|
||||
* StringUtils.removeAll("A<__>\n<__>B", "(?s)<.*>") = "AB"
|
||||
* StringUtils.removeAll("ABCabc123abc", "[a-z]") = "ABC123"
|
||||
* </pre>
|
||||
*
|
||||
|
|
@ -4789,8 +4789,8 @@ public class StringUtils {
|
|||
* StringUtils.removeFirst("any", ".*") = ""
|
||||
* StringUtils.removeFirst("any", ".+") = ""
|
||||
* StringUtils.removeFirst("abc", ".?") = "bc"
|
||||
* StringUtils.removeFirst("A<__>\n<__>B", "<.*>") = "A\n<__>B"
|
||||
* StringUtils.removeFirst("A<__>\n<__>B", "(?s)<.*>") = "AB"
|
||||
* StringUtils.removeFirst("A<__>\n<__>B", "<.*>") = "A\n<__>B"
|
||||
* StringUtils.removeFirst("A<__>\n<__>B", "(?s)<.*>") = "AB"
|
||||
* StringUtils.removeFirst("ABCabc123", "[a-z]") = "ABCbc123"
|
||||
* StringUtils.removeFirst("ABCabc123abc", "[a-z]+") = "ABC123abc"
|
||||
* </pre>
|
||||
|
|
@ -4861,7 +4861,7 @@ public class StringUtils {
|
|||
* StringUtils.replacePattern("", "", "zzz") = "zzz"
|
||||
* StringUtils.replacePattern("", ".*", "zzz") = "zzz"
|
||||
* StringUtils.replacePattern("", ".+", "zzz") = ""
|
||||
* StringUtils.replacePattern("<__>\n<__>", "<.*>", "z") = "z"
|
||||
* StringUtils.replacePattern("<__>\n<__>", "<.*>", "z") = "z"
|
||||
* StringUtils.replacePattern("ABCabc123", "[a-z]", "_") = "ABC___123"
|
||||
* StringUtils.replacePattern("ABCabc123", "[^A-Z0-9]+", "_") = "ABC_123"
|
||||
* StringUtils.replacePattern("ABCabc123", "[^A-Z0-9]+", "") = "ABC123"
|
||||
|
|
@ -4903,7 +4903,7 @@ public class StringUtils {
|
|||
* <pre>
|
||||
* StringUtils.removePattern(null, *) = null
|
||||
* StringUtils.removePattern("any", null) = "any"
|
||||
* StringUtils.removePattern("A<__>\n<__>B", "<.*>") = "AB"
|
||||
* StringUtils.removePattern("A<__>\n<__>B", "<.*>") = "AB"
|
||||
* StringUtils.removePattern("ABCabc123", "[a-z]") = "ABC123"
|
||||
* </pre>
|
||||
*
|
||||
|
|
@ -4947,8 +4947,8 @@ public class StringUtils {
|
|||
* StringUtils.replaceAll("", ".*", "zzz") = "zzz"
|
||||
* StringUtils.replaceAll("", ".+", "zzz") = ""
|
||||
* StringUtils.replaceAll("abc", "", "ZZ") = "ZZaZZbZZcZZ"
|
||||
* StringUtils.replaceAll("<__>\n<__>", "<.*>", "z") = "z\nz"
|
||||
* StringUtils.replaceAll("<__>\n<__>", "(?s)<.*>", "z") = "z"
|
||||
* StringUtils.replaceAll("<__>\n<__>", "<.*>", "z") = "z\nz"
|
||||
* StringUtils.replaceAll("<__>\n<__>", "(?s)<.*>", "z") = "z"
|
||||
* StringUtils.replaceAll("ABCabc123", "[a-z]", "_") = "ABC___123"
|
||||
* StringUtils.replaceAll("ABCabc123", "[^A-Z0-9]+", "_") = "ABC_123"
|
||||
* StringUtils.replaceAll("ABCabc123", "[^A-Z0-9]+", "") = "ABC123"
|
||||
|
|
@ -5001,8 +5001,8 @@ public class StringUtils {
|
|||
* StringUtils.replaceFirst("", ".*", "zzz") = "zzz"
|
||||
* StringUtils.replaceFirst("", ".+", "zzz") = ""
|
||||
* StringUtils.replaceFirst("abc", "", "ZZ") = "ZZabc"
|
||||
* StringUtils.replaceFirst("<__>\n<__>", "<.*>", "z") = "z\n<__>"
|
||||
* StringUtils.replaceFirst("<__>\n<__>", "(?s)<.*>", "z") = "z"
|
||||
* StringUtils.replaceFirst("<__>\n<__>", "<.*>", "z") = "z\n<__>"
|
||||
* StringUtils.replaceFirst("<__>\n<__>", "(?s)<.*>", "z") = "z"
|
||||
* StringUtils.replaceFirst("ABCabc123", "[a-z]", "_") = "ABC_bc123"
|
||||
* StringUtils.replaceFirst("ABCabc123abc", "[^A-Z0-9]+", "_") = "ABC_123abc"
|
||||
* StringUtils.replaceFirst("ABCabc123abc", "[^A-Z0-9]+", "") = "ABC123abc"
|
||||
|
|
|
|||
|
|
@ -740,15 +740,15 @@ public class ExceptionUtils {
|
|||
* exceptions as checked.
|
||||
*
|
||||
* @since 3.5
|
||||
* @see {{@link #wrapAndThrow(Throwable)}
|
||||
* @see #wrapAndThrow(Throwable)
|
||||
*
|
||||
* @param throwable
|
||||
* The throwable to rethrow.
|
||||
* @return R Never actually returns, this generic type matches any type
|
||||
* @param <R> The type of the returned value.
|
||||
* @return Never actually returned, this generic type matches any type
|
||||
* which the calling site requires. "Returning" the results of this
|
||||
* method, as done in the propagateExample above, will satisfy the
|
||||
* java compiler requirement that all code paths return a value.
|
||||
* @throws throwable
|
||||
*/
|
||||
public static <R> R rethrow(Throwable throwable) {
|
||||
// claim that the typeErasure invocation throws a RuntimeException
|
||||
|
|
@ -777,15 +777,16 @@ public class ExceptionUtils {
|
|||
* determine if the caught exception was caused by the checked exception.
|
||||
*
|
||||
* @since 3.5
|
||||
* @see {{@link #rethrow(Throwable)}, {{@link #hasCause(Throwable, Class)}
|
||||
* @see #rethrow(Throwable)
|
||||
* @see #hasCause(Throwable, Class)
|
||||
*
|
||||
* @param throwable
|
||||
* The throwable to rethrow.
|
||||
* @return R Never actually returns, this generic type matches any type
|
||||
* @param <R> The type of the returned value.
|
||||
* @return Never actually returned, this generic type matches any type
|
||||
* which the calling site requires. "Returning" the results of this
|
||||
* method, will satisfy the java compiler requirement that all code
|
||||
* method will satisfy the java compiler requirement that all code
|
||||
* paths return a value.
|
||||
* @throws throwable
|
||||
*/
|
||||
public static <R> R wrapAndThrow(Throwable throwable) {
|
||||
if (throwable instanceof RuntimeException) {
|
||||
|
|
@ -802,7 +803,7 @@ public class ExceptionUtils {
|
|||
* of the given type?
|
||||
*
|
||||
* @since 3.5
|
||||
* @see {{@link #wrapAndThrow(Throwable)}
|
||||
* @see #wrapAndThrow(Throwable)
|
||||
*
|
||||
* @param chain
|
||||
* The root of a Throwable causal chain.
|
||||
|
|
|
|||
|
|
@ -1220,7 +1220,7 @@ public class StrSubstitutor {
|
|||
* <code>$${this-is-escaped}</code> becomes
|
||||
* <code>${this-is-escaped}</code>). The default value is <b>false</b>
|
||||
*
|
||||
* @param preserveEscapes
|
||||
* @param preserveEscapes true if escapes are to be preserved
|
||||
*/
|
||||
public void setPreserveEscapes(final boolean preserveEscapes) {
|
||||
this.preserveEscapes = preserveEscapes;
|
||||
|
|
|
|||
|
|
@ -16,12 +16,12 @@
|
|||
*/
|
||||
package org.apache.commons.lang3.text;
|
||||
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
import org.apache.commons.lang3.ArrayUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.commons.lang3.SystemUtils;
|
||||
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
/**
|
||||
* <p>Operations on Strings that contain words.</p>
|
||||
*
|
||||
|
|
@ -567,7 +567,7 @@ public class WordUtils {
|
|||
* <p>Checks if the String contains all words in the given array.</p>
|
||||
*
|
||||
* <p>
|
||||
* A {@code null} String will return {@code false}. A {@code null, zero
|
||||
* A {@code null} String will return {@code false}. A {@code null}, zero
|
||||
* length search array or if one element of array is null will return {@code false}.
|
||||
* </p>
|
||||
*
|
||||
|
|
@ -581,7 +581,7 @@ public class WordUtils {
|
|||
* </pre>
|
||||
*
|
||||
*
|
||||
* @param str The str to check, may be null
|
||||
* @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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -102,6 +102,7 @@ public interface DatePrinter {
|
|||
*
|
||||
* @param millis the millisecond value to format
|
||||
* @param buf the buffer to format into
|
||||
* @param <B> the Appendable class type, usually StringBuilder or StringBuffer.
|
||||
* @return the specified string buffer
|
||||
* @since 3.5
|
||||
*/
|
||||
|
|
@ -113,6 +114,7 @@ public interface DatePrinter {
|
|||
*
|
||||
* @param date the date to format
|
||||
* @param buf the buffer to format into
|
||||
* @param <B> the Appendable class type, usually StringBuilder or StringBuffer.
|
||||
* @return the specified string buffer
|
||||
* @since 3.5
|
||||
*/
|
||||
|
|
@ -126,6 +128,7 @@ public interface DatePrinter {
|
|||
*
|
||||
* @param calendar the calendar to format
|
||||
* @param buf the buffer to format into
|
||||
* @param <B> the Appendable class type, usually StringBuilder or StringBuffer.
|
||||
* @return the specified string buffer
|
||||
* @since 3.5
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -658,9 +658,9 @@ public class FastDateFormat extends Format implements DateParser, DatePrinter {
|
|||
/**
|
||||
* <p>Performs the formatting by applying the rules to the
|
||||
* specified calendar.</p>
|
||||
* @deprecated Use {{@link #format(Calendar, Appendable)
|
||||
* @deprecated Use {@link #format(Calendar, Appendable)}
|
||||
*
|
||||
* @param calendar the calendar to format
|
||||
* @param calendar the calendar to format
|
||||
* @param buf the buffer to format into
|
||||
* @return the specified string buffer
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -124,8 +124,6 @@ public class FastDateParser implements DateParser, Serializable {
|
|||
* @param timeZone non-null time zone to use
|
||||
* @param locale non-null locale
|
||||
* @param centuryStart The start of the century for 2 digit year parsing
|
||||
* @param lenient if true, non-standard values for Calendar fields should be accepted;
|
||||
* if false, non-standard values will cause a ParseException to be thrown {@link CalendaretLenient(boolean)}
|
||||
*
|
||||
* @since 3.5
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -545,6 +545,7 @@ public class FastDatePrinter implements DatePrinter, Serializable {
|
|||
*
|
||||
* @param calendar the calendar to format
|
||||
* @param buf the buffer to format into
|
||||
* @param <B> the Appendable class type, usually StringBuilder or StringBuffer.
|
||||
* @return the specified string buffer
|
||||
*/
|
||||
protected <B extends Appendable> B applyRules(final Calendar calendar, final B buf) {
|
||||
|
|
|
|||
Loading…
Reference in New Issue