Класс StringJoiner

public final class StringJoiner
extends Object

StringJoiner используется для построения последовательности символов, разделённых разделителем и, необязательно, начинающейся с указанного префикса и заканчивающейся указанным суффиксом.

Прежде чем добавить что-либо в StringJoiner, его метод sj.toString() по умолчанию вернёт prefix + suffix. Однако, если вызван метод setEmptyValue, вместо этого будет возвращён emptyValue, переданный в качестве параметра. Это может быть использовано, например, при создании строки, используя обозначение множества для обозначения пустого множества, т.е. "{}", где prefix — "{", suffix — "}", а в StringJoiner ничего не добавлено.

Конструкторы

StringJoiner

public StringJoiner(CharSequence delimiter)

Создаёт StringJoiner без символов, без prefix или suffix, и с копией переданного delimiter. Если в StringJoiner не добавлялись символы и вызывались методы доступа к его значению, он не будет возвращать prefix или suffix (или их свойства) в результате, если предварительно не был вызван setEmptyValue.

Параметры:

delimiter — последовательность символов, используемая между каждым элементом, добавленным к значению StringJoiner.

Исключения:

NullPointerException — если delimiter равно null.

StringJoiner

public StringJoiner(CharSequence delimiter,
                    CharSequence prefix,
                    CharSequence suffix)

Создаёт StringJoiner без символов, используя копии переданных prefix, delimiter и suffix. Если в StringJoiner не добавлялись символы и вызывались методы доступа к строковому значению, он вернёт prefix + suffix (или их свойства) в результате, если предварительно не был вызван setEmptyValue.

Параметры:

delimiter — последовательность символов, используемая между каждым элементом, добавленным к значению StringJoiner

prefix — последовательность символов, используемая в начале

suffix — последовательность символов, используемая в конце

Исключения:

NullPointerException — если prefix, delimiter, или suffix равно null.

Методы

setEmptyValue

public StringJoiner setEmptyValue(CharSequence emptyValue)

Устанавливает последовательность символов, используемую при определении строкового представления этого StringJoiner и когда ещё не добавлено ни одного элемента, то есть когда он пуст. Копия параметра emptyValue создаётся для этой цели. Обратите внимание, что как только будет вызван метод add, StringJoiner больше не считается пустым, даже если добавленный(ые) элемент(ы) соответствуют пустому String.

Параметры:

emptyValue — символы, которые должны возвращаться как значение пустого StringJoiner

Возвращает:

сам StringJoiner для возможности цепочки вызовов

Исключения:

NullPointerException — когда параметр emptyValue равен null

toString

public String toString()

Возвращает текущее значение, состоящее из prefix, добавленных до сих пор значений, разделённых delimiter, и suffix, если не было добавлено ни одного элемента, то возвращаются prefix + suffix или emptyValue символы.

Переопределяет:

toString в классе Object

Возвращает:

строковое представление этого StringJoiner

add

public StringJoiner add(CharSequence newElement)

Добавляет копию заданного значения CharSequence в качестве следующего элемента значения StringJoiner . Если newElement равно null, то "null" добавляется.

Параметры:

newElement — элемент для добавления

Возвращает:

ссылку на этот StringJoiner

merge

public StringJoiner merge(StringJoiner other)

Параметры:

other — StringJoiner , чьё содержимое должно быть слияно в этот

Возвращает:

Этот StringJoiner

Исключения:

NullPointerException — если другое StringJoiner равно null

length

public int length()

Возвращает длину строкового представления этого StringJoiner. Обратите внимание, что если не вызывались методы add, то будет возвращена длина строкового представления String (либо prefix + suffix, либо emptyValue). Значение должно быть эквивалентно toString().length().

Возвращает:

длину текущего значения StringJoiner