org.apache.commons.collections4
Interface BoundedMap<K,V>

All Superinterfaces:
Get<K,V>, IterableGet<K,V>, IterableMap<K,V>, Map<K,V>, Put<K,V>
All Known Implementing Classes:
FixedSizeMap, FixedSizeSortedMap, LRUMap, SingletonMap

public interface BoundedMap<K,V>
extends IterableMap<K,V>

Defines a map that is bounded in size.

The size of the map can vary, but it can never exceed a preset maximum number of elements. This interface allows the querying of details associated with the maximum number of elements.

Since:
3.0
Version:
$Id: BoundedMap.java 1477779 2013-04-30 18:55:24Z tn $

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Method Summary
 boolean isFull()
          Returns true if this map is full and no new elements can be added.
 int maxSize()
          Gets the maximum size of the map (the bound).
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from interface org.apache.commons.collections4.Put
clear, put, putAll
 
Methods inherited from interface org.apache.commons.collections4.IterableGet
mapIterator
 
Methods inherited from interface org.apache.commons.collections4.Get
containsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size, values
 

Method Detail

isFull

boolean isFull()
Returns true if this map is full and no new elements can be added.

Returns:
true if the map is full

maxSize

int maxSize()
Gets the maximum size of the map (the bound).

Returns:
the maximum number of elements the map can hold


Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.