|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.base.Joiner
@GwtCompatible public class Joiner
An object which joins pieces of text (specified as an array, Iterable, varargs or even a
Map) with a separator. It either appends the results to an Appendable or returns
them as a String. Example:
Joiner joiner = Joiner.on("; ").skipNulls();
. . .
return joiner.join("Harry", null, "Ron", "Hermione");
This returns the string "Harry; Ron; Hermione". Note that all input elements are
converted to strings using Object.toString() before being appended.
If neither skipNulls() nor useForNull(String) is specified, the joining
methods will throw NullPointerException if any given element is null.
Warning: joiner instances are always immutable; a configuration method such as useForNull has no effect on the instance it is invoked on! You must store and use the new joiner
instance returned by the method. This makes joiners thread-safe, and safe to store as static final constants.
// Bad! Do not do this!
Joiner joiner = Joiner.on(',');
joiner.skipNulls(); // does nothing!
return joiner.join("wrong", null, "wrong");
| Nested Class Summary | |
|---|---|
static class |
Joiner.MapJoiner
An object that joins map entries in the same manner as Joiner joins iterables and
arrays. |
| Method Summary | ||
|---|---|---|
|
appendTo(A appendable,
I parts)
Deprecated. use appendTo(Appendable, Iterator) by casting parts to
Iterator<?>, or better yet, by implementing only Iterator and not
Iterable. This method is scheduled for deletion in June 2013. |
|
|
appendTo(A appendable,
Iterable<?> parts)
Appends the string representation of each of parts, using the previously configured
separator between each, to appendable. |
|
|
appendTo(A appendable,
Iterator<?> parts)
Appends the string representation of each of parts, using the previously configured
separator between each, to appendable. |
|
|
appendTo(A appendable,
Object[] parts)
Appends the string representation of each of parts, using the previously configured
separator between each, to appendable. |
|
|
appendTo(A appendable,
Object first,
Object second,
Object... rest)
Appends to appendable the string representation of each of the remaining arguments. |
|
|
appendTo(StringBuilder builder,
I parts)
Deprecated. use appendTo(StringBuilder, Iterator) by casting parts to
Iterator<?>, or better yet, by implementing only Iterator and not
Iterable. This method is scheduled for deletion in June 2013. |
|
StringBuilder |
appendTo(StringBuilder builder,
Iterable<?> parts)
Appends the string representation of each of parts, using the previously configured
separator between each, to builder. |
|
StringBuilder |
appendTo(StringBuilder builder,
Iterator<?> parts)
Appends the string representation of each of parts, using the previously configured
separator between each, to builder. |
|
StringBuilder |
appendTo(StringBuilder builder,
Object[] parts)
Appends the string representation of each of parts, using the previously configured
separator between each, to builder. |
|
StringBuilder |
appendTo(StringBuilder builder,
Object first,
Object second,
Object... rest)
Appends to builder the string representation of each of the remaining arguments. |
|
|
join(I parts)
Deprecated. use join(Iterator) by casting parts to
Iterator<?>, or better yet, by implementing only Iterator and not
Iterable. This method is scheduled for deletion in June 2013. |
|
String |
join(Iterable<?> parts)
Returns a string containing the string representation of each of parts, using the
previously configured separator between each. |
|
String |
join(Iterator<?> parts)
Returns a string containing the string representation of each of parts, using the
previously configured separator between each. |
|
String |
join(Object[] parts)
Returns a string containing the string representation of each of parts, using the
previously configured separator between each. |
|
String |
join(Object first,
Object second,
Object... rest)
Returns a string containing the string representation of each argument, using the previously configured separator between each. |
|
static Joiner |
on(char separator)
Returns a joiner which automatically places separator between consecutive elements. |
|
static Joiner |
on(String separator)
Returns a joiner which automatically places separator between consecutive elements. |
|
Joiner |
skipNulls()
Returns a joiner with the same behavior as this joiner, except automatically skipping over any provided null elements. |
|
Joiner |
useForNull(String nullText)
Returns a joiner with the same behavior as this one, except automatically substituting nullText for any provided null elements. |
|
Joiner.MapJoiner |
withKeyValueSeparator(String keyValueSeparator)
Returns a MapJoiner using the given key-value separator, and the same configuration as
this Joiner otherwise. |
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public static Joiner on(String separator)
separator between consecutive elements.
public static Joiner on(char separator)
separator between consecutive elements.
@Beta
@Deprecated
public final <A extends Appendable,I extends Object & Iterable<?> & Iterator<?>> A appendTo(A appendable,
I parts)
throws IOException
appendTo(Appendable, Iterator) by casting parts to
Iterator<?>, or better yet, by implementing only Iterator and not
Iterable. This method is scheduled for deletion in June 2013.
IOException
public <A extends Appendable> A appendTo(A appendable,
Iterable<?> parts)
throws IOException
parts, using the previously configured
separator between each, to appendable.
IOException
@Beta
public <A extends Appendable> A appendTo(A appendable,
Iterator<?> parts)
throws IOException
parts, using the previously configured
separator between each, to appendable.
IOException
public final <A extends Appendable> A appendTo(A appendable,
Object[] parts)
throws IOException
parts, using the previously configured
separator between each, to appendable.
IOException
public final <A extends Appendable> A appendTo(A appendable,
@Nullable
Object first,
@Nullable
Object second,
Object... rest)
throws IOException
appendable the string representation of each of the remaining arguments.
IOException
@Beta
@Deprecated
public final <I extends Object & Iterable<?> & Iterator<?>> StringBuilder appendTo(StringBuilder builder,
I parts)
appendTo(StringBuilder, Iterator) by casting parts to
Iterator<?>, or better yet, by implementing only Iterator and not
Iterable. This method is scheduled for deletion in June 2013.
public final StringBuilder appendTo(StringBuilder builder,
Iterable<?> parts)
parts, using the previously configured
separator between each, to builder. Identical to appendTo(Appendable,
Iterable), except that it does not throw IOException.
@Beta
public final StringBuilder appendTo(StringBuilder builder,
Iterator<?> parts)
parts, using the previously configured
separator between each, to builder. Identical to appendTo(Appendable,
Iterable), except that it does not throw IOException.
public final StringBuilder appendTo(StringBuilder builder,
Object[] parts)
parts, using the previously configured
separator between each, to builder. Identical to appendTo(Appendable,
Iterable), except that it does not throw IOException.
public final StringBuilder appendTo(StringBuilder builder,
@Nullable
Object first,
@Nullable
Object second,
Object... rest)
builder the string representation of each of the remaining arguments.
Identical to appendTo(Appendable, Object, Object, Object...), except that it does not
throw IOException.
@Beta @Deprecated public final <I extends Object & Iterable<?> & Iterator<?>> String join(I parts)
join(Iterator) by casting parts to
Iterator<?>, or better yet, by implementing only Iterator and not
Iterable. This method is scheduled for deletion in June 2013.
public final String join(Iterable<?> parts)
parts, using the
previously configured separator between each.
@Beta public final String join(Iterator<?> parts)
parts, using the
previously configured separator between each.
public final String join(Object[] parts)
parts, using the
previously configured separator between each.
public final String join(@Nullable
Object first,
@Nullable
Object second,
Object... rest)
@CheckReturnValue public Joiner useForNull(String nullText)
nullText for any provided null elements.
@CheckReturnValue public Joiner skipNulls()
@CheckReturnValue public Joiner.MapJoiner withKeyValueSeparator(String keyValueSeparator)
MapJoiner using the given key-value separator, and the same configuration as
this Joiner otherwise.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||