Package org.eclipse.collections.api.map

Interface FixedSizeMap<K,V>

All Superinterfaces:

Cloneable, InternalIterable<V>, Iterable<V>, Map<K,V>, MapIterable<K,V>, MutableMap<K,V>, MutableMapIterable<K,V>, RichIterable<V>, UnsortedMapIterable<K,V>

public interface FixedSizeMap<K,V>
extends MutableMap<K,V>

A FixedSizeMap is a map that may be mutated, but cannot grow or shrink in size.

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
void	clear()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
default void	putAllMapIterable(MapIterable<? extends K,? extends V> mapIterable)
V	remove(Object key)
boolean	removeAllKeys(Set<? extends K> keys)	Remove entries from the map at the specified keys.
boolean	removeIf(Predicate2<? super K,? super V> predicate)	Remove an entry from the map if the predicate evaluates to true.
V	removeKey(K key)	Remove an entry from the map at the specified key.
FixedSizeMap<K,V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each value of the map and returns this.
default FixedSizeMap<K,V>	withMap(Map<? extends K,? extends V> map)	Similar to Map.putAll(Map), but returns this instead of void
default FixedSizeMap<K,V>	withMapIterable(MapIterable<? extends K,? extends V> mapIterable)

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

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values

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

containsKey, containsValue, detect, detectOptional, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, injectIntoKeyValue, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView

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

aggregateBy, aggregateBy, aggregateInPlaceBy, asSynchronized, asUnmodifiable, clone, collect, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectKeysAndValues, collectLong, collectShort, collectValues, collectWith, flatCollect, flatCollectWith, flip, flipUniqueValues, groupBy, groupByEach, groupByUniqueKey, newEmpty, partition, partitionWith, reject, reject, rejectWith, select, select, selectInstancesOf, selectWith, withAllKeyValueArguments, withAllKeyValues, withKeyValue, withoutAllKeys, withoutKey, zip, zipWithIndex

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

add, countBy, countByEach, countByWith, forEach, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, getOrDefault, putPair, sumByDouble, sumByFloat, sumByInt, sumByLong, toImmutable, 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, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, 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, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, 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, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

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

toImmutable

Method Detail

clear

void clear()

Specified by:

clear in interface Map<K,V>

Throws:

UnsupportedOperationException - the clear operation is not supported by this map.

put

V put(K key,
      V value)

Specified by:

put in interface Map<K,V>

Throws:

UnsupportedOperationException - the put operation is not supported by this map.

putAll

void putAll(Map<? extends K,? extends V> map)

Specified by:

putAll in interface Map<K,V>

Throws:

UnsupportedOperationException - the putAll operation is not supported by this map.

remove

V remove(Object key)

Specified by:

remove in interface Map<K,V>

Throws:

UnsupportedOperationException - the remove operation is not supported by this map.

removeKey

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.

Throws:

UnsupportedOperationException - the removeKey operation is not supported by this map.

See Also:

Map.remove(Object)

removeAllKeys

boolean removeAllKeys(Set<? extends K> keys)

Description copied from interface: MutableMapIterable

Remove entries from the map at the specified keys.

Specified by:

removeAllKeys in interface MutableMapIterable<K,V>

Returns:

true if this map changed as a result of the call

Throws:

UnsupportedOperationException - the removeAllKeys operation is not supported by this map.

removeIf

boolean removeIf(Predicate2<? super K,? super V> predicate)

Description copied from interface: MutableMapIterable

Remove an entry from the map if the predicate evaluates to true.

Specified by:

removeIf in interface MutableMapIterable<K,V>

Returns:

true if any entry is removed.

Throws:

UnsupportedOperationException - the removeIf operation is not supported by this map.

tap

FixedSizeMap<K,V> tap(Procedure<? super V> procedure)

Description copied from interface: MapIterable

Executes the Procedure for each value of the map and returns this.

 return peopleByCity.tap(person -> LOGGER.info(person.getName()));
 

Specified by:

tap in interface MapIterable<K,V>

Specified by:

tap in interface MutableMap<K,V>

Specified by:

tap in interface MutableMapIterable<K,V>

Specified by:

tap in interface RichIterable<K>

Specified by:

tap in interface UnsortedMapIterable<K,V>

See Also:

RichIterable.forEach(Procedure)

withMap

default FixedSizeMap<K,V> withMap(Map<? extends K,? extends V> map)

Description copied from interface: MutableMapIterable

Similar to Map.putAll(Map), but returns this instead of void

Specified by:

withMap in interface MutableMap<K,V>

Specified by:

withMap in interface MutableMapIterable<K,V>

See Also:

Map.putAll(Map)

withMapIterable

default FixedSizeMap<K,V> withMapIterable(MapIterable<? extends K,? extends V> mapIterable)

Specified by:

withMapIterable in interface MutableMap<K,V>

Specified by:

withMapIterable in interface MutableMapIterable<K,V>

putAllMapIterable

default void putAllMapIterable(MapIterable<? extends K,? extends V> mapIterable)

Specified by:

putAllMapIterable in interface MutableMapIterable<K,V>