com.gs.collections.impl.map.sorted.mutable

Class SortedMapAdapter<K,V>

java.lang.Object

com.gs.collections.impl.AbstractRichIterable<V>

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

com.gs.collections.impl.map.mutable.AbstractMutableMapIterable<K,V>

com.gs.collections.impl.map.sorted.mutable.AbstractMutableSortedMap<K,V>

com.gs.collections.impl.map.sorted.mutable.SortedMapAdapter<K,V>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<V>, com.gs.collections.api.map.MapIterable<K,V>, com.gs.collections.api.map.MutableMapIterable<K,V>, com.gs.collections.api.map.sorted.MutableSortedMap<K,V>, com.gs.collections.api.map.sorted.SortedMapIterable<K,V>, com.gs.collections.api.ordered.OrderedIterable<V>, com.gs.collections.api.ordered.ReversibleIterable<V>, com.gs.collections.api.RichIterable<V>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<V>, java.util.Map<K,V>, java.util.SortedMap<K,V>

public class SortedMapAdapter<K,V>
extends AbstractMutableSortedMap<K,V>
implements java.io.Serializable

This class provides a MutableSortedMap wrapper around a JDK Collections SortedMap interface instance. All of the MutableSortedMap interface methods are supported in addition to the JDK SortedMap interface methods.

To create a new wrapper around an existing SortedMap instance, use the adapt(SortedMap) factory method.

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

Modifier	Constructor and Description
protected	SortedMapAdapter(java.util.SortedMap<K,V> newDelegate)

Method Summary

Methods

Modifier and Type	Method and Description
static <K,V> com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	adapt(java.util.SortedMap<K,V> map)
void	clear()
com.gs.collections.api.map.sorted.MutableSortedMap<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.list.MutableList<V>	distinct() Returns a new OrderedIterable containing the distinct elements in this iterable.
com.gs.collections.api.map.sorted.MutableSortedMap<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.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	dropWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns the final elements that do not satisfy the Predicate.
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> 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().
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	headMap(K toKey)
boolean	isEmpty() Returns true if this iterable has zero items.
java.util.Iterator<V>	iterator()
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() Deprecated. use TreeSortedMap.newEmpty() instead (inlineable)
com.gs.collections.api.partition.list.PartitionMutableList<V>	partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> map)
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)
com.gs.collections.api.map.sorted.MutableSortedMap<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.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	takeWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns the initial elements that satisfy the Predicate.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	toReversed() Returns a new ReversibleIterable in reverse order.
java.lang.String	toString() Returns a string representation of this collection.
com.gs.collections.api.collection.MutableCollection<V>	values()
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	with(com.gs.collections.api.tuple.Pair<K,V>... pairs)

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

asReversed, asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectKeysAndValues, collectLong, collectShort, collectValues, collectWith, corresponds, detectIndex, detectLastIndex, flatCollect, flip, forEach, forEachWithIndex, groupBy, groupByEach, indexOf, partition, partitionWith, reject, reject, rejectWith, reverseForEach, select, select, selectInstancesOf, selectWith, tap, toImmutable, toStack, withAllKeyValueArguments, withAllKeyValues, withKeyValue, withoutAllKeys, withoutKey, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.map.mutable.AbstractMutableMapIterable

add, aggregateBy, aggregateInPlaceBy, collect, detect, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, groupByUniqueKey, keysView, keyValuesView, updateValue, updateValueWith, valuesView

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

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

Methods inherited from class com.gs.collections.impl.AbstractRichIterable

appendString, appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, 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.sorted.MutableSortedMap

aggregateBy, aggregateInPlaceBy, collect, getIfAbsentPutWith, groupByUniqueKey

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

add, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWithKey, updateValue, updateValueWith

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

detect, forEachKey, forEachValue, getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply, keysView, keyValuesView, valuesView

Methods inherited from interface com.gs.collections.api.ordered.OrderedIterable

forEachWithIndex, getFirst, getLast, max, min, zip, zipWithIndex

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, each, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, maxBy, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy

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

forEach, forEachWith

Constructor Detail

SortedMapAdapter

protected SortedMapAdapter(java.util.SortedMap<K,V> newDelegate)

Method Detail

adapt

public static <K,V> com.gs.collections.api.map.sorted.MutableSortedMap<K,V> adapt(java.util.SortedMap<K,V> map)

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

Specified by:

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

newEmpty

@Deprecated
public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> newEmpty()

Deprecated. use TreeSortedMap.newEmpty() instead (inlineable)

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.MutableMapIterable<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.map.sorted.MutableSortedMap<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)

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)

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>

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>

isEmpty

public boolean isEmpty()

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

Returns true if this iterable has zero items.

Specified by:

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

Specified by:

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

Overrides:

isEmpty in class AbstractRichIterable<V>

iterator

public java.util.Iterator<V> iterator()

Specified by:

iterator in interface java.lang.Iterable<V>

Overrides:

iterator in class AbstractMutableMapIterable<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>

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>

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>

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>

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>

clear

public void clear()

Specified by:

clear in interface java.util.Map<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>

removeKey

public V removeKey(K key)

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

Remove an entry from the map at the specified key.

Specified by:

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

Returns:

The value removed from entry at key, or null if not found.

See Also:

Map.remove(Object)

with

public com.gs.collections.api.map.sorted.MutableSortedMap<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>

Overrides:

with in class AbstractMutableSortedMap<K,V>

toString

public java.lang.String toString()

Description copied from class: AbstractRichIterable

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).

This implementation creates an empty string buffer, appends a left square bracket, and iterates over the collection appending the string representation of each element in turn. After appending each element except the last, the string ", " is appended. Finally a right bracket is appended. A string is obtained from the string buffer, and returned.

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 AbstractRichIterable<V>

Returns:

a string representation of this collection.

clone

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

Specified by:

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

Specified by:

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

toReversed

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

Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable

Returns a new ReversibleIterable in reverse order.

Specified by:

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

Specified by:

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

Specified by:

toReversed in interface com.gs.collections.api.ordered.ReversibleIterable<V>

take

public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> take(int count)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Specified by:

take in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Parameters:

count - the number of items to take.

takeWhile

public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> takeWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable

Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.

Specified by:

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

Specified by:

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

Specified by:

takeWhile in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

takeWhile in interface com.gs.collections.api.ordered.ReversibleIterable<V>

drop

public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> drop(int count)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Specified by:

drop in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Parameters:

count - the number of items to drop.

dropWhile

public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> dropWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable

Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.

Specified by:

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

Specified by:

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

Specified by:

dropWhile in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

dropWhile in interface com.gs.collections.api.ordered.ReversibleIterable<V>

partitionWhile

public com.gs.collections.api.partition.list.PartitionMutableList<V> partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.ordered.OrderedIterable

Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.

Specified by:

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

Specified by:

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

Specified by:

partitionWhile in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

partitionWhile in interface com.gs.collections.api.ordered.ReversibleIterable<V>

distinct

public com.gs.collections.api.list.MutableList<V> distinct()

Description copied from interface: com.gs.collections.api.ordered.OrderedIterable

Returns a new OrderedIterable containing the distinct elements in this iterable.

Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears multiple times in this iterable, the first one will be copied into the result.

Specified by:

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

Specified by:

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

Specified by:

distinct in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

distinct in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Returns:

OrderedIterable of distinct elements