public final class StringJoiner {
private final String prefix;
private final String delimiter;
private final String suffix;
/*
*StringBuilder值-在任何时候,字符都是由前缀构造的,添加的元素由定界符分隔,但是没有后缀,
*因此我们可以更轻松地添加元素,而不必每次都摇晃后缀。
*/
private StringBuilder value;
/*
* 默认情况下,当尚未添加任何元素(即为空)时,由toString()返回的由前缀+后缀组成的字符串或value
* 的属性。用户可能会将其覆盖为其他一些值,包括空字符串。
*/
private String emptyValue;
/**
*构造一个{@code StringJoiner},其中不带任何字符,不带{@code前缀}或{@code后缀},并提供一个提供的
*{@code定界符}的副本。如果没有字符添加到{@code StringJoiner}中,并且调用了访问其值的方法,则它将
*不会在结果中返回{@code prefix}或{@code后缀}(或其属性),除非{@代码setEmptyValue}首先被调用。
* @param定界符如果{@code定界符}为{@code null},则添加到{@code StringJoiner}值的每个元素之间使用
* 的字符序列@throws NullPointerException
*/
public StringJoiner(CharSequence delimiter) {
this(delimiter, "", "");
}
/**
* 使用提供的{@code前缀},{@ code分隔符}和{@code后缀}的副本构造一个{@code StringJoiner},其中
* 不包含任何字符。如果没有字符添加到{@code StringJoiner}中,并且调用了访问其字符串值的方法,
* 则它将返回结果中的{@code前缀+后缀}(或其属性),除非{@code setEmptyValue}具有首先被称为。
* @param定界符在添加到{@code StringJoiner}的每个元素之间使用的字符序列@param前缀将在开头使用的
* 字符序列@param后缀将在结尾使用的字符序列@throws NullPointerException如果{@code前缀},
* {@ code分隔符}或{@code后缀}为{@code null}
*/
public StringJoiner(CharSequence delimiter,
CharSequence prefix,
CharSequence suffix) {
Objects.requireNonNull(prefix, "The prefix must not be null");
Objects.requireNonNull(delimiter, "The delimiter must not be null");
Objects.requireNonNull(suffix, "The suffix must not be null");
// make defensive copies of arguments
this.prefix = prefix.toString();
this.delimiter = delimiter.toString();
this.suffix = suffix.toString();
this.emptyValue = this.prefix + this.suffix;
}
/**
* Sets the sequence of characters to be used when determining the string
* representation of this {@code StringJoiner} and no elements have been
* added yet, that is, when it is empty. A copy of the {@code emptyValue}
* parameter is made for this purpose. Note that once an add method has been
* called, the {@code StringJoiner} is no longer considered empty, even if
* the element(s) added correspond to the empty {@code String}.
*
* @param emptyValue the characters to return as the value of an empty
* {@code StringJoiner}
* @return this {@code StringJoiner} itself so the calls may be chained
* @throws NullPointerException when the {@code emptyValue} parameter is
* {@code null}
*/
public StringJoiner setEmptyValue(CharSequence emptyValue) {
this.emptyValue = Objects.requireNonNull(emptyValue,
"The empty value must not be null").toString();
return this;
}
/**
* Returns the current value, consisting of the {@code prefix}, the values
* added so far separated by the {@code delimiter}, and the {@code suffix},
* unless no elements have been added in which case, the
* {@code prefix + suffix} or the {@code emptyValue} characters are returned
*
* @return the string representation of this {@code StringJoiner}
*/
@Override
public String toString() {
if (value == null) {
return emptyValue;
} else {
if (suffix.equals("")) {
return value.toString();
} else {
int initialLength = value.length();
String result = value.append(suffix).toString();
// reset value to pre-append initialLength
value.setLength(initialLength);
return result;
}
}
}
/**
* Adds a copy of the given {@code CharSequence} value as the next
* element of the {@code StringJoiner} value. If {@code newElement} is
* {@code null}, then {@code "null"} is added.
*
* @param newElement The element to add
* @return a reference to this {@code StringJoiner}
*/
public StringJoiner add(CharSequence newElement) {
prepareBuilder().append(newElement);
return this;
}
/**
* Adds the contents of the given {@code StringJoiner} without prefix and
* suffix as the next element if it is non-empty. If the given {@code
* StringJoiner} is empty, the call has no effect.
*
* <p>A {@code StringJoiner} is empty if {@link #add(CharSequence) add()}
* has never been called, and if {@code merge()} has never been called
* with a non-empty {@code StringJoiner} argument.
*
* <p>If the other {@code StringJoiner} is using a different delimiter,
* then elements from the other {@code StringJoiner} are concatenated with
* that delimiter and the result is appended to this {@code StringJoiner}
* as a single element.
*
* @param other The {@code StringJoiner} whose contents should be merged
* into this one
* @throws NullPointerException if the other {@code StringJoiner} is null
* @return This {@code StringJoiner}
*/
public StringJoiner merge(StringJoiner other) {
Objects.requireNonNull(other);
if (other.value != null) {
final int length = other.value.length();
// lock the length so that we can seize the data to be appended
// before initiate copying to avoid interference, especially when
// merge 'this'
StringBuilder builder = prepareBuilder();
builder.append(other.value, other.prefix.length(), length);
}
return this;
}
private StringBuilder prepareBuilder() {
if (value != null) {
value.append(delimiter);
} else {
value = new StringBuilder().append(prefix);
}
return value;
}
/**
* Returns the length of the {@code String} representation
* of this {@code StringJoiner}. Note that if
* no add methods have been called, then the length of the {@code String}
* representation (either {@code prefix + suffix} or {@code emptyValue})
* will be returned. The value should be equivalent to
* {@code toString().length()}.
*
* @return the length of the current value of {@code StringJoiner}
*/
public int length() {
// Remember that we never actually append the suffix unless we return
// the full (present) value or some sub-string or length of it, so that
// we can add on more if we need to.
return (value != null ? value.length() + suffix.length() :
emptyValue.length());
}
}
StringJoiner通过StrinigBuffer为底层实现,通过传入的前缀,后缀,分隔符,值来实现,对拼接字符串的功能