org.eclipse.collections.impl.map.sorted.mutable.SortedMapAdapter<K,V>

All Implemented Interfaces:: Serializable, Cloneable, Iterable<V>, Map<K,V>, SortedMap<K,V>, InternalIterable<V>, MapIterable<K,V>, MutableMapIterable<K,V>, MutableSortedMap<K,V>, SortedMapIterable<K,V>, OrderedIterable<V>, ReversibleIterable<V>, RichIterable<V>

public class SortedMapAdapter<K,V>
extends AbstractMutableSortedMap<K,V>
implements 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
Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
`static <K, V> MutableSortedMap<K,V>`	`adapt(SortedMap<K,V> map)`
`void`	`clear()`
`MutableSortedMap<K,V>`	`clone()`
`Comparator<? super K>`	`comparator()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`MutableList<V>`	`distinct()`	Returns a new `OrderedIterable` containing the distinct elements in this iterable.
`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.
`MutableSortedMap<K,V>`	`dropWhile(Predicate<? super V> predicate)`	Returns the final elements that do not satisfy the Predicate.
`MutableSet<Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(Object o)`	Follows the same general contract as `Map.equals(Object)`.
`K`	`firstKey()`
`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()`.
`MutableSortedMap<K,V>`	`headMap(K toKey)`
`boolean`	`isEmpty()`	Returns true if this iterable has zero items.
`Iterator<V>`	`iterator()`
`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()`
`MutableSortedMap<K,V>`	`newEmpty()`	Deprecated. use `TreeSortedMap.newEmpty()` instead (inlineable)
`PartitionMutableList<V>`	`partitionWhile(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(Map<? extends K,? extends V> map)`
`V`	`remove(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.
`MutableSortedMap<K,V>`	`subMap(K fromKey, K toKey)`
`MutableSortedMap<K,V>`	`tailMap(K fromKey)`
`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.
`MutableSortedMap<K,V>`	`takeWhile(Predicate<? super V> predicate)`	Returns the initial elements that satisfy the Predicate.
`MutableSortedMap<K,V>`	`toReversed()`	Returns a new ReversibleIterable in reverse order.
`String`	`toString()`	Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.
`MutableCollection<V>`	`values()`
`MutableSortedMap<K,V>`	`with(Pair<K,V>... pairs)`

Methods inherited from class org.eclipse.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, groupByUniqueKey, indexOf, partition, partitionWith, reject, reject, rejectWith, select, select, selectInstancesOf, selectWith, tap, toImmutable, toStack, withAllKeyValueArguments, withAllKeyValues, withKeyValue, withoutAllKeys, withoutKey, zip, zipWithIndex

Methods inherited from class org.eclipse.collections.impl.map.mutable.AbstractMutableMapIterable

aggregateBy, aggregateInPlaceBy, collect, countBy, countByEach, countByWith, detect, detectOptional, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, keysView, keyValuesView, sumByDouble, sumByFloat, sumByInt, sumByLong, updateValue, updateValueWith, valuesView

Methods inherited from class org.eclipse.collections.impl.map.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, noneSatisfy, noneSatisfyWith, toArray, toArray

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable

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, into, 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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach, forEachWith

Methods inherited from interface java.util.Map

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

Methods inherited from interface org.eclipse.collections.api.map.MapIterable

detect, detectOptional, forEachKey, forEachValue, getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, valuesView

Methods inherited from interface org.eclipse.collections.api.map.MutableMapIterable

add, aggregateBy, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWithKey, getOrDefault, putPair, removeAllKeys, removeIf, sumByDouble, sumByFloat, sumByInt, sumByLong, updateValue, updateValueWith

Methods inherited from interface org.eclipse.collections.api.map.sorted.MutableSortedMap

collect, collectWithIndex, flatCollectWith, getIfAbsentPutWith, withMap

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

collectWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, max, min, zip, zipWithIndex

Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable

reverseForEach, reverseForEachWithIndex

Methods inherited from interface org.eclipse.collections.api.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, containsBy, 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, into, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy

Method Details
- adapt
  
  public static <K, V> MutableSortedMap<K,V> adapt(SortedMap<K,V> map)
- 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>
- newEmpty
  
  @Deprecated public MutableSortedMap<K,V> newEmpty()
  
  Deprecated.
  use TreeSortedMap.newEmpty() instead (inlineable)
  
  Description copied from interface: MutableSortedMap
  
  Creates a new instance of the same type with the same internal Comparator.
  
  Specified by:
  
  newEmpty in interface MutableMapIterable<K,V>
  
  Specified by:
  
  newEmpty in interface MutableSortedMap<K,V>
- 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)
- comparator
  
  public Comparator<? super K> comparator()
  
  Specified by:
  
  comparator in interface SortedMap<K,V>
  
  Specified by:
  
  comparator in interface SortedMapIterable<K,V>
- 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>
- isEmpty
  
  public boolean isEmpty()
  
  Description copied from interface: RichIterable
  
  Returns true if this iterable has zero items.
  
  Specified by:
  
  isEmpty in interface Map<K,V>
  
  Specified by:
  
  isEmpty in interface RichIterable<K>
  
  Overrides:
  
  isEmpty in class AbstractRichIterable<V>
- iterator
  
  public Iterator<V> iterator()
  
  Specified by:
  
  iterator in interface Iterable<K>
  
  Overrides:
  
  iterator in class AbstractMutableMapIterable<K,V>
- remove
  
  public V remove(Object key)
  
  Specified by:
  
  remove in interface Map<K,V>
- putAll
  
  public void putAll(Map<? extends K,? extends V> map)
  
  Specified by:
  
  putAll in interface Map<K,V>
- values
  
  public MutableCollection<V> values()
  
  Specified by:
  
  values in interface Map<K,V>
  
  Specified by:
  
  values in interface MutableSortedMap<K,V>
  
  Specified by:
  
  values in interface SortedMap<K,V>
- entrySet
  
  public MutableSet<Map.Entry<K,V>> entrySet()
  
  Specified by:
  
  entrySet in interface Map<K,V>
  
  Specified by:
  
  entrySet in interface MutableSortedMap<K,V>
  
  Specified by:
  
  entrySet in interface SortedMap<K,V>
- keySet
  
  public MutableSet<K> keySet()
  
  Description copied from interface: 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 Map<K,V>
  
  Specified by:
  
  keySet in interface MutableSortedMap<K,V>
  
  Specified by:
  
  keySet in interface SortedMap<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>
- headMap
  
  public MutableSortedMap<K,V> headMap(K toKey)
  
  Specified by:
  
  headMap in interface MutableSortedMap<K,V>
  
  Specified by:
  
  headMap in interface SortedMap<K,V>
- tailMap
  
  public MutableSortedMap<K,V> tailMap(K fromKey)
  
  Specified by:
  
  tailMap in interface MutableSortedMap<K,V>
  
  Specified by:
  
  tailMap in interface SortedMap<K,V>
- subMap
  
  public MutableSortedMap<K,V> subMap(K fromKey, K toKey)
  
  Specified by:
  
  subMap in interface MutableSortedMap<K,V>
  
  Specified by:
  
  subMap in interface SortedMap<K,V>
- clear
  
  public void clear()
  
  Specified by:
  
  clear in interface Map<K,V>
- 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)
- put
  
  public V put(K key, V value)
  
  Specified by:
  
  put in interface Map<K,V>
- removeKey
  
  public V removeKey(K key)
  
  Description copied from interface: MutableMapIterable
  
  Remove an entry from the map at the specified key.
  
  Specified by:
  
  removeKey in interface MutableMapIterable<K,V>
  
  Returns:
  
  The value removed from entry at key, or null if not found.
  
  See Also:
  
  Map.remove(Object)
- with
  
  public MutableSortedMap<K,V> with(Pair<K,V>... pairs)
  
  Specified by:
  
  with in interface MutableSortedMap<K,V>
- 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()
- clone
  
  public MutableSortedMap<K,V> clone()
  
  Specified by:
  
  clone in interface MutableSortedMap<K,V>
  
  Specified by:
  
  clone in class AbstractMutableSortedMap<K,V>
- equals
  
  public boolean equals(Object o)
  
  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
- toReversed
  
  public MutableSortedMap<K,V> toReversed()
  
  Description copied from interface: ReversibleIterable
  
  Returns a new ReversibleIterable in reverse order.
  
  Specified by:
  
  toReversed in interface MutableSortedMap<K,V>
  
  Specified by:
  
  toReversed in interface ReversibleIterable<K>
  
  Specified by:
  
  toReversed in interface SortedMapIterable<K,V>
- take
  
  public MutableSortedMap<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 MutableSortedMap<K,V>
  
  Specified by:
  
  take in interface ReversibleIterable<K>
  
  Specified by:
  
  take in interface SortedMapIterable<K,V>
  
  Parameters:
  
  count - the number of items to take.
- takeWhile
  
  public MutableSortedMap<K,V> takeWhile(Predicate<? super V> predicate)
  
  Description copied from interface: 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 MutableSortedMap<K,V>
  
  Specified by:
  
  takeWhile in interface OrderedIterable<K>
  
  Specified by:
  
  takeWhile in interface ReversibleIterable<K>
  
  Specified by:
  
  takeWhile in interface SortedMapIterable<K,V>
- drop
  
  public MutableSortedMap<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 MutableSortedMap<K,V>
  
  Specified by:
  
  drop in interface ReversibleIterable<K>
  
  Specified by:
  
  drop in interface SortedMapIterable<K,V>
  
  Parameters:
  
  count - the number of items to drop.
- dropWhile
  
  public MutableSortedMap<K,V> dropWhile(Predicate<? super V> predicate)
  
  Description copied from interface: 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 MutableSortedMap<K,V>
  
  Specified by:
  
  dropWhile in interface OrderedIterable<K>
  
  Specified by:
  
  dropWhile in interface ReversibleIterable<K>
  
  Specified by:
  
  dropWhile in interface SortedMapIterable<K,V>
- partitionWhile
  
  public PartitionMutableList<V> partitionWhile(Predicate<? super V> predicate)
  
  Description copied from interface: 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 MutableSortedMap<K,V>
  
  Specified by:
  
  partitionWhile in interface OrderedIterable<K>
  
  Specified by:
  
  partitionWhile in interface ReversibleIterable<K>
  
  Specified by:
  
  partitionWhile in interface SortedMapIterable<K,V>
- distinct
  
  public MutableList<V> distinct()
  
  Description copied from interface: 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 MutableSortedMap<K,V>
  
  Specified by:
  
  distinct in interface OrderedIterable<K>
  
  Specified by:
  
  distinct in interface ReversibleIterable<K>
  
  Specified by:
  
  distinct in interface SortedMapIterable<K,V>
  
  Returns:
  
  OrderedIterable of distinct elements

Class SortedMapAdapter<K,​V>

Nested Class Summary

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