com.landawn.abacus.util

Class Joiner

java.lang.Object

com.landawn.abacus.util.Joiner

public class Joiner
extends java.lang.Object

Note: It's copied from OpenJDK at: http://hg.openjdk.java.net/jdk8u/hs-dev/jdk
StringJoiner is used to construct a sequence of characters separated by a delimiter and optionally starting with a supplied prefix and ending with a supplied suffix.

Prior to adding something to the StringJoiner, its sj.toString() method will, by default, return prefix + suffix. However, if the setEmptyValue method is called, the emptyValue supplied will be returned instead. This can be used, for example, when creating a string using set notation to indicate an empty set, i.e. "{}", where the prefix is "{", the suffix is "}" and nothing has been added to the StringJoiner.

Since:

1.8

See Also:

Collectors.joining(CharSequence), Collectors.joining(CharSequence, CharSequence, CharSequence)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DELIMITER
static java.lang.String	DEFAULT_KEY_VALUE_DELIMITER

Method Summary

Modifier and Type	Method and Description
Joiner	add(boolean element)
Joiner	add(byte element)
Joiner	add(char element)
Joiner	add(java.lang.CharSequence element) Adds a copy of the given CharSequence value as the next element of the StringJoiner value.
Joiner	add(double element)
Joiner	add(float element)
Joiner	add(int element)
Joiner	add(long element)
Joiner	add(java.lang.Object element)
Joiner	add(short element)
Joiner	add(java.lang.String element)
static Joiner	defauLt() Returns the Map Splitter with the default element and key/value delimiter: ", " and "="
Joiner	join(boolean[] a)
Joiner	join(boolean[] a, int fromIndex, int toIndex)
Joiner	join(BooleanList c)
Joiner	join(BooleanList c, int fromIndex, int toIndex)
Joiner	join(byte[] a)
Joiner	join(byte[] a, int fromIndex, int toIndex)
Joiner	join(ByteList c)
Joiner	join(ByteList c, int fromIndex, int toIndex)
Joiner	join(char[] a)
Joiner	join(char[] a, int fromIndex, int toIndex)
Joiner	join(CharList c)
Joiner	join(CharList c, int fromIndex, int toIndex)
Joiner	join(java.util.Collection<?> c)
Joiner	join(java.util.Collection<?> c, int fromIndex, int toIndex)
Joiner	join(double[] a)
Joiner	join(double[] a, int fromIndex, int toIndex)
Joiner	join(DoubleList c)
Joiner	join(DoubleList c, int fromIndex, int toIndex)
Joiner	join(float[] a)
Joiner	join(float[] a, int fromIndex, int toIndex)
Joiner	join(FloatList c)
Joiner	join(FloatList c, int fromIndex, int toIndex)
Joiner	join(int[] a)
Joiner	join(int[] a, int fromIndex, int toIndex)
Joiner	join(IntList c)
Joiner	join(IntList c, int fromIndex, int toIndex)
Joiner	join(long[] a)
Joiner	join(long[] a, int fromIndex, int toIndex)
Joiner	join(LongList c)
Joiner	join(LongList c, int fromIndex, int toIndex)
Joiner	join(java.util.Map<?,?> m)
Joiner	join(java.util.Map<?,?> m, int fromIndex, int toIndex)
Joiner	join(java.lang.Object[] a)
Joiner	join(java.lang.Object[] a, int fromIndex, int toIndex)
Joiner	join(short[] a)
Joiner	join(short[] a, int fromIndex, int toIndex)
Joiner	join(ShortList c)
Joiner	join(ShortList c, int fromIndex, int toIndex)
int	length() Returns the length of the String representation of this StringJoiner.
<T> T	map(Function<? super java.lang.String,T> mapper)
<T> Optional<T>	mapIfNotEmpty(Function<? super java.lang.String,T> mapper)
Joiner	merge(Joiner other) Adds the contents of the given StringJoiner without prefix and suffix as the next element if it is non-empty.
Joiner	setEmptyValue(java.lang.CharSequence emptyValue) Sets the sequence of characters to be used when determining the string representation of this StringJoiner and no elements have been added yet, that is, when it is empty.
Joiner	skipNull(boolean skipNull)
Stream<java.lang.String>	stream()
Stream<java.lang.String>	streamIfNotEmpty()
java.lang.String	toString() Returns the current value, consisting of the prefix, the values added so far separated by the delimiter, and the suffix, unless no elements have been added in which case, the prefix + suffix or the emptyValue characters are returned
Joiner	trim(boolean trim)
Joiner	useForNull(java.lang.String nullText)
static Joiner	with(java.lang.CharSequence delimiter)
static Joiner	with(java.lang.CharSequence delimiter, java.lang.CharSequence keyValueDelimiter)
static Joiner	with(java.lang.CharSequence delimiter, java.lang.CharSequence prefix, java.lang.CharSequence suffix)
static Joiner	with(java.lang.CharSequence delimiter, java.lang.CharSequence keyValueDelimiter, java.lang.CharSequence prefix, java.lang.CharSequence suffix)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_DELIMITER

public static final java.lang.String DEFAULT_DELIMITER

DEFAULT_KEY_VALUE_DELIMITER

public static final java.lang.String DEFAULT_KEY_VALUE_DELIMITER

See Also:

Constant Field Values

Method Detail

defauLt

public static Joiner defauLt()

Returns the Map Splitter with the default element and key/value delimiter: ", " and "="

Returns:

with

public static Joiner with(java.lang.CharSequence delimiter)

with

public static Joiner with(java.lang.CharSequence delimiter,
                          java.lang.CharSequence keyValueDelimiter)

with

public static Joiner with(java.lang.CharSequence delimiter,
                          java.lang.CharSequence prefix,
                          java.lang.CharSequence suffix)

with

public static Joiner with(java.lang.CharSequence delimiter,
                          java.lang.CharSequence keyValueDelimiter,
                          java.lang.CharSequence prefix,
                          java.lang.CharSequence suffix)

setEmptyValue

public Joiner setEmptyValue(java.lang.CharSequence emptyValue)

Sets the sequence of characters to be used when determining the string representation of this StringJoiner and no elements have been added yet, that is, when it is empty. A copy of the emptyValue parameter is made for this purpose. Note that once an add method has been called, the StringJoiner is no longer considered empty, even if the element(s) added correspond to the empty String.

Parameters:

emptyValue - the characters to return as the value of an empty StringJoiner

Returns:

this StringJoiner itself so the calls may be chained

Throws:

java.lang.NullPointerException - when the emptyValue parameter is null

trim

public Joiner trim(boolean trim)

skipNull

public Joiner skipNull(boolean skipNull)

useForNull

public Joiner useForNull(java.lang.String nullText)

add

public Joiner add(boolean element)

add

public Joiner add(char element)

add

public Joiner add(byte element)

add

public Joiner add(short element)

add

public Joiner add(int element)

add

public Joiner add(long element)

add

public Joiner add(float element)

add

public Joiner add(double element)

add

public Joiner add(java.lang.String element)

add

public Joiner add(java.lang.CharSequence element)

Adds a copy of the given CharSequence value as the next element of the StringJoiner value. If element is null, then "null" is added.

Parameters:

element - The element to add

Returns:

a reference to this StringJoiner

add

public Joiner add(java.lang.Object element)

join

public Joiner join(boolean[] a)

join

public Joiner join(boolean[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(char[] a)

join

public Joiner join(char[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(byte[] a)

join

public Joiner join(byte[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(short[] a)

join

public Joiner join(short[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(int[] a)

join

public Joiner join(int[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(long[] a)

join

public Joiner join(long[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(float[] a)

join

public Joiner join(float[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(double[] a)

join

public Joiner join(double[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(java.lang.Object[] a)

join

public Joiner join(java.lang.Object[] a,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(java.util.Collection<?> c)

join

public Joiner join(java.util.Collection<?> c,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(java.util.Map<?,?> m)

join

public Joiner join(java.util.Map<?,?> m,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(BooleanList c)

join

public Joiner join(BooleanList c,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(CharList c)

join

public Joiner join(CharList c,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(ByteList c)

join

public Joiner join(ByteList c,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(ShortList c)

join

public Joiner join(ShortList c,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(IntList c)

join

public Joiner join(IntList c,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(LongList c)

join

public Joiner join(LongList c,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(FloatList c)

join

public Joiner join(FloatList c,
                   int fromIndex,
                   int toIndex)

join

public Joiner join(DoubleList c)

join

public Joiner join(DoubleList c,
                   int fromIndex,
                   int toIndex)

merge

public Joiner merge(Joiner other)

Adds the contents of the given StringJoiner without prefix and suffix as the next element if it is non-empty. If the given StringJoiner is empty, the call has no effect.

A StringJoiner is empty if add() has never been called, and if merge() has never been called with a non-empty StringJoiner argument.

If the other StringJoiner is using a different delimiter, then elements from the other StringJoiner are concatenated with that delimiter and the result is appended to this StringJoiner as a single element.

Parameters:

other - The StringJoiner whose contents should be merged into this one

Returns:

This StringJoiner

Throws:

java.lang.NullPointerException - if the other StringJoiner is null

length

public int length()

Returns the length of the String representation of this StringJoiner. Note that if no add methods have been called, then the length of the String representation (either prefix + suffix or emptyValue) will be returned. The value should be equivalent to toString().length().

Returns:

the length of the current value of StringJoiner

toString

public java.lang.String toString()

Returns the current value, consisting of the prefix, the values added so far separated by the delimiter, and the suffix, unless no elements have been added in which case, the prefix + suffix or the emptyValue characters are returned

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this StringJoiner

map

public <T> T map(Function<? super java.lang.String,T> mapper)

mapIfNotEmpty

public <T> Optional<T> mapIfNotEmpty(Function<? super java.lang.String,T> mapper)

stream

public Stream<java.lang.String> stream()

streamIfNotEmpty

public Stream<java.lang.String> streamIfNotEmpty()