FixedSizeSortedMap (Commons Collections 3.2.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.collections.map
Class FixedSizeSortedMap

java.lang.Object
  org.apache.commons.collections.map.AbstractMapDecorator
      org.apache.commons.collections.map.AbstractSortedMapDecorator
          org.apache.commons.collections.map.FixedSizeSortedMap

All Implemented Interfaces:: java.io.Serializable, java.util.Map, java.util.SortedMap, BoundedMap

public class FixedSizeSortedMap
extends AbstractSortedMapDecorator
implements java.util.SortedMap, BoundedMap, java.io.Serializable
extends AbstractSortedMapDecorator
implements java.util.SortedMap, BoundedMap, java.io.Serializable

Decorates another SortedMap to fix the size blocking add/remove.

Any action that would change the size of the map is disallowed. The put method is allowed to change the value associated with an existing key however.

If trying to remove or clear the map, an UnsupportedOperationException is thrown. If trying to put a new mapping into the map, an IllegalArgumentException is thrown. This is because the put method can succeed if the mapping's key already exists in the map, so the put method is not always unsupported.

Note that FixedSizeSortedMap is not synchronized and is not thread-safe. If you wish to use this map from multiple threads concurrently, you must use appropriate synchronization. The simplest approach is to wrap this map using Collections.synchronizedSortedMap(java.util.SortedMap). This class may throw exceptions when accessed by concurrent threads without synchronization.

This class is Serializable from Commons Collections 3.1.

Since:: Commons Collections 3.0
Version:: $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $
Author:: Stephen Colebourne, Paul Jack
See Also:: Serialized Form

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
`map`

Constructor Summary
`protected`	`FixedSizeSortedMap(java.util.SortedMap map)` Constructor that wraps (not copies).

Method Summary
`void`	`clear()`
`static java.util.SortedMap`	`decorate(java.util.SortedMap map)` Factory method to create a fixed size sorted map.
`java.util.Set`	`entrySet()`
`protected java.util.SortedMap`	`getSortedMap()` Gets the map being decorated.
`java.util.SortedMap`	`headMap(java.lang.Object toKey)`
`boolean`	`isFull()` Returns true if this map is full and no new elements can be added.
`java.util.Set`	`keySet()`
`int`	`maxSize()` Gets the maximum size of the map (the bound).
`java.lang.Object`	`put(java.lang.Object key, java.lang.Object value)`
`void`	`putAll(java.util.Map mapToCopy)`
`java.lang.Object`	`remove(java.lang.Object key)`
`java.util.SortedMap`	`subMap(java.lang.Object fromKey, java.lang.Object toKey)`
`java.util.SortedMap`	`tailMap(java.lang.Object fromKey)`
`java.util.Collection`	`values()`

Methods inherited from class org.apache.commons.collections.map.AbstractSortedMapDecorator
`comparator, firstKey, lastKey`

Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
`containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, size, toString`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface java.util.SortedMap
`comparator, firstKey, lastKey`

Methods inherited from interface java.util.Map
`containsKey, containsValue, equals, get, hashCode, isEmpty, size`

Methods inherited from interface java.util.Map
`containsKey, containsValue, equals, get, hashCode, isEmpty, size`

Constructor Detail