TreeSortedMap (Goldman Sachs Collections

java.lang.Object
- com.gs.collections.impl.map.AbstractMapIterable<K,V>
- - com.gs.collections.impl.map.sorted.mutable.AbstractMutableSortedMap<K,V>
  - - com.gs.collections.impl.map.sorted.mutable.TreeSortedMap<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.MutableSortedMap<K,V>, com.gs.collections.api.map.sorted.SortedMapIterable<K,V>, com.gs.collections.api.RichIterable<V>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<V>, java.util.Map<K,V>, java.util.SortedMap<K,V>
```
public final class TreeSortedMap<K,V>
extends AbstractMutableSortedMap<K,V>
implements java.io.Externalizable
```
See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description
`TreeSortedMap()`
`TreeSortedMap(java.util.Comparator<? super K> comparator)`
`TreeSortedMap(java.util.Comparator<? super K> comparator, java.util.Map<? extends K,? extends V> map)`
`TreeSortedMap(java.util.Map<? extends K,? extends V> map)`
`TreeSortedMap(com.gs.collections.api.tuple.Pair<K,V>... pairs)`
`TreeSortedMap(java.util.SortedMap<K,? extends V> map)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`TreeSortedMap<K,V>`	`clone()`
`java.util.Comparator<? super K>`	`comparator()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`com.gs.collections.api.set.MutableSet<java.util.Map.Entry<K,V>>`	`entrySet()`
`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> procedure2)` 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()`.
`com.gs.collections.api.map.sorted.MutableSortedMap<K,V>`	`headMap(K toKey)`
`com.gs.collections.api.set.MutableSet<K>`	`keySet()` The underlying set for the keys is sorted in ascending order according to their natural ordering or a custom comparator.
`K`	`lastKey()`
`com.gs.collections.api.map.sorted.MutableSortedMap<K,V>`	`newEmpty()` Creates a new instance of the same type with the same internal Comparator.
`static <K,V> TreeSortedMap<K,V>`	`newMap()`
`static <K,V> TreeSortedMap<K,V>`	`newMap(java.util.Comparator<? super K> comparator)`
`static <K,V> TreeSortedMap<K,V>`	`newMap(java.util.Comparator<? super K> comparator, java.util.Map<? extends K,? extends V> map)`
`static <K,V> TreeSortedMap<K,V>`	`newMap(java.util.Map<? extends K,? extends V> map)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(java.util.Comparator<? super K> comparator, K key, V value)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(java.util.Comparator<? super K> comparator, K key1, V value1, K key2, V value2)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(java.util.Comparator<? super K> comparator, K key1, V value1, K key2, V value2, K key3, V value3)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(java.util.Comparator<? super K> comparator, K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(java.util.Comparator<? super K> comparator, com.gs.collections.api.tuple.Pair<K,V>... pairs)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(K key, V value)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(K key1, V value1, K key2, V value2)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(K key1, V value1, K key2, V value2, K key3, V value3)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)`
`static <K,V> TreeSortedMap<K,V>`	`newMapWith(com.gs.collections.api.tuple.Pair<K,V>... pairs)`
`V`	`put(K key, V value)`
`void`	`putAll(java.util.Map<? extends K,? extends V> map)`
`void`	`readExternal(java.io.ObjectInput in)`
`V`	`remove(java.lang.Object key)`
`V`	`removeKey(K key)` Remove an entry from the map at the specified `key`.
`int`	`size()` Returns the number of items in this iterable.
`com.gs.collections.api.map.sorted.MutableSortedMap<K,V>`	`subMap(K fromKey, K toKey)`
`com.gs.collections.api.map.sorted.MutableSortedMap<K,V>`	`tailMap(K fromKey)`
`java.lang.String`	`toString()` Returns a string representation of this MapIterable.
`com.gs.collections.api.collection.MutableCollection<V>`	`values()`
`TreeSortedMap<K,V>`	`with(K key, V value)`
`TreeSortedMap<K,V>`	`with(K key1, V value1, K key2, V value2)`
`TreeSortedMap<K,V>`	`with(K key1, V value1, K key2, V value2, K key3, V value3)`
`TreeSortedMap<K,V>`	`with(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)`
`TreeSortedMap<K,V>`	`with(com.gs.collections.api.tuple.Pair<K,V>... pairs)`
`void`	`writeExternal(java.io.ObjectOutput out)`

Methods inherited from class com.gs.collections.impl.map.sorted.mutable.AbstractMutableSortedMap
aggregateBy, aggregateInPlaceBy, asSynchronized, asUnmodifiable, collect, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectKeysAndValues, collectLong, collectShort, collectValues, collectWith, detect, flatCollect, flip, flipUniqueValues, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, groupBy, groupByEach, groupByUniqueKey, iterator, keysView, keyValuesView, partition, partitionWith, reject, reject, rejectWith, select, select, selectInstancesOf, selectWith, toImmutable, valuesView, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.map.AbstractMapIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, 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, noneSatisfyWith, 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
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, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, 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

TreeSortedMap
```
public TreeSortedMap()
```

TreeSortedMap

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

TreeSortedMap

public TreeSortedMap(java.util.Map<? extends K,? extends V> map)

TreeSortedMap

public TreeSortedMap(java.util.Comparator<? super K> comparator,
             java.util.Map<? extends K,? extends V> map)

TreeSortedMap

public TreeSortedMap(java.util.SortedMap<K,? extends V> map)

TreeSortedMap

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

Method Detail

newMap

public static <K,V> TreeSortedMap<K,V> newMap()

newMap

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

newMap

public static <K,V> TreeSortedMap<K,V> newMap(java.util.Map<? extends K,? extends V> map)

newMap

public static <K,V> TreeSortedMap<K,V> newMap(java.util.Comparator<? super K> comparator,
                              java.util.Map<? extends K,? extends V> map)

newMapWith

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

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(java.util.Comparator<? super K> comparator,
                                  com.gs.collections.api.tuple.Pair<K,V>... pairs)

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(K key,
                                  V value)

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(K key1,
                                  V value1,
                                  K key2,
                                  V value2)

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(K key1,
                                  V value1,
                                  K key2,
                                  V value2,
                                  K key3,
                                  V value3)

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(K key1,
                                  V value1,
                                  K key2,
                                  V value2,
                                  K key3,
                                  V value3,
                                  K key4,
                                  V value4)

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(java.util.Comparator<? super K> comparator,
                                  K key,
                                  V value)

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(java.util.Comparator<? super K> comparator,
                                  K key1,
                                  V value1,
                                  K key2,
                                  V value2)

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(java.util.Comparator<? super K> comparator,
                                  K key1,
                                  V value1,
                                  K key2,
                                  V value2,
                                  K key3,
                                  V value3)

newMapWith

public static <K,V> TreeSortedMap<K,V> newMapWith(java.util.Comparator<? super K> comparator,
                                  K key1,
                                  V value1,
                                  K key2,
                                  V value2,
                                  K key3,
                                  V value3,
                                  K key4,
                                  V value4)

with

public TreeSortedMap<K,V> with(K key,
                      V value)

with

public TreeSortedMap<K,V> with(K key1,
                      V value1,
                      K key2,
                      V value2)

with

public TreeSortedMap<K,V> with(K key1,
                      V value1,
                      K key2,
                      V value2,
                      K key3,
                      V value3)

with

public TreeSortedMap<K,V> with(K key1,
                      V value1,
                      K key2,
                      V value2,
                      K key3,
                      V value3,
                      K key4,
                      V value4)

with
```
public TreeSortedMap<K,V> with(com.gs.collections.api.tuple.Pair<K,V>... pairs)
```
Specified by:

with in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

size
```
public int size()
```
Description copied from interface: com.gs.collections.api.RichIterable

Returns the number of items in this iterable.

Specified by:

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

Specified by:

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

newEmpty
```
public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> newEmpty()
```
Description copied from interface: com.gs.collections.api.map.sorted.MutableSortedMap

Creates a new instance of the same type with the same internal Comparator.

Specified by:

newEmpty in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

removeKey
```
public V removeKey(K key)
```
Description copied from interface: com.gs.collections.api.map.sorted.MutableSortedMap

Remove an entry from the map at the specified key.

Specified by:

removeKey in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Returns:
The value removed from entry at key, or null if not found.
See Also:
Map.remove(Object)

clone
```
public TreeSortedMap<K,V> clone()
```
Specified by:

clone in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Overrides:

clone in class AbstractMutableSortedMap<K,V>

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

forEachKeyValue

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

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");

Specified by:: forEachKeyValue in interface com.gs.collections.api.map.MapIterable<K,V>

firstKey
```
public K firstKey()
```
Specified by:

firstKey in interface java.util.SortedMap<K,V>

lastKey
```
public K lastKey()
```
Specified by:

lastKey in interface java.util.SortedMap<K,V>

entrySet
```
public com.gs.collections.api.set.MutableSet<java.util.Map.Entry<K,V>> entrySet()
```
Specified by:

entrySet in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Specified by:

entrySet in interface java.util.SortedMap<K,V>

keySet
```
public com.gs.collections.api.set.MutableSet<K> keySet()
```
Description copied from interface: com.gs.collections.api.map.sorted.MutableSortedMap

The underlying set for the keys is sorted in ascending order according to their natural ordering or a custom comparator. However, Java 5 TreeMap returns a keySet that does not inherit from SortedSet therefore we have decided to return the keySet simply as a MutableSet to maintain Java 5 compatibility.

Specified by:

keySet in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Specified by:

keySet in interface java.util.SortedMap<K,V>

values
```
public com.gs.collections.api.collection.MutableCollection<V> values()
```
Specified by:

values in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Specified by:

values in interface java.util.SortedMap<K,V>

comparator
```
public java.util.Comparator<? super K> comparator()
```
Specified by:

comparator in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

comparator in interface java.util.SortedMap<K,V>

get
```
public V get(java.lang.Object key)
```
Specified by:

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

Specified by:

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

See Also:
Map.get(Object)

put
```
public V put(K key,
    V value)
```
Specified by:

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

remove
```
public V remove(java.lang.Object key)
```
Specified by:

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

putAll

public void putAll(java.util.Map<? extends K,? extends V> map)

Specified by:: putAll in interface java.util.Map<K,V>

clear
```
public void clear()
```
Specified by:

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

containsKey
```
public boolean containsKey(java.lang.Object key)
```
Specified by:

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

Specified by:

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

See Also:
Map.containsKey(Object)

headMap
```
public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> headMap(K toKey)
```
Specified by:

headMap in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

headMap in interface java.util.SortedMap<K,V>

tailMap
```
public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> tailMap(K fromKey)
```
Specified by:

tailMap in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

tailMap in interface java.util.SortedMap<K,V>

subMap

public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> subMap(K fromKey,
                                                             K toKey)

Specified by:: subMap in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>
Specified by:: subMap in interface java.util.SortedMap<K,V>

containsValue
```
public boolean containsValue(java.lang.Object value)
```
Specified by:

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

Specified by:

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

See Also:
Map.containsValue(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

writeExternal

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

Specified by:: writeExternal in interface java.io.Externalizable
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
Throws:: java.io.IOException; java.lang.ClassNotFoundException

Class TreeSortedMap<K,V>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.gs.collections.impl.map.sorted.mutable.AbstractMutableSortedMap

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

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.util.Map

Constructor Detail

TreeSortedMap

TreeSortedMap

TreeSortedMap

TreeSortedMap

TreeSortedMap

TreeSortedMap

Method Detail

newMap

newMap

newMap

newMap

newMapWith

newMapWith

newMapWith

newMapWith

newMapWith

newMapWith

newMapWith

newMapWith

newMapWith

newMapWith

with

with

with

with

with

size

newEmpty

removeKey

clone

equals

hashCode

forEachKeyValue

firstKey

lastKey

entrySet

keySet

values

comparator

get

put

remove

putAll

clear

containsKey

headMap

tailMap

subMap

containsValue

toString

writeExternal

readExternal