Skip to content

docs: fix Javadoc for StringUtils.equals() and repeat() null handling #6640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joviegas merged 1 commit into from
Dec 19, 2025
+8 −7
Merged

docs: fix Javadoc for StringUtils.equals() and repeat() null handling #6640

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions utils/src/main/java/software/amazon/awssdk/utils/StringUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,10 +299,10 @@ public static String trimToEmpty(final String str) {
* equal sequences of characters.</p>
*
* <p>{@code null}s are handled without exceptions. Two {@code null}
* references are considered to be equal. The comparison is case sensitive.</p>
* references are considered to be unequal. The comparison is case sensitive.</p>
*
* <pre>
* StringUtils.equals(null, null) = true
* StringUtils.equals(null, null) = false
* StringUtils.equals(null, "abc") = false
* StringUtils.equals("abc", null) = false
* StringUtils.equals("abc", "abc") = true
Expand All @@ -312,7 +312,7 @@ public static String trimToEmpty(final String str) {
* @see Object#equals(Object)
* @param cs1 the first String, may be {@code null}
* @param cs2 the second String, may be {@code null}
* @return {@code true} if the Strings are equal (case-sensitive), or both {@code null}
* @return {@code true} if the Strings are equal (case-sensitive), or {@code false} if either is {@code null}
*/
public static boolean equals(final String cs1, final String cs2) {
if (cs1 == null || cs2 == null) {
Expand Down Expand Up @@ -932,18 +932,19 @@ public static boolean safeStringToBoolean(String value) {

throw new IllegalArgumentException("Value was defined as '" + value + "', but should be 'false' or 'true'");
}

/**
* Returns a string whose value is the concatenation of this string repeated {@code count} times.
* <p>
* If this string is empty or count is zero then the empty string is returned.
* A {@code null} input string returns {@code null}.
* <p>
* Logical clone of JDK11's {@link String#repeat(int)}.
*
* @param value the string to repeat
* @param value the string to repeat, may be null
* @param count number of times to repeat
* @return A string composed of this string repeated {@code count} times or the empty string if this string is empty or count
* is zero
* @return A string composed of this string repeated {@code count} times, the empty string if this string is empty or count
* is zero, or {@code null} if input is {@code null}
* @throws IllegalArgumentException if the {@code count} is negative.
*/
public static String repeat(String value, int count) {
Expand Down
Loading