Package org.apache.commons.collections4
Interface Get<K,V>
- Type Parameters:
K
- the type of the keys in this mapV
- the type of the values in this map
- All Known Subinterfaces:
BidiMap<K,
,V> BoundedMap<K,
,V> IterableGet<K,
,V> IterableMap<K,
,V> IterableSortedMap<K,
,V> MultiMap<K,
,V> OrderedBidiMap<K,
,V> OrderedMap<K,
,V> SortedBidiMap<K,
,V> Trie<K,
V>
- All Known Implementing Classes:
AbstractBidiMapDecorator
,AbstractBitwiseTrie
,AbstractDualBidiMap
,AbstractHashedMap
,AbstractIterableGetMapDecorator
,AbstractIterableMap
,AbstractLinkedMap
,AbstractMapDecorator
,AbstractOrderedBidiMapDecorator
,AbstractOrderedMapDecorator
,AbstractPatriciaTrie
,AbstractReferenceMap
,AbstractSortedBidiMapDecorator
,AbstractSortedMapDecorator
,CaseInsensitiveMap
,CompositeMap
,DefaultedMap
,DualHashBidiMap
,DualLinkedHashBidiMap
,DualTreeBidiMap
,DualTreeBidiMap.ViewMap
,FixedSizeMap
,FixedSizeSortedMap
,Flat3Map
,HashedMap
,LazyMap
,LazySortedMap
,LinkedMap
,ListOrderedMap
,LRUMap
,MultiKeyMap
,MultiValueMap
,PassiveExpiringMap
,PatriciaTrie
,PredicatedMap
,PredicatedSortedMap
,ReferenceIdentityMap
,ReferenceMap
,SingletonMap
,StaticBucketMap
,TransformedMap
,TransformedSortedMap
,TransformedSplitMap
,TreeBidiMap
,UnmodifiableBidiMap
,UnmodifiableMap
,UnmodifiableOrderedBidiMap
,UnmodifiableOrderedMap
,UnmodifiableSortedBidiMap
,UnmodifiableSortedMap
,UnmodifiableTrie
public interface Get<K,V>
The "read" subset of the
Map
interface.- Since:
- 4.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsKey
(Object key) Tests for presence of a given key.boolean
containsValue
(Object value) Tests for presence of a given value.entrySet()
Gets a set view of the mappings contained in this map.Gets a value at a given key.boolean
isEmpty()
Tests whether this instance contains any key-value mappings.keySet()
Gets a view of the keys contained in this map.Remove a key-value mappings.int
size()
Gets the number of key-value mappings in this map.values()
Gets a a collection view of the values contained in this map.
-
Method Details
-
containsKey
Tests for presence of a given key.- Parameters:
key
- key whose presence in this map is to be tested- Returns:
true
if this map contains a mapping for the specified key- See Also:
-
containsValue
Tests for presence of a given value.- Parameters:
value
- value whose presence in this map is to be tested- Returns:
true
if this map maps one or more keys to the specified value- See Also:
-
entrySet
Gets a set view of the mappings contained in this map.- Returns:
- a set view of the mappings contained in this map.
- See Also:
-
get
Gets a value at a given key.- Parameters:
key
- the key whose associated value is to be returned- Returns:
- the value to which the specified key is mapped, or
null
if this map contains no mapping for the key - See Also:
-
isEmpty
boolean isEmpty()Tests whether this instance contains any key-value mappings.- Returns:
true
if this map contains no key-value mappings- See Also:
-
keySet
Gets a view of the keys contained in this map.- Returns:
- a set view of the keys contained in this map
- See Also:
-
remove
Remove a key-value mappings.- Parameters:
key
- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
. - See Also:
-
size
int size()Gets the number of key-value mappings in this map.- Returns:
- the number of key-value mappings in this map.
- See Also:
-
values
Collection<V> values()Gets a a collection view of the values contained in this map.- Returns:
- a collection view of the values contained in this map.
- See Also:
-