⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
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:
Map, BoundedMap, SortedMap, SortedMap


public class FixedSizeSortedMap
extends AbstractSortedMapDecorator
implements SortedMap, BoundedMap

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.

Since:
Commons Collections 3.0
Authors:
Stephen Colebourne
Paul Jack

Constructor Summary

FixedSizeSortedMap(SortedMap map)

Constructor that wraps (not copies).

Method Summary

void

clear()

static SortedMap

decorate(SortedMap map)

Factory method to create a fixed size sorted map.

Set

entrySet()

SortedMap

getSortedMap()

Gets the map being decorated.

SortedMap

headMap(Object toKey)

boolean

isFull()

Set

keySet()

int

maxSize()

Object

put(Object key, Object value)

void

putAll(Map mapToCopy)

Object

remove(Object key)

SortedMap

subMap(Object fromKey, Object toKey)

SortedMap

tailMap(Object fromKey)

Collection

values()

Constructor Details

FixedSizeSortedMap

protected FixedSizeSortedMap(SortedMap map)

Constructor that wraps (not copies).

Parameters:
map - the map to decorate, must not be null
Throws:
- if map is null

Method Details

clear

public void clear()


decorate

public static SortedMap decorate(SortedMap map)

Factory method to create a fixed size sorted map.

Parameters:
map - the map to decorate, must not be null
Throws:
- if map is null

entrySet

public Set entrySet()


getSortedMap

protected SortedMap getSortedMap()

Gets the map being decorated.

Returns:
the decorated map

headMap

public SortedMap headMap(Object toKey)

Parameters:
toKey

isFull

public boolean isFull()


keySet

public Set keySet()


maxSize

public int maxSize()


put

public Object put(Object key, Object value)

Parameters:
key
value

putAll

public void putAll(Map mapToCopy)

Parameters:
mapToCopy

remove

public Object remove(Object key)

Parameters:
key

subMap

public SortedMap subMap(Object fromKey, Object toKey)

Parameters:
fromKey
toKey

tailMap

public SortedMap tailMap(Object fromKey)

Parameters:
fromKey

values

public Collection values()