Class 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 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 a MapJoiner method that accepts entries as input, and receive output of the form key1=A&key1=B&key2=C.
    • To output a single entry for each key, pass multimap.asMap() to a MapJoiner method that accepts a map as input, and receive output of the form key1=[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>
      A
      appendTo​(A appendable, java.lang.Iterable<? extends java.util.Map.Entry<?,​?>> entries)
      Appends the string representation of each entry in entries, using the previously configured separator and key-value separator, to appendable.
      <A extends java.lang.Appendable>
      A
      appendTo​(A appendable, java.util.Iterator<? extends java.util.Map.Entry<?,​?>> parts)
      Appends the string representation of each entry in entries, using the previously configured separator and key-value separator, to appendable.
      <A extends java.lang.Appendable>
      A
      appendTo​(A appendable, java.util.Map<?,​?> map)
      Appends the string representation of each entry of map, using the previously configured separator and key-value separator, to appendable.
      java.lang.StringBuilder appendTo​(java.lang.StringBuilder builder, java.lang.Iterable<? extends java.util.Map.Entry<?,​?>> entries)
      Appends the string representation of each entry in entries, using the previously configured separator and key-value separator, to builder.
      java.lang.StringBuilder appendTo​(java.lang.StringBuilder builder, java.util.Iterator<? extends java.util.Map.Entry<?,​?>> entries)
      Appends the string representation of each entry in entries, using the previously configured separator and key-value separator, to builder.
      java.lang.StringBuilder appendTo​(java.lang.StringBuilder builder, java.util.Map<?,​?> map)
      Appends the string representation of each entry of map, using the previously configured separator and key-value separator, to builder.
      java.lang.String join​(java.lang.Iterable<? extends java.util.Map.Entry<?,​?>> entries)
      Returns a string containing the string representation of each entry in entries, 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 in entries, 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 of map, 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 substituting nullText for any provided null keys or values.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • 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 of map, using the previously configured separator and key-value separator, to appendable.
        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 of map, using the previously configured separator and key-value separator, to builder. Identical to appendTo(Appendable, Map), except that it does not throw IOException.
      • appendTo

        @Beta
        @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 in entries, using the previously configured separator and key-value separator, to appendable.
        Throws:
        java.io.IOException
        Since:
        10.0
      • appendTo

        @Beta
        @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 in entries, using the previously configured separator and key-value separator, to appendable.
        Throws:
        java.io.IOException
        Since:
        11.0
      • appendTo

        @Beta
        @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 in entries, using the previously configured separator and key-value separator, to builder. Identical to appendTo(Appendable, Iterable), except that it does not throw IOException.
        Since:
        10.0
      • appendTo

        @Beta
        @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 in entries, using the previously configured separator and key-value separator, to builder. Identical to appendTo(Appendable, Iterable), except that it does not throw IOException.
        Since:
        11.0
      • join

        public java.lang.String join​(java.util.Map<?,​?> map)
        Returns a string containing the string representation of each entry of map, using the previously configured separator and key-value separator.
      • join

        @Beta
        public java.lang.String join​(java.lang.Iterable<? extends java.util.Map.Entry<?,​?>> entries)
        Returns a string containing the string representation of each entry in entries, using the previously configured separator and key-value separator.
        Since:
        10.0
      • join

        @Beta
        public java.lang.String join​(java.util.Iterator<? extends java.util.Map.Entry<?,​?>> entries)
        Returns a string containing the string representation of each entry in entries, 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 substituting nullText for any provided null keys or values.