Top Description Fields Constructors Methods
org.apache.commons.collections4.splitmap

public Class AbstractIterableGetMapDecorator<K, V>

extends Object
implements IterableGet<K, V>
Class Inheritance
All Implemented Interfaces
org.apache.commons.collections4.IterableGet, org.apache.commons.collections4.Get
Known Direct Subclasses
org.apache.commons.collections4.splitmap.TransformedSplitMap
Type Parameters
<K>
the type of the keys in this map
<V>
the type of the values in this map
Imports
java.util.Collection, .Map, .Set, org.apache.commons.collections4.IterableGet, .MapIterator, org.apache.commons.collections4.map.EntrySetToMapIteratorAdapter
IterableGet that uses a Map<K, V> for the Get<K, V> implementation.
Since
4.0

Field Summary

Modifier and TypeField and Description
pack-priv transient Map<K, V>
map

The map to decorate

Constructor Summary

AccessConstructor and Description
public
AbstractIterableGetMapDecorator(final Map<K, V>
the map to decorate, must not be null
map)

Create a new AbstractSplitMapDecorator.

protected
AbstractIterableGetMapDecorator()

Constructor only used in deserialization, do not use otherwise.

Method Summary

Modifier and TypeMethod and Description
public boolean
containsKey(final Object
key whose presence in this map is to be tested
key)

Implements org.apache.commons.collections4.Get.containsKey.

public boolean
containsValue(final Object
value whose presence in this map is to be tested
value)

Implements org.apache.commons.collections4.Get.containsValue.

protected Map<K, V>

Returns:

the decorated map
decorated()

Gets the map being decorated.

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

Implements org.apache.commons.collections4.Get.entrySet.

public boolean
equals(final Object
the reference object with which to compare.
object)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public V
get(final Object
the key whose associated value is to be returned
key)

Implements org.apache.commons.collections4.Get.get.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isEmpty()

Implements org.apache.commons.collections4.Get.isEmpty.

public Set<K>
keySet()

Implements org.apache.commons.collections4.Get.keySet.

public MapIterator<K, V>

Returns:

MapIterator<K, V>
mapIterator()

Implements org.apache.commons.collections4.IterableGet.mapIterator.

Get a MapIterator over this Get.
public V
remove(final Object
key whose mapping is to be removed from the map
key)

Implements org.apache.commons.collections4.Get.remove.

public int
size()

Implements org.apache.commons.collections4.Get.size.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public Collection<V>
values()

Implements org.apache.commons.collections4.Get.values.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

mapback to summary
pack-priv transient Map<K, V> map

The map to decorate

Constructor Detail

AbstractIterableGetMapDecoratorback to summary
public AbstractIterableGetMapDecorator(final Map<K, V> map)

Create a new AbstractSplitMapDecorator.

Parameters
map:Map<K, V>

the map to decorate, must not be null

Exceptions
NullPointerException:
if map is null
AbstractIterableGetMapDecoratorback to summary
protected AbstractIterableGetMapDecorator()

Constructor only used in deserialization, do not use otherwise.

Method Detail

containsKeyback to summary
public boolean containsKey(final Object key)

Implements org.apache.commons.collections4.Get.containsKey.

Parameters
key:Object

Doc from org.apache.commons.collections4.Get.containsKey.

key whose presence in this map is to be tested

Returns:boolean

Doc from org.apache.commons.collections4.Get.containsKey.

true if this map contains a mapping for the specified key

Annotations
@Override
containsValueback to summary
public boolean containsValue(final Object value)

Implements org.apache.commons.collections4.Get.containsValue.

Parameters
value:Object

Doc from org.apache.commons.collections4.Get.containsValue.

value whose presence in this map is to be tested

Returns:boolean

Doc from org.apache.commons.collections4.Get.containsValue.

true if this map maps one or more keys to the specified value

Annotations
@Override
decoratedback to summary
protected Map<K, V> decorated()

Gets the map being decorated.

Returns:Map<K, V>

the decorated map

entrySetback to summary
public Set<Map.Entry<K, V>> entrySet()

Implements org.apache.commons.collections4.Get.entrySet.

Returns:Set<Map.Entry<K, V>>

Doc from org.apache.commons.collections4.Get.entrySet.

a set view of the mappings contained in this map

Annotations
@Override
equalsback to summary
public boolean equals(final Object object)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
object:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getback to summary
public V get(final Object key)

Implements org.apache.commons.collections4.Get.get.

Parameters
key:Object

Doc from org.apache.commons.collections4.Get.get.

the key whose associated value is to be returned

Returns:V

Doc from org.apache.commons.collections4.Get.get.

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
isEmptyback to summary
public boolean isEmpty()

Implements org.apache.commons.collections4.Get.isEmpty.

Returns:boolean

Doc from org.apache.commons.collections4.Get.isEmpty.

true if this map contains no key-value mappings

Annotations
@Override
keySetback to summary
public Set<K> keySet()

Implements org.apache.commons.collections4.Get.keySet.

Returns:Set<K>

Doc from org.apache.commons.collections4.Get.keySet.

a set view of the keys contained in this map

Annotations
@Override
mapIteratorback to summary
public MapIterator<K, V> mapIterator()

Implements org.apache.commons.collections4.IterableGet.mapIterator.

Get a MapIterator over this Get.

Returns:MapIterator<K, V>

MapIterator<K, V>

Annotations
@Override
removeback to summary
public V remove(final Object key)

Implements org.apache.commons.collections4.Get.remove.

Parameters
key:Object

Doc from org.apache.commons.collections4.Get.remove.

key whose mapping is to be removed from the map

Returns:V

Doc from org.apache.commons.collections4.Get.remove.

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

Annotations
@Override
sizeback to summary
public int size()

Implements org.apache.commons.collections4.Get.size.

Returns:int

Doc from org.apache.commons.collections4.Get.size.

the number of key-value mappings in this map

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
valuesback to summary
public Collection<V> values()

Implements org.apache.commons.collections4.Get.values.

Returns:Collection<V>

Doc from org.apache.commons.collections4.Get.values.

a collection view of the values contained in this map

Annotations
@Override