org.eclipse.xtext.xbase.typesystem.util

Class MultimapJoiner

java.lang.Object

org.eclipse.xtext.xbase.typesystem.util.MultimapJoiner

public class MultimapJoiner
extends Object

An object that joins multimaps in the same manner as Joiner joins iterables and arrays. Like Joiner, it is thread-safe and immutable.

In contrast to using a Joiner.MapJoiner in conjunction with Multimap, the MultimapJoiner allows to use a custom joiner for the values of an entry.

Author:

Sebastian Zarnekow - Initial contribution and API

Constructor Summary

Constructors

Constructor and Description
MultimapJoiner(com.google.common.base.Joiner entryJoiner, String separator, String keyValueSeparator)

Method Summary

Methods

Modifier and Type	Method and Description
<A extends Appendable> A	appendTo(A appendable, Iterable<? extends Map.Entry<?,? extends Collection<?>>> entries) Appends the string representation of each entry in entries, using the previously configured separator and key-value separator, to appendable.
<A extends Appendable> A	appendTo(A appendable, Map<?,? extends Collection<?>> map) Appends the string representation of each entry of map, using the previously configured separator and key-value separator, to appendable.
<A extends Appendable> A	appendTo(A appendable, com.google.common.collect.Multimap<?,?> map) Appends the string representation of each entry of map, using the previously configured separator and key-value separator, to appendable.
StringBuilder	appendTo(StringBuilder builder, Iterable<? extends Map.Entry<?,? extends Collection<?>>> entries) Appends the string representation of each entry in entries, using the previously configured separator and key-value separator, to builder.
StringBuilder	appendTo(StringBuilder builder, Map<?,? extends Collection<?>> map) Appends the string representation of each entry of map, using the previously configured separator and key-value separator, to builder.
StringBuilder	appendTo(StringBuilder builder, com.google.common.collect.Multimap<?,?> map) Appends the string representation of each entry of map, using the previously configured separator and key-value separator, to builder.
String	join(Iterable<? extends Map.Entry<?,? extends Collection<?>>> entries) Returns a string containing the string representation of each entry in entries, using the previously configured separator and key-value separator.
String	join(com.google.common.collect.Multimap<?,?> map) Returns a string containing the string representation of each entry of map, using the previously configured separator and key-value separator.
MultimapJoiner	skipNulls()
protected CharSequence	toString(Object part)
MultimapJoiner	useForNull(String nullText) Returns a multimap 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

Constructor Detail

MultimapJoiner

public MultimapJoiner(com.google.common.base.Joiner entryJoiner,
              String separator,
              String keyValueSeparator)

Method Detail

appendTo

public <A extends Appendable> A appendTo(A appendable,
                                com.google.common.collect.Multimap<?,?> map)
                              throws IOException

Appends the string representation of each entry of map, using the previously configured separator and key-value separator, to appendable.

Throws:

IOException

appendTo

public <A extends Appendable> A appendTo(A appendable,
                                Map<?,? extends Collection<?>> map)
                              throws IOException

Appends the string representation of each entry of map, using the previously configured separator and key-value separator, to appendable.

Throws:

IOException

appendTo

public StringBuilder appendTo(StringBuilder builder,
                     com.google.common.collect.Multimap<?,?> 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, Multimap), except that it does not throw IOException.

appendTo

public StringBuilder appendTo(StringBuilder builder,
                     Map<?,? extends Collection<?>> 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.

join

public String join(com.google.common.collect.Multimap<?,?> map)

Returns a string containing the string representation of each entry of map, using the previously configured separator and key-value separator.

appendTo

public <A extends Appendable> A appendTo(A appendable,
                                Iterable<? extends Map.Entry<?,? extends Collection<?>>> entries)
                              throws IOException

Appends the string representation of each entry in entries, using the previously configured separator and key-value separator, to appendable.

Throws:

IOException

appendTo

public StringBuilder appendTo(StringBuilder builder,
                     Iterable<? extends Map.Entry<?,? extends Collection<?>>> 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.

join

public String join(Iterable<? extends Map.Entry<?,? extends Collection<?>>> entries)

Returns a string containing the string representation of each entry in entries, using the previously configured separator and key-value separator.

toString

protected CharSequence toString(Object part)

skipNulls

public MultimapJoiner skipNulls()

useForNull

public MultimapJoiner useForNull(String nullText)

Returns a multimap joiner with the same behavior as this one, except automatically substituting nullText for any provided null keys or values.