Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@garydgregory
garydgregory committed Sep 15, 2024
1 parent 4b621c8 commit c2cd052
Showing 1 changed file with 37 additions and 37 deletions.
74 changes: 37 additions & 37 deletions src/main/java/org/apache/commons/lang3/StringUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ public static int compareIgnoreCase(final String str1, final String str2, final
}

/**
* Checks if CharSequence contains a search CharSequence, handling {@code null}.
* Tests if CharSequence contains a search CharSequence, handling {@code null}.
* This method uses {@link String#indexOf(String)} if possible.
*
* <p>A {@code null} CharSequence will return {@code false}.</p>
Expand Down Expand Up @@ -993,7 +993,7 @@ public static boolean contains(final CharSequence seq, final CharSequence search
}

/**
* Checks if CharSequence contains a search character, handling {@code null}.
* Tests if CharSequence contains a search character, handling {@code null}.
* This method uses {@link String#indexOf(int)} if possible.
*
* <p>A {@code null} or empty ("") CharSequence will return {@code false}.</p>
Expand All @@ -1020,7 +1020,7 @@ public static boolean contains(final CharSequence seq, final int searchChar) {
}

/**
* Checks if the CharSequence contains any character in the given
* Tests if the CharSequence contains any character in the given
* set of characters.
*
* <p>A {@code null} CharSequence will return {@code false}.
Expand Down Expand Up @@ -1074,7 +1074,7 @@ public static boolean containsAny(final CharSequence cs, final char... searchCha
}

/**
* Checks if the CharSequence contains any character in the given set of characters.
* Tests if the CharSequence contains any character in the given set of characters.
*
* <p>
* A {@code null} CharSequence will return {@code false}. A {@code null} search CharSequence will return
Expand Down Expand Up @@ -1110,7 +1110,7 @@ public static boolean containsAny(final CharSequence cs, final CharSequence sear
}

/**
* Checks if the CharSequence contains any of the CharSequences in the given array.
* Tests if the CharSequence contains any of the CharSequences in the given array.
*
* <p>
* A {@code null} {@code cs} CharSequence will return {@code false}. A {@code null} or zero length search array will
Expand Down Expand Up @@ -1138,7 +1138,7 @@ public static boolean containsAny(final CharSequence cs, final CharSequence... s
}

/**
* Checks if the CharSequence contains any of the CharSequences in the given array.
* Tests if the CharSequence contains any of the CharSequences in the given array.
*
* <p>
* A {@code null} {@code cs} CharSequence will return {@code false}. A {@code null} or zero length search array will
Expand All @@ -1165,7 +1165,7 @@ private static boolean containsAny(final ToBooleanBiFunction<CharSequence, CharS
}

/**
* Checks if the CharSequence contains any of the CharSequences in the given array, ignoring case.
* Tests if the CharSequence contains any of the CharSequences in the given array, ignoring case.
*
* <p>
* A {@code null} {@code cs} CharSequence will return {@code false}. A {@code null} or zero length search array will
Expand Down Expand Up @@ -1195,7 +1195,7 @@ public static boolean containsAnyIgnoreCase(final CharSequence cs, final CharSeq
}

/**
* Checks if CharSequence contains a search CharSequence irrespective of case,
* Tests if CharSequence contains a search CharSequence irrespective of case,
* handling {@code null}. Case-insensitivity is defined as by
* {@link String#equalsIgnoreCase(String)}.
*
Expand Down Expand Up @@ -1233,7 +1233,7 @@ public static boolean containsIgnoreCase(final CharSequence str, final CharSeque
}

/**
* Checks that the CharSequence does not contain certain characters.
* Tests that the CharSequence does not contain certain characters.
*
* <p>A {@code null} CharSequence will return {@code true}.
* A {@code null} invalid character array will return {@code true}.
Expand Down Expand Up @@ -1285,7 +1285,7 @@ public static boolean containsNone(final CharSequence cs, final char... searchCh
}

/**
* Checks that the CharSequence does not contain certain characters.
* Tests that the CharSequence does not contain certain characters.
*
* <p>A {@code null} CharSequence will return {@code true}.
* A {@code null} invalid character array will return {@code true}.
Expand Down Expand Up @@ -1315,7 +1315,7 @@ public static boolean containsNone(final CharSequence cs, final String invalidCh
}

/**
* Checks if the CharSequence contains only certain characters.
* Tests if the CharSequence contains only certain characters.
*
* <p>A {@code null} CharSequence will return {@code false}.
* A {@code null} valid character array will return {@code false}.
Expand Down Expand Up @@ -1351,7 +1351,7 @@ public static boolean containsOnly(final CharSequence cs, final char... valid) {
}

/**
* Checks if the CharSequence contains only certain characters.
* Tests if the CharSequence contains only certain characters.
*
* <p>A {@code null} CharSequence will return {@code false}.
* A {@code null} valid character String will return {@code false}.
Expand Down Expand Up @@ -1381,7 +1381,7 @@ public static boolean containsOnly(final CharSequence cs, final String validChar
}

/**
* Check whether the given CharSequence contains any whitespace characters.
* Tests whether the given CharSequence contains any whitespace characters.
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
Expand Down Expand Up @@ -1714,7 +1714,7 @@ public static String difference(final String str1, final String str2) {
}

/**
* Check if a CharSequence ends with a specified suffix.
* Tests if a CharSequence ends with a specified suffix.
*
* <p>{@code null}s are handled without exceptions. Two {@code null}
* references are considered to be equal. The comparison is case-sensitive.</p>
Expand Down Expand Up @@ -1742,7 +1742,7 @@ public static boolean endsWith(final CharSequence str, final CharSequence suffix
}

/**
* Check if a CharSequence ends with a specified suffix (optionally case-insensitive).
* Tests if a CharSequence ends with a specified suffix (optionally case-insensitive).
*
* @see String#endsWith(String)
* @param str the CharSequence to check, may be null
Expand All @@ -1764,7 +1764,7 @@ private static boolean endsWith(final CharSequence str, final CharSequence suffi
}

/**
* Check if a CharSequence ends with any of the provided case-sensitive suffixes.
* Tests if a CharSequence ends with any of the provided case-sensitive suffixes.
*
* <pre>
* StringUtils.endsWithAny(null, null) = false
Expand Down Expand Up @@ -3223,7 +3223,7 @@ public static int indexOfIgnoreCase(final CharSequence str, final CharSequence s
}

/**
* Checks if all of the CharSequences are empty (""), null or whitespace only.
* Tests if all of the CharSequences are empty (""), null or whitespace only.
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
Expand Down Expand Up @@ -3256,7 +3256,7 @@ public static boolean isAllBlank(final CharSequence... css) {
}

/**
* Checks if all of the CharSequences are empty ("") or null.
* Tests if all of the CharSequences are empty ("") or null.
*
* <pre>
* StringUtils.isAllEmpty(null) = true
Expand Down Expand Up @@ -3287,7 +3287,7 @@ public static boolean isAllEmpty(final CharSequence... css) {
}

/**
* Checks if the CharSequence contains only lowercase characters.
* Tests if the CharSequence contains only lowercase characters.
*
* <p>{@code null} will return {@code false}.
* An empty CharSequence (length()=0) will return {@code false}.</p>
Expand Down Expand Up @@ -3322,7 +3322,7 @@ public static boolean isAllLowerCase(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains only uppercase characters.
* Tests if the CharSequence contains only uppercase characters.
*
* <p>{@code null} will return {@code false}.
* An empty String (length()=0) will return {@code false}.</p>
Expand Down Expand Up @@ -3357,7 +3357,7 @@ public static boolean isAllUpperCase(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains only Unicode letters.
* Tests if the CharSequence contains only Unicode letters.
*
* <p>{@code null} will return {@code false}.
* An empty CharSequence (length()=0) will return {@code false}.</p>
Expand Down Expand Up @@ -3390,7 +3390,7 @@ public static boolean isAlpha(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains only Unicode letters or digits.
* Tests if the CharSequence contains only Unicode letters or digits.
*
* <p>{@code null} will return {@code false}.
* An empty CharSequence (length()=0) will return {@code false}.</p>
Expand Down Expand Up @@ -3425,7 +3425,7 @@ public static boolean isAlphanumeric(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains only Unicode letters, digits
* Tests if the CharSequence contains only Unicode letters, digits
* or space ({@code ' '}).
*
* <p>{@code null} will return {@code false}.
Expand Down Expand Up @@ -3461,7 +3461,7 @@ public static boolean isAlphanumericSpace(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains only Unicode letters and
* Tests if the CharSequence contains only Unicode letters and
* space (' ').
*
* <p>{@code null} will return {@code false}
Expand Down Expand Up @@ -3497,7 +3497,7 @@ public static boolean isAlphaSpace(final CharSequence cs) {
}

/**
* Checks if any of the CharSequences are empty ("") or null or whitespace only.
* Tests if any of the CharSequences are empty ("") or null or whitespace only.
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
Expand Down Expand Up @@ -3532,7 +3532,7 @@ public static boolean isAnyBlank(final CharSequence... css) {
}

/**
* Checks if any of the CharSequences are empty ("") or null.
* Tests if any of the CharSequences are empty ("") or null.
*
* <pre>
* StringUtils.isAnyEmpty((String) null) = true
Expand Down Expand Up @@ -3564,7 +3564,7 @@ public static boolean isAnyEmpty(final CharSequence... css) {
}

/**
* Checks if the CharSequence contains only ASCII printable characters.
* Tests if the CharSequence contains only ASCII printable characters.
*
* <p>{@code null} will return {@code false}.
* An empty CharSequence (length()=0) will return {@code true}.</p>
Expand Down Expand Up @@ -3603,7 +3603,7 @@ public static boolean isAsciiPrintable(final CharSequence cs) {
}

/**
* Checks if a CharSequence is empty (""), null or whitespace only.
* Tests if a CharSequence is empty (""), null or whitespace only.
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
Expand Down Expand Up @@ -3634,7 +3634,7 @@ public static boolean isBlank(final CharSequence cs) {
}

/**
* Checks if a CharSequence is empty ("") or null.
* Tests if a CharSequence is empty ("") or null.
*
* <pre>
* StringUtils.isEmpty(null) = true
Expand All @@ -3657,7 +3657,7 @@ public static boolean isEmpty(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains mixed casing of both uppercase and lowercase characters.
* Tests if the CharSequence contains mixed casing of both uppercase and lowercase characters.
*
* <p>{@code null} will return {@code false}. An empty CharSequence ({@code length()=0}) will return
* {@code false}.</p>
Expand Down Expand Up @@ -3701,7 +3701,7 @@ public static boolean isMixedCase(final CharSequence cs) {
}

/**
* Checks if none of the CharSequences are empty (""), null or whitespace only.
* Tests if none of the CharSequences are empty (""), null or whitespace only.
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
Expand All @@ -3728,7 +3728,7 @@ public static boolean isNoneBlank(final CharSequence... css) {
}

/**
* Checks if none of the CharSequences are empty ("") or null.
* Tests if none of the CharSequences are empty ("") or null.
*
* <pre>
* StringUtils.isNoneEmpty((String) null) = false
Expand All @@ -3752,7 +3752,7 @@ public static boolean isNoneEmpty(final CharSequence... css) {
}

/**
* Checks if a CharSequence is not empty (""), not null and not whitespace only.
* Tests if a CharSequence is not empty (""), not null and not whitespace only.
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
Expand All @@ -3775,7 +3775,7 @@ public static boolean isNotBlank(final CharSequence cs) {
}

/**
* Checks if a CharSequence is not empty ("") and not null.
* Tests if a CharSequence is not empty ("") and not null.
*
* <pre>
* StringUtils.isNotEmpty(null) = false
Expand All @@ -3794,7 +3794,7 @@ public static boolean isNotEmpty(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains only Unicode digits.
* Tests if the CharSequence contains only Unicode digits.
* A decimal point is not a Unicode digit and returns false.
*
* <p>{@code null} will return {@code false}.
Expand Down Expand Up @@ -3838,7 +3838,7 @@ public static boolean isNumeric(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains only Unicode digits or space
* Tests if the CharSequence contains only Unicode digits or space
* ({@code ' '}).
* A decimal point is not a Unicode digit and returns false.
*
Expand Down Expand Up @@ -3878,7 +3878,7 @@ public static boolean isNumericSpace(final CharSequence cs) {
}

/**
* Checks if the CharSequence contains only whitespace.
* Tests if the CharSequence contains only whitespace.
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
*
Expand Down

0 comments on commit c2cd052

Please sign in to comment.