com.gs.collections.impl.map.sorted.immutable

Class ImmutableTreeMap<K,V>

java.lang.Object

com.gs.collections.impl.map.AbstractMapIterable<K,V>

com.gs.collections.impl.map.sorted.immutable.AbstractImmutableSortedMap<K,V>

com.gs.collections.impl.map.sorted.immutable.ImmutableTreeMap<K,V>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<V>, com.gs.collections.api.map.MapIterable<K,V>, com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>, com.gs.collections.api.map.sorted.SortedMapIterable<K,V>, com.gs.collections.api.RichIterable<V>, java.lang.Iterable<V>, java.util.Map<K,V>, java.util.SortedMap<K,V>

@Immutable
public class ImmutableTreeMap<K,V>
extends AbstractImmutableSortedMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ImmutableTreeMap(java.util.SortedMap<K,V> sortedMap)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Comparator<? super K>	comparator()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
boolean	equals(java.lang.Object o) Follows the same general contract as Map.equals(Object).
K	firstKey()
void	forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure) Calls the procedure with each key-value pair of the map.
V	get(java.lang.Object key)
int	hashCode() Follows the same general contract as Map.hashCode().
java.util.Set<K>	keySet()
com.gs.collections.api.RichIterable<K>	keysView() Returns an unmodifiable lazy iterable wrapped around the keySet for the map
com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.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> com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	newMap(java.util.SortedMap<K,V> sortedMap)
int	size() Returns the number of items in this iterable.
java.lang.String	toString() Returns a string representation of this MapIterable.
java.util.Collection<V>	values()
com.gs.collections.api.RichIterable<V>	valuesView() Returns an unmodifiable lazy iterable wrapped around the values for the map

Methods inherited from class com.gs.collections.impl.map.sorted.immutable.AbstractImmutableSortedMap

aggregateBy, aggregateInPlaceBy, castToSortedMap, clear, collect, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectValues, detect, entrySet, flatCollect, groupBy, groupByEach, headMap, iterator, newWithAllKeyValueArguments, newWithAllKeyValues, newWithKeyValue, newWithoutAllKeys, newWithoutKey, partition, put, putAll, reject, reject, remove, select, select, selectInstancesOf, subMap, tailMap, toSortedMap, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.map.AbstractMapIterable

allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, chunk, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, detect, detectIfNone, flatCollect, forEach, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, groupBy, groupByEach, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, isAbsent, isEmpty, keyAndValueEquals, keyAndValueHashCode, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gs.collections.api.map.MapIterable

forEachKey, forEachValue, getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply

Methods inherited from interface com.gs.collections.api.RichIterable

allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, chunk, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, detect, detectIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.util.Map

isEmpty

Constructor Detail

ImmutableTreeMap

public ImmutableTreeMap(java.util.SortedMap<K,V> sortedMap)

Method Detail

newMap

public static <K,V> com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> newMap(java.util.SortedMap<K,V> sortedMap)

equals

public boolean equals(java.lang.Object o)

Description copied from interface: com.gs.collections.api.map.MapIterable

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

Specified by:

equals in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: com.gs.collections.api.map.MapIterable

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

Specified by:

hashCode in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from interface: com.gs.collections.api.map.MapIterable

Returns a string representation of this MapIterable. The string representation consists of a list of the map's key-value pairs in the order they are returned by its iterator. The key and value in each key-value pair are separated by a colon (":") and each pair is enclosed in square brackets ("[]"). Adjacent key-value pairs are separated by the characters ", " (comma and space). Keys and values are converted to strings as by String.valueOf(Object).

Specified by:

toString in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

toString in interface com.gs.collections.api.RichIterable<V>

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this MapIterable

size

public int size()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the number of items in this iterable.

containsKey

public boolean containsKey(java.lang.Object key)

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object value)

See Also:

Map.containsValue(Object)

get

public V get(java.lang.Object key)

See Also:

Map.get(Object)

forEachKeyValue

public void forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure)

Description copied from interface: com.gs.collections.api.map.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(new Procedure2<Integer, String>()
     {
         public void value(final Integer key, final String value)
         {
             collection.add(String.valueOf(key) + value);
         }
     });
     Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
 

keysView

public com.gs.collections.api.RichIterable<K> keysView()

Description copied from interface: com.gs.collections.api.map.MapIterable

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

valuesView

public com.gs.collections.api.RichIterable<V> valuesView()

Description copied from interface: com.gs.collections.api.map.MapIterable

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

keyValuesView

public com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>> keyValuesView()

Description copied from interface: com.gs.collections.api.map.MapIterable

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

comparator

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

firstKey

public K firstKey()

lastKey

public K lastKey()

keySet

public java.util.Set<K> keySet()

values

public java.util.Collection<V> values()