Class ImmutableTreeMap<K,V>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<V>

org.eclipse.collections.impl.map.AbstractMapIterable<K,V>

org.eclipse.collections.impl.map.sorted.immutable.AbstractImmutableSortedMap<K,V>

org.eclipse.collections.impl.map.sorted.immutable.ImmutableTreeMap<K,V>

All Implemented Interfaces:

Serializable, Iterable<V>, Map<K,V>, SequencedMap<K,V>, SortedMap<K,V>, InternalIterable<V>, ImmutableMapIterable<K,V>, MapIterable<K,V>, ImmutableSortedMap<K,V>, SortedMapIterable<K,V>, OrderedIterable<V>, ReversibleIterable<V>, RichIterable<V>

public class ImmutableTreeMap<K,V>
extends AbstractImmutableSortedMap<K,V>
implements Serializable

See Also:

• ImmutableSortedMap
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ImmutableTreeMap.EntryComparator<K,V>
protected class	ImmutableTreeMap.ImmutableSortedMapKeySet

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private final Comparator<? super K>	comparator
private final K[]	keys
private final V[]	values

Constructor Summary

Constructors

Constructor	Description
ImmutableTreeMap(SortedMap<K,V> sortedMap)

Method Summary

Modifier and Type	Method	Description
Comparator<? super K>	comparator()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
ImmutableSortedMap<K,V>	drop(int count)	Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object object)	Follows the same general contract as Map.equals(Object).
K	firstKey()
ImmutableMap<V,K>	flipUniqueValues()	Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKeyValue(Procedure2<? super K, ? super V> procedure)	Calls the procedure with each key-value pair of the map.
V	get(Object key)
int	hashCode()	Follows the same general contract as Map.hashCode().
Set<K>	keySet()
RichIterable<K>	keysView()	Returns an unmodifiable lazy iterable wrapped around the keySet for the map.
RichIterable<Pair<K,V>>	keyValuesView()	Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.
K	lastKey()
static <K,V> ImmutableSortedMap<K,V>	newMap(SortedMap<K,V> sortedMap)
int	size()	Returns the number of items in this iterable.
ImmutableSortedMap<K,V>	take(int count)	Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
String	toString()	Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.
Collection<V>	values()
RichIterable<V>	valuesView()	Returns an unmodifiable lazy iterable wrapped around the values for the map.
protected Object	writeReplace()

Methods inherited from class AbstractImmutableSortedMap

aggregateBy, castToMap, castToSortedMap, clear, collect, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectKeysUnique, collectLong, collectShort, collectValues, collectWith, corresponds, countBy, countByEach, countByWith, detect, detectIndex, detectLastIndex, detectOptional, distinct, dropWhile, flatCollect, flip, forEach, forEach, forEachWithIndex, groupBy, groupByEach, groupByUniqueKey, headMap, iterator, newWithAllKeyValueArguments, newWithAllKeyValues, newWithKeyValue, newWithMap, newWithMapIterable, newWithoutAllKeys, newWithoutKey, partition, partitionWhile, partitionWith, put, putAll, reject, reject, rejectWith, remove, select, select, selectInstancesOf, selectWith, subMap, sumByDouble, sumByFloat, sumByInt, sumByLong, tailMap, takeWhile, tap, toImmutable, toReversed, toSortedMap, toStack, zip, zipWithIndex

Methods inherited from class AbstractMapIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getOnly, getOrDefault, ifPresentApply, isAbsent, keyAndValueEquals, keyAndValueHashCode, noneSatisfy, noneSatisfyWith, toArray, toArray

Methods inherited from class AbstractRichIterable

appendString, appendString, collect, collectIf, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, max, max, maxBy, min, min, minBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from class Object

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

Methods inherited from interface ImmutableSortedMap

aggregateBy, aggregateInPlaceBy, collectWithIndex, flatCollectWith, reduceBy

Methods inherited from interface InternalIterable

forEach, forEachWith

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, getOrDefault, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface MapIterable

forEachKey, forEachValue, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getOrDefault, ifPresentApply, injectIntoKeyValue, parallelStream, spliterator, stream

Methods inherited from interface OrderedIterable

collectWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, indexOf, max, min, rejectWithIndex, selectWithIndex, zip, zipWithIndex

Methods inherited from interface ReversibleIterable

asReversed, reverseForEach, reverseForEachWithIndex

Methods inherited from interface RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy

Methods inherited from interface SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface SortedMap

putFirst, putLast, reversed

Field Details

keys

private final K[] keys

values

private final V[] values

comparator

private final Comparator<? super K> comparator

Constructor Details

ImmutableTreeMap

public ImmutableTreeMap(SortedMap<K,V> sortedMap)

Method Details

newMap

public static <K,V> ImmutableSortedMap<K,V> newMap(SortedMap<K,V> sortedMap)

equals

public boolean equals(Object object)

Description copied from interface: MapIterable

Follows the same general contract as Map.equals(Object).

Specified by:

equals in interface Map<K,V>

Specified by:

equals in interface MapIterable<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: MapIterable

Follows the same general contract as Map.hashCode().

Specified by:

hashCode in interface Map<K,V>

Specified by:

hashCode in interface MapIterable<K,V>

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from class: AbstractRichIterable

Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.

Assert.assertEquals("[]", Lists.mutable.empty().toString());
Assert.assertEquals("[1]", Lists.mutable.with(1).toString());
Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString());

Specified by:

toString in interface MapIterable<K,V>

Specified by:

toString in interface RichIterable<K>

Overrides:

toString in class AbstractRichIterable<V>

Returns:

a string representation of this collection.

See Also:

• AbstractCollection.toString()

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface Map<K,V>

Specified by:

size in interface RichIterable<K>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Specified by:

containsKey in interface MapIterable<K,V>

See Also:

• Map.containsKey(Object)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Specified by:

containsValue in interface MapIterable<K,V>

See Also:

• Map.containsValue(Object)

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Specified by:

get in interface MapIterable<K,V>

See Also:

• Map.get(Object)

forEachKeyValue

public void forEachKeyValue(Procedure2<? super K, ? super V> procedure)

Description copied from interface: MapIterable

Calls the procedure with each key-value pair of the map.

    final Collection<String> collection = new ArrayList<String>();
    MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three");
    map.forEachKeyValue((Integer key, String value) -> collection.add(String.valueOf(key) + value));
    Verify.assertContainsAll(collection, "1One", "2Two", "3Three");

Specified by:

forEachKeyValue in interface MapIterable<K,V>

flipUniqueValues

public ImmutableMap<V,K> flipUniqueValues()

Description copied from interface: MapIterable

Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.

    MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
    MapIterable<String, Integer> result = map.flipUniqueValues();
    Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));

Specified by:

flipUniqueValues in interface ImmutableMapIterable<K,V>

Specified by:

flipUniqueValues in interface MapIterable<K,V>

keysView

public RichIterable<K> keysView()

Description copied from interface: MapIterable

Returns an unmodifiable lazy iterable wrapped around the keySet for the map.

Specified by:

keysView in interface MapIterable<K,V>

valuesView

public RichIterable<V> valuesView()

Description copied from interface: MapIterable

Returns an unmodifiable lazy iterable wrapped around the values for the map.

Specified by:

valuesView in interface MapIterable<K,V>

keyValuesView

public RichIterable<Pair<K,V>> keyValuesView()

Description copied from interface: MapIterable

Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.

Specified by:

keyValuesView in interface MapIterable<K,V>

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K,V>

Specified by:

comparator in interface SortedMapIterable<K,V>

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface SortedMap<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

Specified by:

values in interface SortedMap<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface SortedMap<K,V>

writeReplace

protected Object writeReplace()

take

public ImmutableSortedMap<K,V> take(int count)

Description copied from interface: ReversibleIterable

Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.

Specified by:

take in interface ReversibleIterable<K>

Specified by:

take in interface SortedMapIterable<K,V>

Parameters:

count - the number of items to take.

drop

public ImmutableSortedMap<K,V> drop(int count)

Description copied from interface: ReversibleIterable

Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.

Specified by:

drop in interface ReversibleIterable<K>

Specified by:

drop in interface SortedMapIterable<K,V>

Parameters:

count - the number of items to drop.