This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git
The following commit(s) were added to refs/heads/master by this push:
new 8269f65c Javadoc
8269f65c is described below
commit 8269f65ca51e6a17ed69be9936dc0350b047e732
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu May 23 09:21:27 2024 -0400
Javadoc
---
.../java/org/apache/commons/text/StrBuilder.java | 184 ++++++++++-----------
1 file changed, 92 insertions(+), 92 deletions(-)
diff --git a/src/main/java/org/apache/commons/text/StrBuilder.java
b/src/main/java/org/apache/commons/text/StrBuilder.java
index 0c66397f..1627737c 100644
--- a/src/main/java/org/apache/commons/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/text/StrBuilder.java
@@ -309,7 +309,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a boolean value to the string builder.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final boolean value) {
if (value) {
@@ -333,7 +333,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a char value to the string builder.
*
* @param ch the value to append
- * @return this
+ * @return {@code this} instance.
*/
@Override
public StrBuilder append(final char ch) {
@@ -347,7 +347,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a char array to the string builder. Appending null will call
{@link #appendNull()}.
*
* @param chars the char array to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final char[] chars) {
if (chars == null) {
@@ -369,7 +369,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param chars the char array to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final char[] chars, final int startIndex, final
int length) {
if (chars == null) {
@@ -394,7 +394,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends the contents of a char buffer to this string builder. Appending
null will call {@link #appendNull()}.
*
* @param buf the char buffer to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final CharBuffer buf) {
if (buf == null) {
@@ -418,7 +418,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param buf the char buffer to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final CharBuffer buf, final int startIndex, final
int length) {
if (buf == null) {
@@ -446,7 +446,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a CharSequence to this string builder. Appending null will call
{@link #appendNull()}.
*
* @param seq the CharSequence to append
- * @return this
+ * @return {@code this} instance.
*/
@Override
public StrBuilder append(final CharSequence seq) {
@@ -474,7 +474,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param seq the CharSequence to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
*/
@Override
public StrBuilder append(final CharSequence seq, final int startIndex,
final int length) {
@@ -488,7 +488,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a double value to the string builder using {@code
String.valueOf}.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final double value) {
return append(String.valueOf(value));
@@ -498,7 +498,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a float value to the string builder using {@code
String.valueOf}.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final float value) {
return append(String.valueOf(value));
@@ -508,7 +508,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends an int value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final int value) {
return append(String.valueOf(value));
@@ -518,7 +518,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a long value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final long value) {
return append(String.valueOf(value));
@@ -528,7 +528,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends an object to this string builder. Appending null will call
{@link #appendNull()}.
*
* @param obj the object to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final Object obj) {
if (obj == null) {
@@ -544,7 +544,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends another string builder to this string builder. Appending null
will call {@link #appendNull()}.
*
* @param str the string builder to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final StrBuilder str) {
if (str == null) {
@@ -566,7 +566,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param str the string to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final StrBuilder str, final int startIndex, final
int length) {
if (str == null) {
@@ -591,7 +591,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a string to this string builder. Appending null will call
{@link #appendNull()}.
*
* @param str the string to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final String str) {
if (str == null) {
@@ -613,7 +613,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param str the string to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final String str, final int startIndex, final int
length) {
if (str == null) {
@@ -650,7 +650,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a string buffer to this string builder. Appending null will
call {@link #appendNull()}.
*
* @param str the string buffer to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final StringBuffer str) {
if (str == null) {
@@ -672,7 +672,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param str the string to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final StringBuffer str, final int startIndex,
final int length) {
if (str == null) {
@@ -697,7 +697,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a StringBuilder to this string builder. Appending null will
call {@link #appendNull()}.
*
* @param str the StringBuilder to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final StringBuilder str) {
if (str == null) {
@@ -719,7 +719,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param str the StringBuilder to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder append(final StringBuilder str, final int startIndex,
final int length) {
if (str == null) {
@@ -745,7 +745,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* {@link #append(Object)}.
*
* @param iterable the iterable to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendAll(final Iterable<?> iterable) {
if (iterable != null) {
@@ -759,7 +759,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* {@link #append(Object)}.
*
* @param it the iterator to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendAll(final Iterator<?> it) {
if (it != null) {
@@ -776,7 +776,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param <T> the element type
* @param array the array to append
- * @return this
+ * @return {@code this} instance.
*/
public <T> StrBuilder appendAll(@SuppressWarnings("unchecked") final T...
array) {
/*
@@ -798,7 +798,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param value the value to append
* @param width the fixed field width, zero or negative has no effect
* @param padChar the pad character to use
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendFixedWidthPadLeft(final int value, final int
width, final char padChar) {
return appendFixedWidthPadLeft(String.valueOf(value), width, padChar);
@@ -811,7 +811,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param obj the object to append, null uses null text
* @param width the fixed field width, zero or negative has no effect
* @param padChar the pad character to use
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendFixedWidthPadLeft(final Object obj, final int
width, final char padChar) {
if (width > 0) {
@@ -842,7 +842,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param value the value to append
* @param width the fixed field width, zero or negative has no effect
* @param padChar the pad character to use
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendFixedWidthPadRight(final int value, final int
width, final char padChar) {
return appendFixedWidthPadRight(String.valueOf(value), width, padChar);
@@ -855,7 +855,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param obj the object to append, null uses null text
* @param width the fixed field width, zero or negative has no effect
* @param padChar the pad character to use
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendFixedWidthPadRight(final Object obj, final int
width, final char padChar) {
if (width > 0) {
@@ -883,7 +883,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a boolean value followed by a {@link #appendNewLine() new line}
to the string builder.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final boolean value) {
@@ -894,7 +894,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a char value followed by a {@link #appendNewLine() new line} to
the string builder.
*
* @param ch the value to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final char ch) {
@@ -905,7 +905,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a char array followed by a {@link #appendNewLine() new line} to
the string builder. Appending null will call {@link #appendNull()}.
*
* @param chars the char array to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final char[] chars) {
@@ -918,7 +918,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param chars the char array to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final char[] chars, final int startIndex, final
int length) {
@@ -929,7 +929,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a double value followed by a {@link #appendNewLine() new line}
to the string builder using {@code String.valueOf}.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final double value) {
@@ -940,7 +940,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a float value followed by a {@link #appendNewLine() new line}
to the string builder using {@code String.valueOf}.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final float value) {
@@ -951,7 +951,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends an int value followed by a {@link #appendNewLine() new line} to
the string builder using {@code String.valueOf}.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final int value) {
@@ -962,7 +962,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a long value followed by a {@link #appendNewLine() new line} to
the string builder using {@code String.valueOf}.
*
* @param value the value to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final long value) {
@@ -973,7 +973,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends an object followed by a {@link #appendNewLine() new line} to
this string builder. Appending null will call {@link #appendNull()}.
*
* @param obj the object to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final Object obj) {
@@ -984,7 +984,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends another string builder followed by a {@link #appendNewLine()
new line} to this string builder. Appending null will call {@link
#appendNull()}.
*
* @param str the string builder to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final StrBuilder str) {
@@ -997,7 +997,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param str the string to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final StrBuilder str, final int startIndex,
final int length) {
@@ -1008,7 +1008,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a string followed by a {@link #appendNewLine() new line} to
this string builder. Appending null will call {@link #appendNull()}.
*
* @param str the string to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final String str) {
@@ -1021,7 +1021,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param str the string to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final String str, final int startIndex, final
int length) {
@@ -1045,7 +1045,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a string buffer followed by a {@link #appendNewLine() new line}
to this string builder. Appending null will call {@link #appendNull()}.
*
* @param str the string buffer to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final StringBuffer str) {
@@ -1058,7 +1058,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param str the string to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final StringBuffer str, final int startIndex,
final int length) {
@@ -1069,7 +1069,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Appends a string builder followed by a {@link #appendNewLine() new
line} to this string builder. Appending null will call {@link #appendNull()}.
*
* @param str the string builder to append
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final StringBuilder str) {
@@ -1082,7 +1082,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param str the string builder to append
* @param startIndex the start index, inclusive, must be valid
* @param length the length to append, must be valid
- * @return this
+ * @return {@code this} instance.
* @see #appendNewLine()
*/
public StrBuilder appendln(final StringBuilder str, final int startIndex,
final int length) {
@@ -1099,7 +1099,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* endings even when on Windows.
* </p>
*
- * @return this
+ * @return {@code this} instance.
* @see #getNewLineText()
* @see #setNewLineText(String)
*/
@@ -1114,7 +1114,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
/**
* Appends this builder's null text to this builder.
*
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendNull() {
if (nullText == null) {
@@ -1128,7 +1128,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param length the length to append, negative means no append
* @param padChar the character to append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendPadding(final int length, final char padChar) {
if (length >= 0) {
@@ -1157,7 +1157,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* </p>
*
* @param separator the separator to use
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendSeparator(final char separator) {
if (isNotEmpty()) {
@@ -1174,7 +1174,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param standard the separator if builder is not empty
* @param defaultIfEmpty the separator if builder is empty
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendSeparator(final char standard, final char
defaultIfEmpty) {
if (isNotEmpty()) {
@@ -1203,7 +1203,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param separator the separator to use
* @param loopIndex the loop index
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendSeparator(final char separator, final int
loopIndex) {
if (loopIndex > 0) {
@@ -1230,7 +1230,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* </p>
*
* @param separator the separator to use, null means no separator
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendSeparator(final String separator) {
return appendSeparator(separator, null);
@@ -1255,7 +1255,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param separator the separator to use, null means no separator
* @param loopIndex the loop index
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendSeparator(final String separator, final int
loopIndex) {
if (separator != null && loopIndex > 0) {
@@ -1289,7 +1289,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param standard the separator if builder is not empty, null means
no separator
* @param defaultIfEmpty the separator if builder is empty, null means no
separator
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendSeparator(final String standard, final String
defaultIfEmpty) {
final String str = isEmpty() ? defaultIfEmpty : standard;
@@ -1330,7 +1330,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param iterable the iterable to append
* @param separator the separator to use, null means no separator
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendWithSeparators(final Iterable<?> iterable, final
String separator) {
if (iterable != null) {
@@ -1345,7 +1345,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param iterator the iterator to append
* @param separator the separator to use, null means no separator
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendWithSeparators(final Iterator<?> iterator, final
String separator) {
if (iterator != null) {
@@ -1366,7 +1366,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param array the array to append
* @param separator the separator to use, null means no separator
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder appendWithSeparators(final Object[] array, final String
separator) {
if (array != null && array.length > 0) {
@@ -1511,7 +1511,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* This method is the same as {@link #setLength(int)} called with zero and
is provided to match the API of Collections.
* </p>
*
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder clear() {
size = 0;
@@ -1562,7 +1562,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param startIndex the start index, inclusive, must be valid
* @param endIndex the end index, exclusive, must be valid except that
if too large it is treated as end of string
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder delete(final int startIndex, int endIndex) {
@@ -1578,7 +1578,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Deletes the character wherever it occurs in the builder.
*
* @param ch the character to delete
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder deleteAll(final char ch) {
for (int i = 0; i < size; i++) {
@@ -1601,7 +1601,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Deletes the string wherever it occurs in the builder.
*
* @param str the string to delete, null causes no action
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder deleteAll(final String str) {
final int len = str == null ? 0 : str.length();
@@ -1623,7 +1623,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* </p>
*
* @param matcher the matcher to use to find the deletion, null causes no
action
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder deleteAll(final StrMatcher matcher) {
return replace(matcher, null, 0, size, -1);
@@ -1635,7 +1635,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @see #charAt(int)
* @see #setCharAt(int, char)
* @param index the index to delete
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder deleteCharAt(final int index) {
@@ -1650,7 +1650,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Deletes the character wherever it occurs in the builder.
*
* @param ch the character to delete
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder deleteFirst(final char ch) {
for (int i = 0; i < size; i++) {
@@ -1666,7 +1666,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Deletes the string wherever it occurs in the builder.
*
* @param str the string to delete, null causes no action
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder deleteFirst(final String str) {
final int len = str == null ? 0 : str.length();
@@ -1687,7 +1687,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* </p>
*
* @param matcher the matcher to use to find the deletion, null causes no
action
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder deleteFirst(final StrMatcher matcher) {
return replace(matcher, null, 0, size, 1);
@@ -1739,7 +1739,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Tests the capacity and ensures that it is at least the size specified.
*
* @param capacity the capacity to ensure
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder ensureCapacity(final int capacity) {
if (capacity > buffer.length) {
@@ -2020,7 +2020,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param value the value to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(int index, final boolean value) {
@@ -2051,7 +2051,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param value the value to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(final int index, final char value) {
@@ -2068,7 +2068,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param chars the char array to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(final int index, final char[] chars) {
@@ -2093,7 +2093,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param chars the char array to insert
* @param offset the offset into the character array to start at, must be
valid
* @param length the length of the character array part to copy, must be
positive
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if any index is invalid
*/
public StrBuilder insert(final int index, final char[] chars, final int
offset, final int length) {
@@ -2121,7 +2121,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param value the value to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(final int index, final double value) {
@@ -2133,7 +2133,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param value the value to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(final int index, final float value) {
@@ -2145,7 +2145,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param value the value to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(final int index, final int value) {
@@ -2157,7 +2157,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param value the value to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(final int index, final long value) {
@@ -2169,7 +2169,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param obj the object to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(final int index, final Object obj) {
@@ -2184,7 +2184,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param index the index to add at, must be valid
* @param str the string to insert
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder insert(final int index, String str) {
@@ -2405,7 +2405,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
/**
* Minimizes the capacity to the actual length of the string.
*
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder minimizeCapacity() {
if (buffer.length > length()) {
@@ -2461,7 +2461,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param startIndex the start index, inclusive, must be valid
* @param endIndex the end index, exclusive, must be valid except that
if too large it is treated as end of string
* @param replaceStr the string to replace with, null means delete range
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder replace(final int startIndex, int endIndex, final String
replaceStr) {
@@ -2483,7 +2483,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param startIndex the start index, inclusive, must be valid
* @param endIndex the end index, exclusive, must be valid except that
if too large it is treated as end of string
* @param replaceCount the number of times to replace, -1 for replace all
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if start index is invalid
*/
public StrBuilder replace(final StrMatcher matcher, final String
replaceStr, final int startIndex, int endIndex, final int replaceCount) {
@@ -2496,7 +2496,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param search the search character
* @param replace the replace character
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder replaceAll(final char search, final char replace) {
if (search != replace) {
@@ -2514,7 +2514,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param searchStr the search string, null causes no action to occur
* @param replaceStr the replace string, null is equivalent to an empty
string
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder replaceAll(final String searchStr, final String
replaceStr) {
final int searchLen = searchStr == null ? 0 : searchStr.length();
@@ -2538,7 +2538,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param matcher the matcher to use to find the deletion, null causes
no action
* @param replaceStr the replace string, null is equivalent to an empty
string
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder replaceAll(final StrMatcher matcher, final String
replaceStr) {
return replace(matcher, replaceStr, 0, size, -1);
@@ -2549,7 +2549,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param search the search character
* @param replace the replace character
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder replaceFirst(final char search, final char replace) {
if (search != replace) {
@@ -2568,7 +2568,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param searchStr the search string, null causes no action to occur
* @param replaceStr the replace string, null is equivalent to an empty
string
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder replaceFirst(final String searchStr, final String
replaceStr) {
final int searchLen = searchStr == null ? 0 : searchStr.length();
@@ -2591,7 +2591,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param matcher the matcher to use to find the deletion, null causes
no action
* @param replaceStr the replace string, null is equivalent to an empty
string
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder replaceFirst(final StrMatcher matcher, final String
replaceStr) {
return replace(matcher, replaceStr, 0, size, 1);
@@ -2631,7 +2631,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @param from the start index, must be valid
* @param to the end index (exclusive), must be valid
* @param replaceCount the number of times to replace, -1 for replace all
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if any index is invalid
*/
private StrBuilder replaceImpl(final StrMatcher matcher, final String
replaceStr, final int from, int to, int replaceCount) {
@@ -2657,7 +2657,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
/**
* Reverses the string builder placing each character in the opposite
index.
*
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder reverse() {
if (size == 0) {
@@ -2701,7 +2701,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* @see #deleteCharAt(int)
* @param index the index to set
* @param ch the new character
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the index is invalid
*/
public StrBuilder setCharAt(final int index, final char ch) {
@@ -2716,7 +2716,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Updates the length of the builder by either dropping the last
characters or adding filler of Unicode zero.
*
* @param length the length to set to, must be zero or positive
- * @return this
+ * @return {@code this} instance.
* @throws IndexOutOfBoundsException if the length is negative
*/
public StrBuilder setLength(final int length) {
@@ -2751,7 +2751,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Sets the text to be appended when null is added.
*
* @param nullText the null text, null means no append
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder setNullText(String nullText) {
if (nullText != null && nullText.isEmpty()) {
@@ -2907,7 +2907,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
/**
* Trims the builder by removing characters less than or equal to a space
from the beginning and end.
*
- * @return this
+ * @return {@code this} instance.
*/
public StrBuilder trim() {
if (size == 0) {
