Class TreeSortedSetMultimap<K,V>

java.lang.Object

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

org.eclipse.collections.impl.multimap.AbstractMutableMultimap<K, V, MutableSortedSet<V>>

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

All Implemented Interfaces:

Externalizable, Serializable, Multimap<K,V>, MutableMultimap<K,V>, OrderedIterableMultimap<K,V>, ReversibleIterableMultimap<K,V>, SortedIterableMultimap<K,V>, MutableSetIterableMultimap<K,V>, SetMultimap<K,V>, MutableSortedSetMultimap<K,V>, SortedSetMultimap<K,V>

public final class TreeSortedSetMultimap<K,V>
extends AbstractMutableMultimap<K, V, MutableSortedSet<V>>
implements MutableSortedSetMultimap<K,V>, Externalizable

See Also:

• Serialized Form

Field Summary

Fields

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

Fields inherited from class AbstractMutableMultimap

map, totalSize

Constructor Summary

Constructors

Constructor	Description
TreeSortedSetMultimap()
TreeSortedSetMultimap(Iterable<Pair<K,V>> inputIterable)
TreeSortedSetMultimap(Comparator<? super V> comparator)
TreeSortedSetMultimap(Multimap<? extends K, ? extends V> multimap)
TreeSortedSetMultimap(Pair<K,V>... pairs)

Method Summary

Modifier and Type	Method	Description
MutableSortedSetMultimap<K,V>	asSynchronized()	Returns a synchronized wrapper backed by this multimap.
<K2,V2> HashBagMultimap<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> HashBagMultimap<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> FastListMultimap<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 MutableSortedSet<V>	createCollection()	Creates the collection of values for a single key.
protected MutableMap<K, MutableSortedSet<V>>	createMap()
protected MutableMap<K, MutableSortedSet<V>>	createMapWithKeyCount(int keyCount)
MutableSetMultimap<V,K>	flip()	Given a Multimap from Domain -> Range return a multimap from Range -> Domain.
TreeSortedSetMultimap<K,V>	newEmpty()	Creates a new instance of the same implementation type, using the default capacity and growth parameters.
static <K,V> TreeSortedSetMultimap<K,V>	newMultimap()
static <K,V> TreeSortedSetMultimap<K,V>	newMultimap(Iterable<Pair<K,V>> inputIterable)
static <K,V> TreeSortedSetMultimap<K,V>	newMultimap(Comparator<? super V> comparator)
static <K,V> TreeSortedSetMultimap<K,V>	newMultimap(Multimap<? extends K, ? extends V> multimap)
static <K,V> TreeSortedSetMultimap<K,V>	newMultimap(Pair<K,V>... pairs)
void	readExternal(ObjectInput in)
TreeSortedSetMultimap<K,V>	rejectKeysMultiValues(Predicate2<? super K, ? super RichIterable<V>> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
TreeSortedSetMultimap<K,V>	rejectKeysValues(Predicate2<? super K, ? super V> predicate)	Returns all elements of the source multimap that don't satisfy the predicate.
TreeSortedSetMultimap<K,V>	selectKeysMultiValues(Predicate2<? super K, ? super RichIterable<V>> predicate)	Returns all elements of the source multimap that satisfies the predicate.
TreeSortedSetMultimap<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.
void	writeExternal(ObjectOutput out)

Methods inherited from class AbstractMutableMultimap

addToTotalSize, clear, clearTotalSize, decrementTotalSize, get, getIfAbsentPutAll, getMap, incrementTotalSize, isEmpty, keySet, put, putAll, putAll, remove, removeAll, replaceValues, size, sizeDistinct, subtractFromTotalSize, 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 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

Methods inherited from interface MutableMultimap

add, clear, put, putAll, putAll, putAllPairs, putAllPairs, remove

Methods inherited from interface MutableSortedSetMultimap

get, getIfAbsentPutAll, removeAll, replaceValues, withKeyMultiValues, withKeyValue

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

comparator

private Comparator<? super V> comparator

Constructor Details

TreeSortedSetMultimap

public TreeSortedSetMultimap()

TreeSortedSetMultimap

public TreeSortedSetMultimap(Comparator<? super V> comparator)

TreeSortedSetMultimap

public TreeSortedSetMultimap(Multimap<? extends K, ? extends V> multimap)

TreeSortedSetMultimap

public TreeSortedSetMultimap(Pair<K,V>... pairs)

TreeSortedSetMultimap

public TreeSortedSetMultimap(Iterable<Pair<K,V>> inputIterable)

Method Details

newMultimap

public static <K,V> TreeSortedSetMultimap<K,V> newMultimap()

newMultimap

public static <K,V> TreeSortedSetMultimap<K,V> newMultimap(Multimap<? extends K, ? extends V> multimap)

newMultimap

public static <K,V> TreeSortedSetMultimap<K,V> newMultimap(Comparator<? super V> comparator)

newMultimap

public static <K,V> TreeSortedSetMultimap<K,V> newMultimap(Pair<K,V>... pairs)

newMultimap

public static <K,V> TreeSortedSetMultimap<K,V> newMultimap(Iterable<Pair<K,V>> inputIterable)

createMap

protected MutableMap<K, MutableSortedSet<V>> createMap()

Specified by:

createMap in class AbstractMutableMultimap<K, V, MutableSortedSet<V>>

createMapWithKeyCount

protected MutableMap<K, MutableSortedSet<V>> createMapWithKeyCount(int keyCount)

Specified by:

createMapWithKeyCount in class AbstractMutableMultimap<K, V, MutableSortedSet<V>>

createCollection

protected MutableSortedSet<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, MutableSortedSet<V>>

Returns:

an empty collection of values

newEmpty

public TreeSortedSetMultimap<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 Multimap<K,V>

Specified by:

newEmpty in interface MutableMultimap<K,V>

Specified by:

newEmpty in interface MutableSetIterableMultimap<K,V>

Specified by:

newEmpty in interface MutableSortedSetMultimap<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>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class AbstractMutableMultimap<K, V, MutableSortedSet<V>>

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class AbstractMutableMultimap<K, V, MutableSortedSet<V>>

Throws:

IOException

ClassNotFoundException

flip

public MutableSetMultimap<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 Multimap<K,V>

Specified by:

flip in interface MutableMultimap<K,V>

Specified by:

flip in interface MutableSetIterableMultimap<K,V>

Specified by:

flip in interface MutableSortedSetMultimap<K,V>

Specified by:

flip in interface SetMultimap<K,V>

selectKeysValues

public TreeSortedSetMultimap<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 Multimap<K,V>

Specified by:

selectKeysValues in interface MutableMultimap<K,V>

Specified by:

selectKeysValues in interface MutableSetIterableMultimap<K,V>

Specified by:

selectKeysValues in interface MutableSortedSetMultimap<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 TreeSortedSetMultimap<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 Multimap<K,V>

Specified by:

rejectKeysValues in interface MutableMultimap<K,V>

Specified by:

rejectKeysValues in interface MutableSetIterableMultimap<K,V>

Specified by:

rejectKeysValues in interface MutableSortedSetMultimap<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 TreeSortedSetMultimap<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 Multimap<K,V>

Specified by:

selectKeysMultiValues in interface MutableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface MutableSetIterableMultimap<K,V>

Specified by:

selectKeysMultiValues in interface MutableSortedSetMultimap<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 TreeSortedSetMultimap<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 Multimap<K,V>

Specified by:

rejectKeysMultiValues in interface MutableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface MutableSetIterableMultimap<K,V>

Specified by:

rejectKeysMultiValues in interface MutableSortedSetMultimap<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> HashBagMultimap<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 Multimap<K,V>

Specified by:

collectKeysValues in interface MutableMultimap<K,V>

Specified by:

collectKeysValues in interface MutableSetIterableMultimap<K,V>

Specified by:

collectKeysValues in interface MutableSortedSetMultimap<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> HashBagMultimap<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 Multimap<K,V>

Specified by:

collectKeyMultiValues in interface MutableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface MutableSetIterableMultimap<K,V>

Specified by:

collectKeyMultiValues in interface MutableSortedSetMultimap<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> FastListMultimap<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 Multimap<K,V>

Specified by:

collectValues in interface MutableMultimap<K,V>

Specified by:

collectValues in interface MutableSetIterableMultimap<K,V>

Specified by:

collectValues in interface MutableSortedSetMultimap<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

asSynchronized

public MutableSortedSetMultimap<K,V> asSynchronized()

Description copied from interface: MutableMultimap

Returns a synchronized wrapper backed by this multimap. The preferred way of iterating over a synchronized multimap is to use the forEachKey(), forEachValue(), forEachKeyValue() and forEachKeyMultiValues methods which are properly synchronized internally.

 MutableMultimap synchedMultimap = multimap.asSynchronized();

 synchedMultimap.forEachKey(key -> ... );
 synchedMultimap.forEachValue(value -> ... );
 synchedMultimap.forEachKeyValue((key, value) -> ... );
 synchedMultimap.forEachKeyMultiValues((key, values) -> ... );

If you want to iterate imperatively over the keySet(), keysView(), valuesView(), or other views, you will need to protect the iteration by wrapping the code in a synchronized block on the multimap.

Specified by:

asSynchronized in interface MutableMultimap<K,V>

Specified by:

asSynchronized in interface MutableSetIterableMultimap<K,V>

Specified by:

asSynchronized in interface MutableSortedSetMultimap<K,V>

Returns:

a synchronized view of this multimap.

See Also:

• MutableMapIterable.asSynchronized()