com.gs.collections.impl.multimap.bag.sorted

Class TreeBagMultimap<K,V>

java.lang.Object

com.gs.collections.impl.multimap.AbstractMultimap<K,V,C>

com.gs.collections.impl.multimap.AbstractMutableMultimap<K,V,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>

com.gs.collections.impl.multimap.bag.sorted.TreeBagMultimap<K,V>

All Implemented Interfaces:

com.gs.collections.api.multimap.bag.BagMultimap<K,V>, com.gs.collections.api.multimap.Multimap<K,V>, com.gs.collections.api.multimap.MutableMultimap<K,V>, com.gs.collections.api.multimap.ordered.SortedIterableMultimap<K,V>, com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<K,V>, com.gs.collections.api.multimap.sortedbag.SortedBagMultimap<K,V>, java.io.Externalizable, java.io.Serializable

public final class TreeBagMultimap<K,V>
extends AbstractMutableMultimap<K,V,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>
implements com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<K,V>, java.io.Externalizable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gs.collections.impl.multimap.AbstractMutableMultimap

map, totalSize

Constructor Summary

Constructors

Constructor and Description
TreeBagMultimap()
TreeBagMultimap(java.util.Comparator<? super V> comparator)
TreeBagMultimap(com.gs.collections.api.multimap.Multimap<? extends K,? extends V> multimap)
TreeBagMultimap(com.gs.collections.api.tuple.Pair<K,V>... pairs)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Comparator<? super V>	comparator()
protected com.gs.collections.api.bag.sorted.MutableSortedBag<V>	createCollection() Creates the collection of values for a single key.
protected com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>	createMap()
protected com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>	createMapWithKeyCount(int keyCount)
TreeBagMultimap<K,V>	newEmpty() Creates a new instance of the same implementation type, using the default capacity and growth parameters.
static <K,V> TreeBagMultimap<K,V>	newMultimap()
static <K,V> TreeBagMultimap<K,V>	newMultimap(java.util.Comparator<? super V> comparator)
static <K,V> TreeBagMultimap<K,V>	newMultimap(com.gs.collections.api.multimap.Multimap<? extends K,? extends V> multimap)
static <K,V> TreeBagMultimap<K,V>	newMultimap(com.gs.collections.api.tuple.Pair<K,V>... pairs)
void	readExternal(java.io.ObjectInput in)
com.gs.collections.api.multimap.sortedbag.ImmutableSortedBagMultimap<K,V>	toImmutable() Returns an immutable copy of this Multimap if it is not already immutable.
com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<K,V>	toMutable() Returns a mutable copy of this Multimap.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class com.gs.collections.impl.multimap.AbstractMutableMultimap

addToTotalSize, clear, clearTotalSize, decrementTotalSize, get, getMap, incrementTotalSize, isEmpty, put, putAll, putAll, putAllPairs, remove, removeAll, replaceValues, size, sizeDistinct, subtractFromTotalSize, toMap

Methods inherited from class com.gs.collections.impl.multimap.AbstractMultimap

containsKey, containsKeyAndValue, containsValue, createCollectionBlock, equals, forEachKey, forEachKeyValue, forEachValue, hashCode, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, toMap, toString, valuesView

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap

get, removeAll, replaceValues

Methods inherited from interface com.gs.collections.api.multimap.MutableMultimap

clear, put, putAll, putAll, putAllPairs, remove

Methods inherited from interface com.gs.collections.api.multimap.Multimap

containsKey, containsKeyAndValue, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, hashCode, isEmpty, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, size, sizeDistinct, toMap, toMap, valuesView

Constructor Detail

TreeBagMultimap

public TreeBagMultimap()

TreeBagMultimap

public TreeBagMultimap(java.util.Comparator<? super V> comparator)

TreeBagMultimap

public TreeBagMultimap(com.gs.collections.api.multimap.Multimap<? extends K,? extends V> multimap)

TreeBagMultimap

public TreeBagMultimap(com.gs.collections.api.tuple.Pair<K,V>... pairs)

Method Detail

newMultimap

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

newMultimap

public static <K,V> TreeBagMultimap<K,V> newMultimap(com.gs.collections.api.multimap.Multimap<? extends K,? extends V> multimap)

newMultimap

public static <K,V> TreeBagMultimap<K,V> newMultimap(java.util.Comparator<? super V> comparator)

newMultimap

public static <K,V> TreeBagMultimap<K,V> newMultimap(com.gs.collections.api.tuple.Pair<K,V>... pairs)

createMap

protected com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.bag.sorted.MutableSortedBag<V>> createMap()

Specified by:

createMap in class AbstractMutableMultimap<K,V,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>

createMapWithKeyCount

protected com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.bag.sorted.MutableSortedBag<V>> createMapWithKeyCount(int keyCount)

Specified by:

createMapWithKeyCount in class AbstractMutableMultimap<K,V,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>

createCollection

protected com.gs.collections.api.bag.sorted.MutableSortedBag<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,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>

Returns:

an empty collection of values

newEmpty

public TreeBagMultimap<K,V> newEmpty()

Description copied from interface: com.gs.collections.api.multimap.Multimap

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

Specified by:

newEmpty in interface com.gs.collections.api.multimap.bag.BagMultimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.Multimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.MutableMultimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.ordered.SortedIterableMultimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.sortedbag.SortedBagMultimap<K,V>

comparator

public java.util.Comparator<? super V> comparator()

Specified by:

comparator in interface com.gs.collections.api.multimap.ordered.SortedIterableMultimap<K,V>

toMutable

public com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<K,V> toMutable()

Description copied from interface: com.gs.collections.api.multimap.Multimap

Returns a mutable copy of this Multimap.

Specified by:

toMutable in interface com.gs.collections.api.multimap.Multimap<K,V>

Specified by:

toMutable in interface com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<K,V>

Specified by:

toMutable in interface com.gs.collections.api.multimap.sortedbag.SortedBagMultimap<K,V>

toImmutable

public com.gs.collections.api.multimap.sortedbag.ImmutableSortedBagMultimap<K,V> toImmutable()

Description copied from interface: com.gs.collections.api.multimap.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 com.gs.collections.api.multimap.Multimap<K,V>

Specified by:

toImmutable in interface com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<K,V>

Specified by:

toImmutable in interface com.gs.collections.api.multimap.sortedbag.SortedBagMultimap<K,V>

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class AbstractMutableMultimap<K,V,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class AbstractMutableMultimap<K,V,com.gs.collections.api.bag.sorted.MutableSortedBag<V>>

Throws:

java.io.IOException

java.lang.ClassNotFoundException