Package com.google.common.base
Class Joiner.MapJoiner
java.lang.Object
com.google.common.base.Joiner.MapJoiner
- Enclosing class:
Joiner
An object that joins map entries in the same manner as
Joiner joins iterables and
arrays. Like Joiner, it is thread-safe and immutable.
In addition to operating on Map instances, MapJoiner can operate on
Multimap entries in two distinct modes:
- To output a separate entry for each key-value pair, pass
multimap.entries()to aMapJoinermethod 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 aMapJoinermethod that accepts a map as input, and receive output of the formkey1=[A, B]&key2=C.
- Since:
- 2.0
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<A extends Appendable>
AAppends the string representation of each entry inentries, using the previously configured separator and key-value separator, toappendable.<A extends Appendable>
AAppends the string representation of each entry inentries, using the previously configured separator and key-value separator, toappendable.<A extends Appendable>
AAppends the string representation of each entry ofmap, using the previously configured separator and key-value separator, toappendable.appendTo(StringBuilder builder, Iterable<? extends Map.Entry<?, ?>> entries) Appends the string representation of each entry inentries, using the previously configured separator and key-value separator, tobuilder.appendTo(StringBuilder builder, Iterator<? extends Map.Entry<?, ?>> entries) Appends the string representation of each entry inentries, using the previously configured separator and key-value separator, tobuilder.appendTo(StringBuilder builder, Map<?, ?> map) Appends the string representation of each entry ofmap, using the previously configured separator and key-value separator, tobuilder.Returns a string containing the string representation of each entry inentries, using the previously configured separator and key-value separator.Returns a string containing the string representation of each entry inentries, using the previously configured separator and key-value separator.Returns a string containing the string representation of each entry ofmap, using the previously configured separator and key-value separator.useForNull(String nullText) Returns a map joiner with the same behavior as this one, except automatically substitutingnullTextfor any provided null keys or values.
-
Field Details
-
joiner
-
keyValueSeparator
-
-
Constructor Details
-
MapJoiner
-
-
Method Details
-
appendTo
Appends the string representation of each entry ofmap, using the previously configured separator and key-value separator, toappendable.- Throws:
IOException
-
appendTo
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
public <A extends Appendable> A appendTo(A appendable, Iterable<? extends Map.Entry<?, ?>> entries) throws IOExceptionAppends the string representation of each entry inentries, using the previously configured separator and key-value separator, toappendable.- Throws:
IOException- Since:
- 10.0
-
appendTo
public <A extends Appendable> A appendTo(A appendable, Iterator<? extends Map.Entry<?, ?>> parts) throws IOExceptionAppends the string representation of each entry inentries, using the previously configured separator and key-value separator, toappendable.- Throws:
IOException- Since:
- 11.0
-
appendTo
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
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
Returns a string containing the string representation of each entry ofmap, using the previously configured separator and key-value separator. -
join
Returns a string containing the string representation of each entry inentries, using the previously configured separator and key-value separator.- Since:
- 10.0
-
join
Returns a string containing the string representation of each entry inentries, using the previously configured separator and key-value separator.- Since:
- 11.0
-
useForNull
Returns a map joiner with the same behavior as this one, except automatically substitutingnullTextfor any provided null keys or values.
-