Modifier and Type	Class and Description
protected static class	IdMap.UserEntry
private class	IdMap.UserEntrySet

Modifier and Type	Field and Description
pack-priv Identicator	id
pack-priv Map<K, V>	inner

Access	Constructor and Description
protected	IdMap(Map<K, V> inner, Identicator id)

Method Summary

Modifier and Type	Method and Description
public boolean	containsKey(Object key whose presence in this map is to be tested key) Overrides java.util.AbstractMap.containsKey. Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
protected final Map.Entry<K, V>	createIdEntry(Object key, Object val)
protected final Map.Entry<K, V>	createIdEntry(Map.Entry<K, V> entry)
protected abstract IdHashKey	createIdKey(Object o)
public Set<E>	entrySet() Implements abstract java.util.AbstractMap.entrySet. Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
public Object	get(Object the key whose associated value is to be returned key) Overrides java.util.AbstractMap.get. Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
protected final Set<E>	internalEntrySet()
public Object	put(Object key with which the specified value is to be associated key, Object value to be associated with the specified key value) Overrides java.util.AbstractMap.put. Implements java.util.Map.put. Associates the specified value with the specified key in this map (optional operation).
public Object	remove(Object key whose mapping is to be removed from the map key) Overrides java.util.AbstractMap.remove. Implements java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation).
protected Object	removeIdHashKey(IdHashKey idhk)

Inherited from java.util.AbstractMap:: clear clone containsValue equals hashCode isEmpty keySet putAll size toString values

Field Detail

id	back to summary
pack-priv Identicator id

inner	back to summary
pack-priv Map<K, V> inner

Constructor Detail

IdMap	back to summary
protected IdMap(Map<K, V> inner, Identicator id)

Method Detail

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Overrides java.util.AbstractMap.containsKey. Implements java.util.Map.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters key:Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key

public boolean containsKey(Object key)

Overrides java.util.AbstractMap.containsKey.

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

key:Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

createIdEntry	back to summary
protected final Map.Entry<K, V> createIdEntry(Object key, Object val)

createIdEntry	back to summary
protected final Map.Entry<K, V> createIdEntry(Map.Entry<K, V> entry)

createIdKey	back to summary
protected abstract IdHashKey createIdKey(Object o)

entrySet back to summary

entrySet	back to summary
public Set<E> entrySet() Implements abstract java.util.AbstractMap.entrySet. Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<E> a set view of the mappings contained in this map

public Set<E> entrySet()

Implements abstract java.util.AbstractMap.entrySet.

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<E>: a set view of the mappings contained in this map

get back to summary

get	back to summary
public Object get(Object key) Overrides java.util.AbstractMap.get. Implements java.util.Map.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) If this map permits null values, then a return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object the key whose associated value is to be returned Returns:Object the value to which the specified key is mapped, or `null` if this map contains no mapping for the key

public Object get(Object key)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Doc from java.util.Map.get.

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

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object: the key whose associated value is to be returned

Returns:Object

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

internalEntrySet	back to summary
protected final Set<E> internalEntrySet()

put back to summary

put	back to summary
public Object put(Object key, Object value) Overrides java.util.AbstractMap.put. Implements java.util.Map.put. Doc from java.util.Map.put. Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map `m` is said to contain a mapping for a key `k` if and only if `m.containsKey(k)` would return `true`.) Parameters key:Object key with which the specified value is to be associated value:Object value to be associated with the specified key Returns:Object the previous value associated with `key`, or `null` if there was no mapping for `key`. (A `null` return can also indicate that the map previously associated `null` with `key`, if the implementation supports `null` values.)

public Object put(Object key, Object value)

Overrides java.util.AbstractMap.put.

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters

key:Object: key with which the specified value is to be associated
value:Object: value to be associated with the specified key

Returns:Object

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

remove back to summary

remove	back to summary
public Object remove(Object key) Overrides java.util.AbstractMap.remove. Implements java.util.Map.remove. Doc from java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key `k` to value `v` such that `Objects.equals(key, k)`, that mapping is removed. (The map can contain at most one such mapping.) Returns the value to which this map previously associated the key, or `null` if the map contained no mapping for the key. If this map permits null values, then a return value of `null` does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to `null`. The map will not contain a mapping for the specified key once the call returns. Parameters key:Object key whose mapping is to be removed from the map Returns:Object the previous value associated with `key`, or `null` if there was no mapping for `key`.

public Object remove(Object key)

Overrides java.util.AbstractMap.remove.

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters

key:Object: key whose mapping is to be removed from the map

Returns:Object

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

removeIdHashKey	back to summary
protected Object removeIdHashKey(IdHashKey idhk)

com.mchange.v1.identicator back to summary

protected Class IdMap.UserEntry

Class Inheritance

extends AbstractMapEntry

java.lang.Object
com.mchange.v1.util.AbstractMapEntry
com.mchange.v1.identicator.IdMap.UserEntry

Field Summary

Modifier and Type	Field and Description
private Map.Entry<K, V>	innerEntry

Constructor Summary

Access	Constructor and Description
pack-priv	UserEntry(Map.Entry<K, V> innerEntry)

Method Summary

Modifier and Type	Method and Description
public final Object	getKey() Implements abstract com.mchange.v1.util.AbstractMapEntry.getKey. Implements java.util.Map.Entry.getKey. Returns the key corresponding to this entry.
public final Object	getValue() Implements abstract com.mchange.v1.util.AbstractMapEntry.getValue. Implements java.util.Map.Entry.getValue. Returns the value corresponding to this entry.
public final Object	setValue(Object new value to be stored in this entry value) Implements abstract com.mchange.v1.util.AbstractMapEntry.setValue. Implements java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation).

Inherited from com.mchange.v1.util.AbstractMapEntry:: equals hashCode

Field Detail

innerEntry	back to summary
private Map.Entry<K, V> innerEntry

Constructor Detail

UserEntry	back to summary
pack-priv UserEntry(Map.Entry<K, V> innerEntry)

Method Detail

getKey	back to summary
public final Object getKey() Implements abstract com.mchange.v1.util.AbstractMapEntry.getKey. Implements java.util.Map.Entry.getKey. Doc from java.util.Map.Entry.getKey. Returns the key corresponding to this entry. Returns:Object the key corresponding to this entry

getKey

back to summary

public final Object getKey()

Implements abstract com.mchange.v1.util.AbstractMapEntry.getKey.

Implements java.util.Map.Entry.getKey.

Doc from java.util.Map.Entry.getKey.

Returns the key corresponding to this entry.

Returns:Object: the key corresponding to this entry

getValue back to summary

getValue	back to summary
public final Object getValue() Implements abstract com.mchange.v1.util.AbstractMapEntry.getValue. Implements java.util.Map.Entry.getValue. Doc from java.util.Map.Entry.getValue. Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's `remove` operation), the results of this call are undefined. Returns:Object the value corresponding to this entry

public final Object getValue()

Implements abstract com.mchange.v1.util.AbstractMapEntry.getValue.

Implements java.util.Map.Entry.getValue.

Doc from java.util.Map.Entry.getValue.

Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove operation), the results of this call are undefined.

Returns:Object: the value corresponding to this entry

setValue back to summary

setValue	back to summary
public final Object setValue(Object value) Implements abstract com.mchange.v1.util.AbstractMapEntry.setValue. Implements java.util.Map.Entry.setValue. Doc from java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's `remove` operation). Parameters value:Object new value to be stored in this entry Returns:Object old value corresponding to the entry

public final Object setValue(Object value)

Implements abstract com.mchange.v1.util.AbstractMapEntry.setValue.

Implements java.util.Map.Entry.setValue.

Doc from java.util.Map.Entry.setValue.

Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

Parameters

value:Object: new value to be stored in this entry

Returns:Object

old value corresponding to the entry

com.mchange.v1.identicator back to summary

private final Class IdMap.UserEntrySet

Class Inheritance

extends AbstractSet

java.lang.Object
java.util.AbstractCollection
java.util.AbstractSet
com.mchange.v1.identicator.IdMap.UserEntrySet

Field Summary

Modifier and Type	Field and Description
pack-priv Set<E>	innerEntries

Constructor Summary

Access	Constructor and Description
private	UserEntrySet()

Method Summary

Modifier and Type	Method and Description
public void	clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Set.clear, java.util.Collection.clear. Removes all of the elements from this set (optional operation).
public boolean	contains(Object element whose presence in this set is to be tested o) Overrides java.util.AbstractCollection.contains. Implements java.util.Set.contains, java.util.Collection.contains. Returns `true` if this set contains the specified element.
public Iterator<E>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set.
public boolean	remove(Object object to be removed from this set, if present o) Overrides java.util.AbstractCollection.remove. Implements java.util.Set.remove, java.util.Collection.remove. Removes the specified element from this set if it is present (optional operation).
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set (its cardinality).

Inherited from java.util.AbstractSet:: equals hashCode removeAll

Field Detail

innerEntries	back to summary
pack-priv Set<E> innerEntries

Constructor Detail

UserEntrySet	back to summary
private UserEntrySet()

Method Detail

clear	back to summary
public void clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Set.clear, java.util.Collection.clear. Doc from java.util.Set.clear. Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

clear

back to summary

public void clear()

Overrides java.util.AbstractCollection.clear.

Implements java.util.Set.clear, java.util.Collection.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

contains back to summary

contains	back to summary
public boolean contains(Object o) Overrides java.util.AbstractCollection.contains. Implements java.util.Set.contains, java.util.Collection.contains. Doc from java.util.Set.contains. Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `Objects.equals(o, e)`. Parameters o:Object element whose presence in this set is to be tested Returns:boolean `true` if this set contains the specified element

public boolean contains(Object o)

Overrides java.util.AbstractCollection.contains.

Implements java.util.Set.contains, java.util.Collection.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Parameters

o:Object: element whose presence in this set is to be tested

Returns:boolean

true if this set contains the specified element

iterator	back to summary
public Iterator<E> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee). Returns:Iterator<E> an iterator over the elements in this set

iterator

back to summary

public Iterator<E> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:Iterator<E>: an iterator over the elements in this set

remove back to summary

remove	back to summary
public boolean remove(Object o) Overrides java.util.AbstractCollection.remove. Implements java.util.Set.remove, java.util.Collection.remove. Doc from java.util.Set.remove. Removes the specified element from this set if it is present (optional operation). More formally, removes an element `e` such that `Objects.equals(o, e)`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.) Parameters o:Object object to be removed from this set, if present Returns:boolean `true` if this set contained the specified element

public boolean remove(Object o)

Overrides java.util.AbstractCollection.remove.

Implements java.util.Set.remove, java.util.Collection.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters

o:Object: object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

size back to summary

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Doc from java.util.Set.size. Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this set (its cardinality)

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int: the number of elements in this set (its cardinality)

pack-priv abstract Class IdMap

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class IdMap.UserEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class IdMap.UserEntrySet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail