com.diffplug.common.rx

Class Immutables

java.lang.Object

com.diffplug.common.rx.Immutables

public class Immutables
extends Object

Methods for manipulating Guava's immutable collections.

For each Guava ImmutableCollection, (where Collection is List, Set, SortedSet, Map, SortedMap, BiMap) there is a method:

• ImmutableCollection mutateCollection(ImmutableCollection source, Consumer<MutableCollection> mutator)

Which works like this:

• Copy the ImmutableCollection into a new MutableCollection.
• Pass this MutableCollection collection to the mutator.
• Copy the (now-mutated) MutableCollection into a new ImmutableCollection.
• Return this ImmutableCollecion.

There are also Function<ImmutableCollection, ImmutableCollection> mutatorCollection(Consumer<MutableCollection> mutator) methods for each type, to easily create functions which operate on immutable collections.

This class also contains the simple optionalToSet(java.util.Optional<T>) and optionalFrom(ImmutableCollection) methods.

Method Summary

Modifier and Type	Method and Description
static <K,V> ImmutableBiMap<K,V>	mutateBiMap(ImmutableBiMap<K,V> source, Consumer<BiMap<K,V>> mutator) Returns a mutated version of the given sorted map.
static <T> ImmutableList<T>	mutateList(ImmutableList<T> source, Consumer<List<T>> mutator) Returns a mutated version of the given list.
static <K,V> ImmutableMap<K,V>	mutateMap(ImmutableMap<K,V> source, Consumer<Map<K,V>> mutator) Returns a mutated version of the given map.
static <T> ImmutableSet<T>	mutateSet(ImmutableSet<T> source, Consumer<Set<T>> mutator) Returns a mutated version of the given set.
static <K,V> ImmutableSortedMap<K,V>	mutateSortedMap(ImmutableSortedMap<K,V> source, Consumer<NavigableMap<K,V>> mutator) Returns a mutated version of the given sorted map.
static <T> ImmutableSortedSet<T>	mutateSortedSet(ImmutableSortedSet<T> source, Consumer<NavigableSet<T>> mutator) Returns a mutated version of the given sorted set.
static <K,V> UnaryOperator<ImmutableBiMap<K,V>>	mutatorBiMap(Consumer<BiMap<K,V>> mutator) Returns a function which mutates a sorted map using the given mutator.
static <T> UnaryOperator<ImmutableList<T>>	mutatorList(Consumer<List<T>> mutator) Returns a function which mutates a list using the given mutator.
static <K,V> UnaryOperator<ImmutableMap<K,V>>	mutatorMap(Consumer<Map<K,V>> mutator) Returns a function which mutates a map using the given mutator.
static <T> UnaryOperator<ImmutableSet<T>>	mutatorSet(Consumer<Set<T>> mutator) Returns a function which mutates a set using the given mutator.
static <K,V> UnaryOperator<ImmutableSortedMap<K,V>>	mutatorSortedMap(Consumer<NavigableMap<K,V>> mutator) Returns a function which mutates a sorted map using the given mutator.
static <T> UnaryOperator<ImmutableSortedSet<T>>	mutatorSortedSet(Consumer<NavigableSet<T>> mutator) Returns a function which mutates a sorted set using the given mutator.
static <T> Optional<T>	optionalFrom(ImmutableCollection<T> collection) Converts an ImmutableCollection to an Optional.
static <T> ImmutableSet<T>	optionalToSet(Optional<T> selection) Converts an Optional to an ImmutableSet.
static <T> Collector<T,?,ImmutableList<T>>	toList() A Collector which returns an ImmutableList.
static <T,K,V> Collector<T,?,ImmutableMap<K,V>>	toMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends V> valueMapper) A Collector which returns an ImmutableMap using the given pair of key and value functions.
static <T> Collector<T,?,ImmutableSet<T>>	toSet() A Collector which returns an ImmutableSet.
static <T,K extends Comparable<?>,V> Collector<T,?,ImmutableSortedMap<K,V>>	toSortedMap(Comparator<K> comparator, Function<? super T,? extends K> keyMapper, Function<? super T,? extends V> valueMapper) A Collector which returns an ImmutableSortedMap which is ordered by the given comparator, and populated by the given pair of key and value functions.
static <T,K extends Comparable<?>,V> Collector<T,?,ImmutableSortedMap<K,V>>	toSortedMap(Function<? super T,? extends K> keyMapper, Function<? super T,? extends V> valueMapper) A Collector which returns an ImmutableSortedMap which is populated by the given pair of key and value functions.
static <T extends Comparable<?>> Collector<T,?,ImmutableSortedSet<T>>	toSortedSet() A Collector of Comparables which returns an ImmutableSortedSet.
static <T> Collector<T,?,ImmutableSortedSet<T>>	toSortedSet(Comparator<T> comparator) A Collector which returns an ImmutableSortedSet which is ordered by the given comparator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

mutateList

public static <T> ImmutableList<T> mutateList(ImmutableList<T> source,
                                              Consumer<List<T>> mutator)

Returns a mutated version of the given list.

mutateSet

public static <T> ImmutableSet<T> mutateSet(ImmutableSet<T> source,
                                            Consumer<Set<T>> mutator)

Returns a mutated version of the given set.

mutateSortedSet

public static <T> ImmutableSortedSet<T> mutateSortedSet(ImmutableSortedSet<T> source,
                                                        Consumer<NavigableSet<T>> mutator)

Returns a mutated version of the given sorted set.

mutateMap

public static <K,V> ImmutableMap<K,V> mutateMap(ImmutableMap<K,V> source,
                                                Consumer<Map<K,V>> mutator)

Returns a mutated version of the given map.

mutateSortedMap

public static <K,V> ImmutableSortedMap<K,V> mutateSortedMap(ImmutableSortedMap<K,V> source,
                                                            Consumer<NavigableMap<K,V>> mutator)

Returns a mutated version of the given sorted map.

mutateBiMap

public static <K,V> ImmutableBiMap<K,V> mutateBiMap(ImmutableBiMap<K,V> source,
                                                    Consumer<BiMap<K,V>> mutator)

Returns a mutated version of the given sorted map.

mutatorList

public static <T> UnaryOperator<ImmutableList<T>> mutatorList(Consumer<List<T>> mutator)

Returns a function which mutates a list using the given mutator.

mutatorSet

public static <T> UnaryOperator<ImmutableSet<T>> mutatorSet(Consumer<Set<T>> mutator)

Returns a function which mutates a set using the given mutator.

mutatorSortedSet

public static <T> UnaryOperator<ImmutableSortedSet<T>> mutatorSortedSet(Consumer<NavigableSet<T>> mutator)

Returns a function which mutates a sorted set using the given mutator.

mutatorMap

public static <K,V> UnaryOperator<ImmutableMap<K,V>> mutatorMap(Consumer<Map<K,V>> mutator)

Returns a function which mutates a map using the given mutator.

mutatorSortedMap

public static <K,V> UnaryOperator<ImmutableSortedMap<K,V>> mutatorSortedMap(Consumer<NavigableMap<K,V>> mutator)

Returns a function which mutates a sorted map using the given mutator.

mutatorBiMap

public static <K,V> UnaryOperator<ImmutableBiMap<K,V>> mutatorBiMap(Consumer<BiMap<K,V>> mutator)

Returns a function which mutates a sorted map using the given mutator.

optionalToSet

public static <T> ImmutableSet<T> optionalToSet(Optional<T> selection)

Converts an Optional to an ImmutableSet.

optionalFrom

public static <T> Optional<T> optionalFrom(ImmutableCollection<T> collection)

Converts an ImmutableCollection to an Optional.

Throws:

IllegalArgumentException - if there are multiple elements.

toList

public static <T> Collector<T,?,ImmutableList<T>> toList()

A Collector which returns an ImmutableList.

toSet

public static <T> Collector<T,?,ImmutableSet<T>> toSet()

A Collector which returns an ImmutableSet.

toSortedSet

public static <T extends Comparable<?>> Collector<T,?,ImmutableSortedSet<T>> toSortedSet()

A Collector of Comparables which returns an ImmutableSortedSet.

toSortedSet

public static <T> Collector<T,?,ImmutableSortedSet<T>> toSortedSet(Comparator<T> comparator)

A Collector which returns an ImmutableSortedSet which is ordered by the given comparator.

toMap

public static <T,K,V> Collector<T,?,ImmutableMap<K,V>> toMap(Function<? super T,? extends K> keyMapper,
                                                             Function<? super T,? extends V> valueMapper)

A Collector which returns an ImmutableMap using the given pair of key and value functions.

toSortedMap

public static <T,K extends Comparable<?>,V> Collector<T,?,ImmutableSortedMap<K,V>> toSortedMap(Function<? super T,? extends K> keyMapper,
                                                                                               Function<? super T,? extends V> valueMapper)

A Collector which returns an ImmutableSortedMap which is populated by the given pair of key and value functions.

toSortedMap

public static <T,K extends Comparable<?>,V> Collector<T,?,ImmutableSortedMap<K,V>> toSortedMap(Comparator<K> comparator,
                                                                                               Function<? super T,? extends K> keyMapper,
                                                                                               Function<? super T,? extends V> valueMapper)

A Collector which returns an ImmutableSortedMap which is ordered by the given comparator, and populated by the given pair of key and value functions.