Package org.apache.commons.collections4.splitmap

Class AbstractIterableGetMapDecorator<K,V>

java.lang.Object

org.apache.commons.collections4.splitmap.AbstractIterableGetMapDecorator<K,V>

Type Parameters:

K - the type of the keys in this map

V - the type of the values in this map

All Implemented Interfaces:

Get<K,V>, IterableGet<K,V>

Direct Known Subclasses:

TransformedSplitMap

public class AbstractIterableGetMapDecorator<K,V>
extends java.lang.Object
implements IterableGet<K,V>

IterableGet that uses a Map<K, V> for the Get<K, V> implementation.

Since:

4.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractIterableGetMapDecorator()	Constructor only used in deserialization, do not use otherwise.
	AbstractIterableGetMapDecorator(java.util.Map<K,V> map)	Create a new AbstractSplitMapDecorator.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(java.lang.Object key)	Tests for presence of a given key.
boolean	containsValue(java.lang.Object value)	Tests for presence of a given value.
protected java.util.Map<K,V>	decorated()	Gets the map being decorated.
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()	Gets a set view of the mappings contained in this map.
boolean	equals(java.lang.Object object)
V	get(java.lang.Object key)	Gets a value at a given key.
int	hashCode()
boolean	isEmpty()	Tests whether this instance contains any key-value mappings.
java.util.Set<K>	keySet()	Gets a view of the keys contained in this map.
MapIterator<K,V>	mapIterator()	Gets a MapIterator over this Get.
V	remove(java.lang.Object key)	Remove a key-value mappings.
int	size()	Gets the number of key-value mappings in this map.
java.lang.String	toString()
java.util.Collection<V>	values()	Gets a a collection view of the values contained in this map.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractIterableGetMapDecorator

protected AbstractIterableGetMapDecorator()

Constructor only used in deserialization, do not use otherwise.

AbstractIterableGetMapDecorator

public AbstractIterableGetMapDecorator(java.util.Map<K,V> map)

Create a new AbstractSplitMapDecorator.

Parameters:

map - the map to decorate, must not be null

Throws:

java.lang.NullPointerException - if map is null

Method Detail

containsKey

public boolean containsKey(java.lang.Object key)

Description copied from interface: Get

Tests for presence of a given key.

Specified by:

containsKey in interface Get<K,V>

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:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object value)

Description copied from interface: Get

Tests for presence of a given value.

Specified by:

containsValue in interface Get<K,V>

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:

Map.containsValue(Object)

decorated

protected java.util.Map<K,V> decorated()

Gets the map being decorated.

Returns:

the decorated map

entrySet

public java.util.Set<java.util.Map.Entry<K,V>> entrySet()

Description copied from interface: Get

Gets a set view of the mappings contained in this map.

Specified by:

entrySet in interface Get<K,V>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

get

public V get(java.lang.Object key)

Description copied from interface: Get

Gets a value at a given key.

Specified by:

get in interface Get<K,V>

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:

Map.get(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

Description copied from interface: Get

Tests whether this instance contains any key-value mappings.

Specified by:

isEmpty in interface Get<K,V>

Returns:

true if this map contains no key-value mappings

See Also:

Map.isEmpty()

keySet

public java.util.Set<K> keySet()

Description copied from interface: Get

Gets a view of the keys contained in this map.

Specified by:

keySet in interface Get<K,V>

Returns:

a set view of the keys contained in this map

See Also:

Map.keySet()

mapIterator

public MapIterator<K,V> mapIterator()

Gets a MapIterator over this Get.

Specified by:

mapIterator in interface IterableGet<K,V>

Returns:

MapIterator<K, V>

remove

public V remove(java.lang.Object key)

Description copied from interface: Get

Remove a key-value mappings.

Specified by:

remove in interface Get<K,V>

Parameters:

key - key whose mapping is to be removed from the map

Returns:

the previous value associated with key, or null if there was no mapping for key.

See Also:

Map.remove(Object)

size

public int size()

Description copied from interface: Get

Gets the number of key-value mappings in this map.

Specified by:

size in interface Get<K,V>

Returns:

the number of key-value mappings in this map.

See Also:

Map.size()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

values

public java.util.Collection<V> values()

Description copied from interface: Get

Gets a a collection view of the values contained in this map.

Specified by:

values in interface Get<K,V>

Returns:

a collection view of the values contained in this map.

See Also:

Map.values()