Class ImmutableSortedSetMultimapImpl<K,V>

java.lang.Object

org.eclipse.collections.impl.multimap.AbstractMultimap<K, V, ImmutableSortedSet<V>>

org.eclipse.collections.impl.multimap.AbstractImmutableMultimap<K, V, ImmutableSortedSet<V>>

org.eclipse.collections.impl.multimap.set.sorted.ImmutableSortedSetMultimapImpl<K,V>

All Implemented Interfaces:

Serializable, ImmutableMultimap<K,V>, Multimap<K,V>, OrderedIterableMultimap<K,V>, ReversibleIterableMultimap<K,V>, SortedIterableMultimap<K,V>, ImmutableSetIterableMultimap<K,V>, SetMultimap<K,V>, ImmutableSortedSetMultimap<K,V>, SortedSetMultimap<K,V>

public final class ImmutableSortedSetMultimapImpl<K,V>
extends AbstractImmutableMultimap<K, V, ImmutableSortedSet<V>>
implements ImmutableSortedSetMultimap<K,V>, Serializable

The default ImmutableSortedSetMultimap implementation.

Since:

1.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ImmutableSortedSetMultimapImpl.ImmutableSortedSetMultimapSerializationProxy<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private final Comparator<? super V>	comparator
private static final long	serialVersionUID

Fields inherited from class AbstractImmutableMultimap

map

Constructor Summary

Constructors

Constructor	Description
ImmutableSortedSetMultimapImpl(ImmutableMap<K, ImmutableSortedSet<V>> map)
ImmutableSortedSetMultimapImpl(ImmutableMap<K, ImmutableSortedSet<V>> map, Comparator<? super V> comparator)
ImmutableSortedSetMultimapImpl(MutableMap<K, ImmutableSortedSet<V>> map)
ImmutableSortedSetMultimapImpl(MutableMap<K, ImmutableSortedSet<V>> map, Comparator<? super V> comparator)

Method Summary

Modifier and Type	Method	Description
<K2,V2> ImmutableBagMultimap<K2,V2>	collectKeyMultiValues(Function<? super K, ? extends K2> keyFunction, Function<? super V, ? extends V2> valueFunction)	Returns a new multimap with the results of applying the specified keyFunction and valueFunction on each key and corresponding values of the source multimap.
<K2,V2> ImmutableBagMultimap<K2,V2>	collectKeysValues(Function2<? super K, ? super V, Pair<K2,V2>> function)	Returns a new multimap with the results of applying the specified function on each key and value of the source multimap.
<V2> ImmutableListMultimap<K,V2>	collectValues(Function<? super V, ? extends V2> function)	Returns a new multimap with the results of applying the specified function on each value of the source multimap.
Comparator<? super V>	comparator()
protected ImmutableSortedSet<V>	createCollection()	Creates the collection of values for a single key.
ImmutableSetMultimap<V,K>	flip()	Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
ImmutableSortedSetMultimap<K,V>	newEmpty()	Creates a new instance of the same implementation type, using the default capacity and growth parameters.
ImmutableSortedSetMultimap<K,V>	newWith(K key, V value)
ImmutableSortedSetMultimap<K,V>	newWithAll(K key, Iterable<? extends V> values)
ImmutableSortedSetMultimap<K,V>	newWithout(Object key, Object value)
ImmutableSortedSetMultimap<K,V>	newWithoutAll(Object key)
ImmutableSortedSetMultimap<K,V>	rejectKeysMultiValues(Predicate2<? super K, ? super RichIterable<V>> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
ImmutableSortedSetMultimap<K,V>	rejectKeysValues(Predicate2<? super K, ? super V> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
ImmutableSortedSetMultimap<K,V>	selectKeysMultiValues(Predicate2<? super K, ? super RichIterable<V>> predicate)	Returns all elements of the source multimap that satisfies the predicate.
ImmutableSortedSetMultimap<K,V>	selectKeysValues(Predicate2<? super K, ? super V> predicate)	Returns all elements of the source multimap that satisfies the predicate.
ImmutableSortedSetMultimap<K,V>	toImmutable()	Returns an immutable copy of this Multimap if it is not already immutable.
MutableSortedSetMultimap<K,V>	toMutable()	Returns a mutable copy of this Multimap.
private Object	writeReplace()

Methods inherited from class AbstractImmutableMultimap

get, getMap, isEmpty, keySet, readResolve, size, sizeDistinct, toMap, toMap

Methods inherited from class AbstractMultimap

collectKeyMultiValues, collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, createCollectionBlock, equals, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, toString, valuesView

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ImmutableSortedSetMultimap

get

Methods inherited from interface Multimap

collectKeyMultiValues, collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, equals, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, isEmpty, keyBag, keyMultiValuePairsView, keySet, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, size, sizeDistinct, toMap, toMap, valuesView

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

comparator

private final Comparator<? super V> comparator

Constructor Details

ImmutableSortedSetMultimapImpl

ImmutableSortedSetMultimapImpl(MutableMap<K, ImmutableSortedSet<V>> map)

ImmutableSortedSetMultimapImpl

public ImmutableSortedSetMultimapImpl(MutableMap<K, ImmutableSortedSet<V>> map,
 Comparator<? super V> comparator)

ImmutableSortedSetMultimapImpl

ImmutableSortedSetMultimapImpl(ImmutableMap<K, ImmutableSortedSet<V>> map)

ImmutableSortedSetMultimapImpl

public ImmutableSortedSetMultimapImpl(ImmutableMap<K, ImmutableSortedSet<V>> map,
 Comparator<? super V> comparator)

Method Details

createCollection

protected ImmutableSortedSet<V> createCollection()

Description copied from class: AbstractMultimap

Creates the collection of values for a single key.

Collections with weak, soft, or phantom references are not supported. Each call to createCollection should create a new instance.

The returned collection class determines whether duplicate key-value pairs are allowed.

Specified by:

createCollection in class AbstractMultimap<K, V, ImmutableSortedSet<V>>

Returns:

an empty collection of values

newEmpty

public ImmutableSortedSetMultimap<K,V> newEmpty()

Description copied from interface: Multimap

Creates a new instance of the same implementation type, using the default capacity and growth parameters.

Specified by:

newEmpty in interface ImmutableMultimap<K,V>

Specified by:

newEmpty in interface ImmutableSetIterableMultimap<K,V>

Specified by:

newEmpty in interface ImmutableSortedSetMultimap<K,V>

Specified by:

newEmpty in interface Multimap<K,V>

Specified by:

newEmpty in interface OrderedIterableMultimap<K,V>

Specified by:

newEmpty in interface ReversibleIterableMultimap<K,V>

Specified by:

newEmpty in interface SetMultimap<K,V>

Specified by:

newEmpty in interface SortedIterableMultimap<K,V>

Specified by:

newEmpty in interface SortedSetMultimap<K,V>

comparator

public Comparator<? super V> comparator()

Specified by:

comparator in interface SortedIterableMultimap<K,V>

toMutable

public MutableSortedSetMultimap<K,V> toMutable()

Description copied from interface: Multimap

Returns a mutable copy of this Multimap.

Specified by:

toMutable in interface Multimap<K,V>

Specified by:

toMutable in interface SortedSetMultimap<K,V>

toImmutable

public ImmutableSortedSetMultimap<K,V> toImmutable()

Description copied from interface: Multimap

Returns an immutable copy of this Multimap if it is not already immutable. If the Multimap is immutable, it will return itself.

The returned Multimap will be Serializable if this Multimap is Serializable.

Specified by:

toImmutable in interface Multimap<K,V>

Specified by:

toImmutable in interface SortedSetMultimap<K,V>

Overrides:

toImmutable in class AbstractImmutableMultimap<K, V, ImmutableSortedSet<V>>

writeReplace

private Object writeReplace()

newWith

public ImmutableSortedSetMultimap<K,V> newWith(K key,
 V value)

Specified by:

newWith in interface ImmutableMultimap<K,V>

Specified by:

newWith in interface ImmutableSetIterableMultimap<K,V>

Specified by:

newWith in interface ImmutableSortedSetMultimap<K,V>

newWithout

public ImmutableSortedSetMultimap<K,V> newWithout(Object key,
 Object value)

Specified by:

newWithout in interface ImmutableMultimap<K,V>

Specified by:

newWithout in interface ImmutableSetIterableMultimap<K,V>

Specified by:

newWithout in interface ImmutableSortedSetMultimap<K,V>

newWithAll

public ImmutableSortedSetMultimap<K,V> newWithAll(K key,
 Iterable<? extends V> values)

Specified by:

newWithAll in interface ImmutableMultimap<K,V>

Specified by:

newWithAll in interface ImmutableSetIterableMultimap<K,V>

Specified by:

newWithAll in interface ImmutableSortedSetMultimap<K,V>

newWithoutAll

public ImmutableSortedSetMultimap<K,V> newWithoutAll(Object key)

Specified by:

newWithoutAll in interface ImmutableMultimap<K,V>

Specified by:

newWithoutAll in interface ImmutableSetIterableMultimap<K,V>

Specified by:

newWithoutAll in interface ImmutableSortedSetMultimap<K,V>

flip

public ImmutableSetMultimap<V,K> flip()

Description copied from interface: Multimap

Given a Multimap from Domain -> Range return a multimap from Range -> Domain.

Specified by:

flip in interface ImmutableMultimap<K,V>

Specified by:

flip in interface ImmutableSetIterableMultimap<K,V>

Specified by:

flip in interface ImmutableSortedSetMultimap<K,V>

Specified by:

flip in interface Multimap<K,V>

Specified by:

flip in interface SetMultimap<K,V>

selectKeysValues

public ImmutableSortedSetMultimap<K,V> selectKeysValues(Predicate2<? super K, ? super V> predicate)

Description copied from interface: Multimap

Returns all elements of the source multimap that satisfies the predicate. This method is also commonly called filter.

e.g.
return multimap.selectKeysValues(new Predicate2<Integer, Person>()
{
    public boolean accept(Integer age, Person person)
    {
        return (age >= 18)
                 && (person.getAddress().getCity().equals("Metuchen"));
    }
});

Specified by:

selectKeysValues in interface ImmutableMultimap<K,V>

Specified by:

selectKeysValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

selectKeysValues in interface ImmutableSortedSetMultimap<K,V>

Specified by:

selectKeysValues in interface Multimap<K,V>

Specified by:

selectKeysValues in interface OrderedIterableMultimap<K,V>

Specified by:

selectKeysValues in interface ReversibleIterableMultimap<K,V>

Specified by:

selectKeysValues in interface SetMultimap<K,V>

Specified by:

selectKeysValues in interface SortedIterableMultimap<K,V>

Specified by:

selectKeysValues in interface SortedSetMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the select criteria

Returns:

Multimap, which contains elements as a result of the select criteria

rejectKeysValues

public ImmutableSortedSetMultimap<K,V> rejectKeysValues(Predicate2<? super K, ? super V> predicate)

Description copied from interface: Multimap

Returns all elements of the source multimap that don't satisfy the predicate.

e.g.
return multimap.rejectKeysValues(new Predicate2<Integer, Person>()
{
    public boolean accept(Integer age, Person person)
    {
        return (age >= 18)
                 && (person.getAddress().getCity().equals("Metuchen"));
    }
});

Specified by:

rejectKeysValues in interface ImmutableMultimap<K,V>

Specified by:

rejectKeysValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

rejectKeysValues in interface ImmutableSortedSetMultimap<K,V>

Specified by:

rejectKeysValues in interface Multimap<K,V>

Specified by:

rejectKeysValues in interface OrderedIterableMultimap<K,V>

Specified by:

rejectKeysValues in interface ReversibleIterableMultimap<K,V>

Specified by:

rejectKeysValues in interface SetMultimap<K,V>

Specified by:

rejectKeysValues in interface SortedIterableMultimap<K,V>

Specified by:

rejectKeysValues in interface SortedSetMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the reject criteria

Returns:

Multimap, which contains elements that don't satisfy the predicate

selectKeysMultiValues

public ImmutableSortedSetMultimap<K,V> selectKeysMultiValues(Predicate2<? super K, ? super RichIterable<V>> predicate)

Description copied from interface: Multimap

Returns all elements of the source multimap that satisfies the predicate. This method is also commonly called filter.

e.g.
return multimap.selectKeysMultiValues(new Predicate2<Integer, Iterable<Person>>()
{
    public boolean accept(Integer age, Iterable<Person> values)
    {
        return (age >= 18)
                 && ((RichIterable<Person>)values.size() >= 2);
    }
});

Specified by:

selectKeysMultiValues in interface ImmutableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface ImmutableSortedSetMultimap<K,V>

Specified by:

selectKeysMultiValues in interface Multimap<K,V>

Specified by:

selectKeysMultiValues in interface OrderedIterableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface ReversibleIterableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface SetMultimap<K,V>

Specified by:

selectKeysMultiValues in interface SortedIterableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface SortedSetMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the select criteria

Returns:

Multimap, which contains elements as a result of the select criteria

rejectKeysMultiValues

public ImmutableSortedSetMultimap<K,V> rejectKeysMultiValues(Predicate2<? super K, ? super RichIterable<V>> predicate)

Description copied from interface: Multimap

Returns all elements of the source multimap that don't satisfy the predicate.

e.g.
return multimap.rejectKeysMultiValues(new Predicate2<Integer, Iterable<Person>>()
{
    public boolean accept(Integer age, Iterable<Person> values)
    {
        return (age >= 18)
                 && ((RichIterable<Person>)values.size() >= 2);
    }
});

Specified by:

rejectKeysMultiValues in interface ImmutableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface ImmutableSortedSetMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface Multimap<K,V>

Specified by:

rejectKeysMultiValues in interface OrderedIterableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface ReversibleIterableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface SetMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface SortedIterableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface SortedSetMultimap<K,V>

Parameters:

predicate - a Predicate2 to use as the reject criteria

Returns:

Multimap, which contains elements that don't satisfy the predicate

collectKeysValues

public <K2,V2> ImmutableBagMultimap<K2,V2> collectKeysValues(Function2<? super K, ? super V, Pair<K2,V2>> function)

Description copied from interface: Multimap

Returns a new multimap with the results of applying the specified function on each key and value of the source multimap. This method is also commonly called transform or map.

e.g.
return multimap.collectKeysValues(new Function2<Integer, Person, Pair<String, String>>()
{
    public Pair<String, String> valueOf(Integer age, Person person)
    {
        return Tuples.pair(age.toString(), person.getLastName());
    }
});

Specified by:

collectKeysValues in interface ImmutableMultimap<K,V>

Specified by:

collectKeysValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

collectKeysValues in interface ImmutableSortedSetMultimap<K,V>

Specified by:

collectKeysValues in interface Multimap<K,V>

Specified by:

collectKeysValues in interface OrderedIterableMultimap<K,V>

Specified by:

collectKeysValues in interface SortedSetMultimap<K,V>

Parameters:

function - a Function2 to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation

collectKeyMultiValues

public <K2,V2> ImmutableBagMultimap<K2,V2> collectKeyMultiValues(Function<? super K, ? extends K2> keyFunction,
 Function<? super V, ? extends V2> valueFunction)

Description copied from interface: Multimap

Returns a new multimap with the results of applying the specified keyFunction and valueFunction on each key and corresponding values of the source multimap. This method is also commonly called transform or map.

e.g.
return multimap.collectKeyMultiValues(each -> each + 1, Person::getLastName);

Specified by:

collectKeyMultiValues in interface ImmutableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface ImmutableSortedSetMultimap<K,V>

Specified by:

collectKeyMultiValues in interface Multimap<K,V>

Specified by:

collectKeyMultiValues in interface OrderedIterableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface SortedSetMultimap<K,V>

Parameters:

keyFunction - Function to use transformation to get the key

valueFunction - Function to use transformation to get the values

Returns:

a new Multimap, which contains elements as a result of the transformation

collectValues

public <V2> ImmutableListMultimap<K,V2> collectValues(Function<? super V, ? extends V2> function)

Description copied from interface: Multimap

Returns a new multimap with the results of applying the specified function on each value of the source multimap. This method is also commonly called transform or map.

e.g.
return multimap.collectValues(new Function<Person, String>()
{
    public String valueOf(Person person)
    {
        return person.getLastName();
    }
});

Specified by:

collectValues in interface ImmutableMultimap<K,V>

Specified by:

collectValues in interface ImmutableSetIterableMultimap<K,V>

Specified by:

collectValues in interface ImmutableSortedSetMultimap<K,V>

Specified by:

collectValues in interface Multimap<K,V>

Specified by:

collectValues in interface OrderedIterableMultimap<K,V>

Specified by:

collectValues in interface ReversibleIterableMultimap<K,V>

Specified by:

collectValues in interface SortedIterableMultimap<K,V>

Specified by:

collectValues in interface SortedSetMultimap<K,V>

Parameters:

function - a Function to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation