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

All Implemented Interfaces:: Serializable, Cloneable, Iterable<V>, Map<K,V>, InternalIterable<V>, MapIterable<K,V>, MutableMap<K,V>, MutableMapIterable<K,V>, UnsortedMapIterable<K,V>, RichIterable<V>

public class MapAdapter<K,V>
extends AbstractMutableMap<K,V>
implements Serializable

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

To create a new wrapper around an existing Map instance, use the adapt(Map) 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> MutableMap<K,V>`	`adapt(Map<K,V> map)`
`void`	`clear()`
`MutableMap<K,V>`	`clone()`
`<E> MutableMap<K,V>`	`collectKeysAndValues(Iterable<E> iterable, Function<? super E,? extends K> keyFunction, Function<? super E,? extends V> valueFunction)`	Adds all the entries derived from `iterable` to `this`.
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(Object o)`	Follows the same general contract as `Map.equals(Object)`.
`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()`.
`boolean`	`isEmpty()`	Returns true if this iterable has zero items.
`Iterator<V>`	`iterator()`
`Set<K>`	`keySet()`
`MutableMap<K,V>`	`newEmpty()`	Creates a new instance of the same type, using the default capacity and growth parameters.
`<K, V> MutableMap<K,V>`	`newEmpty(int capacity)`	Creates a new instance of the same type, using the given capacity and the default growth parameters.
`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.
`ImmutableMap<K,V>`	`toImmutable()`	Returns an immutable copy of this map.
`String`	`toString()`	Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.
`Collection<V>`	`values()`

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

asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectValues, collectWith, flatCollect, flip, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, reject, reject, rejectWith, select, select, selectInstancesOf, selectWith, tap, 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, forEachWithIndex

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, 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.MutableMap

aggregateBy, aggregateBy, aggregateInPlaceBy, collect, flatCollectWith, flipUniqueValues, withMap

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

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

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, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, 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, zip, zipWithIndex

Method Details
- adapt
  
  public static <K, V> MutableMap<K,V> adapt(Map<K,V> map)
- 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 MutableMap<K,V> clone()
  
  Specified by:
  
  clone in interface MutableMap<K,V>
  
  Specified by:
  
  clone in class AbstractMutableMap<K,V>
- newEmpty
  
  public <K, V> MutableMap<K,V> newEmpty(int capacity)
  
  Description copied from class: AbstractMutableMap
  
  Creates a new instance of the same type, using the given capacity and the default growth parameters.
  
  Specified by:
  
  newEmpty in class AbstractMutableMap<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>
- keySet
  
  public Set<K> keySet()
  
  Specified by:
  
  keySet in interface Map<K,V>
- values
  
  public Collection<V> values()
  
  Specified by:
  
  values in interface Map<K,V>
- entrySet
  
  public Set<Map.Entry<K,V>> entrySet()
  
  Specified by:
  
  entrySet in interface Map<K,V>
- clear
  
  public void clear()
  
  Specified by:
  
  clear in interface Map<K,V>
- newEmpty
  
  public MutableMap<K,V> newEmpty()
  
  Description copied from interface: MutableMapIterable
  
  Creates a new instance of the same type, using the default capacity and growth parameters.
  
  Specified by:
  
  newEmpty in interface MutableMap<K,V>
  
  Specified by:
  
  newEmpty in interface MutableMapIterable<K,V>
- 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>
- 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>
- putAll
  
  public void putAll(Map<? extends K,? extends V> map)
  
  Specified by:
  
  putAll in interface Map<K,V>
- collectKeysAndValues
  
  public <E> MutableMap<K,V> collectKeysAndValues(Iterable<E> iterable, Function<? super E,? extends K> keyFunction, Function<? super E,? extends V> valueFunction)
  
  Description copied from interface: MutableMap
  
  Adds all the entries derived from iterable to this. The key and value for each entry is determined by applying the keyFunction and valueFunction to each item in collection. Any entry in map that has the same key as an entry in this will have its value replaced by that in map.
  
  Specified by:
  
  collectKeysAndValues in interface MutableMap<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)
- 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)
- 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
- toImmutable
  
  public ImmutableMap<K,V> toImmutable()
  
  Description copied from interface: MutableMapIterable
  
  Returns an immutable copy of this map. If the map is immutable, it returns itself.
  
  Specified by:
  
  toImmutable in interface MapIterable<K,V>
  
  Specified by:
  
  toImmutable in interface MutableMapIterable<K,V>
  
  Specified by:
  
  toImmutable in interface UnsortedMapIterable<K,V>
  
  Overrides:
  
  toImmutable in class AbstractMutableMap<K,V>

Class MapAdapter<K,​V>

Nested Class Summary

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