Package com.google.common.base
Class Joiner.MapJoiner
- java.lang.Object
-
- com.google.common.base.Joiner.MapJoiner
-
- Enclosing class:
- Joiner
public static final class Joiner.MapJoiner extends java.lang.Object
An object that joins map entries in the same manner asJoiner
joins iterables and arrays. LikeJoiner
, it is thread-safe and immutable.In addition to operating on
Map
instances,MapJoiner
can operate onMultimap
entries in two distinct modes:- To output a separate entry for each key-value pair, pass
multimap.entries()
to aMapJoiner
method that accepts entries as input, and receive output of the formkey1=A&key1=B&key2=C
. - To output a single entry for each key, pass
multimap.asMap()
to aMapJoiner
method that accepts a map as input, and receive output of the formkey1=[A, B]&key2=C
.
- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <A extends java.lang.Appendable>
AappendTo(A appendable, java.lang.Iterable<? extends java.util.Map.Entry<?,?>> entries)
Appends the string representation of each entry inentries
, using the previously configured separator and key-value separator, toappendable
.<A extends java.lang.Appendable>
AappendTo(A appendable, java.util.Iterator<? extends java.util.Map.Entry<?,?>> parts)
Appends the string representation of each entry inentries
, using the previously configured separator and key-value separator, toappendable
.<A extends java.lang.Appendable>
AappendTo(A appendable, java.util.Map<?,?> map)
Appends the string representation of each entry ofmap
, using the previously configured separator and key-value separator, toappendable
.java.lang.StringBuilder
appendTo(java.lang.StringBuilder builder, java.lang.Iterable<? extends java.util.Map.Entry<?,?>> entries)
Appends the string representation of each entry inentries
, using the previously configured separator and key-value separator, tobuilder
.java.lang.StringBuilder
appendTo(java.lang.StringBuilder builder, java.util.Iterator<? extends java.util.Map.Entry<?,?>> entries)
Appends the string representation of each entry inentries
, using the previously configured separator and key-value separator, tobuilder
.java.lang.StringBuilder
appendTo(java.lang.StringBuilder builder, java.util.Map<?,?> map)
Appends the string representation of each entry ofmap
, using the previously configured separator and key-value separator, tobuilder
.java.lang.String
join(java.lang.Iterable<? extends java.util.Map.Entry<?,?>> entries)
Returns a string containing the string representation of each entry inentries
, using the previously configured separator and key-value separator.java.lang.String
join(java.util.Iterator<? extends java.util.Map.Entry<?,?>> entries)
Returns a string containing the string representation of each entry inentries
, using the previously configured separator and key-value separator.java.lang.String
join(java.util.Map<?,?> map)
Returns a string containing the string representation of each entry ofmap
, using the previously configured separator and key-value separator.Joiner.MapJoiner
useForNull(java.lang.String nullText)
Returns a map joiner with the same behavior as this one, except automatically substitutingnullText
for any provided null keys or values.
-
-
-
Method Detail
-
appendTo
@CanIgnoreReturnValue public <A extends java.lang.Appendable> A appendTo(A appendable, java.util.Map<?,?> map) throws java.io.IOException
Appends the string representation of each entry ofmap
, using the previously configured separator and key-value separator, toappendable
.- Throws:
java.io.IOException
-
appendTo
@CanIgnoreReturnValue public java.lang.StringBuilder appendTo(java.lang.StringBuilder builder, java.util.Map<?,?> map)
Appends the string representation of each entry ofmap
, using the previously configured separator and key-value separator, tobuilder
. Identical toappendTo(Appendable, Map)
, except that it does not throwIOException
.
-
appendTo
@CanIgnoreReturnValue public <A extends java.lang.Appendable> A appendTo(A appendable, java.lang.Iterable<? extends java.util.Map.Entry<?,?>> entries) throws java.io.IOException
Appends the string representation of each entry inentries
, using the previously configured separator and key-value separator, toappendable
.- Throws:
java.io.IOException
- Since:
- 10.0
-
appendTo
@CanIgnoreReturnValue public <A extends java.lang.Appendable> A appendTo(A appendable, java.util.Iterator<? extends java.util.Map.Entry<?,?>> parts) throws java.io.IOException
Appends the string representation of each entry inentries
, using the previously configured separator and key-value separator, toappendable
.- Throws:
java.io.IOException
- Since:
- 11.0
-
appendTo
@CanIgnoreReturnValue public java.lang.StringBuilder appendTo(java.lang.StringBuilder builder, java.lang.Iterable<? extends java.util.Map.Entry<?,?>> entries)
Appends the string representation of each entry inentries
, using the previously configured separator and key-value separator, tobuilder
. Identical toappendTo(Appendable, Iterable)
, except that it does not throwIOException
.- Since:
- 10.0
-
appendTo
@CanIgnoreReturnValue public java.lang.StringBuilder appendTo(java.lang.StringBuilder builder, java.util.Iterator<? extends java.util.Map.Entry<?,?>> entries)
Appends the string representation of each entry inentries
, using the previously configured separator and key-value separator, tobuilder
. Identical toappendTo(Appendable, Iterable)
, except that it does not throwIOException
.- Since:
- 11.0
-
join
public java.lang.String join(java.util.Map<?,?> map)
Returns a string containing the string representation of each entry ofmap
, using the previously configured separator and key-value separator.
-
join
public java.lang.String join(java.lang.Iterable<? extends java.util.Map.Entry<?,?>> entries)
Returns a string containing the string representation of each entry inentries
, using the previously configured separator and key-value separator.- Since:
- 10.0
-
join
public java.lang.String join(java.util.Iterator<? extends java.util.Map.Entry<?,?>> entries)
Returns a string containing the string representation of each entry inentries
, using the previously configured separator and key-value separator.- Since:
- 11.0
-
useForNull
public Joiner.MapJoiner useForNull(java.lang.String nullText)
Returns a map joiner with the same behavior as this one, except automatically substitutingnullText
for any provided null keys or values.
-
-