ConcurrentReaderHashMap (groovy 2.4.4 API)

org.codehaus.groovy.runtime.metaclass.ConcurrentReaderHashMap

All Implemented Interfaces and Traits:

Map, Cloneable, Serializable
```
public class ConcurrentReaderHashMap
extends AbstractMap
```
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`protected static class`	`ConcurrentReaderHashMap.BarrierLock`	A Serializable class for barrier lock *
`protected static class`	`ConcurrentReaderHashMap.Entry`	ConcurrentReaderHashMap collision list entry.
`protected class`	`ConcurrentReaderHashMap.HashIterator`
`protected class`	`ConcurrentReaderHashMap.KeyIterator`
`protected class`	`ConcurrentReaderHashMap.ValueIterator`

Field Summary

Fields
Modifiers	Name	Description
`static int`	`DEFAULT_INITIAL_CAPACITY`	The default initial number of table slots for this table (32).
`static float`	`DEFAULT_LOAD_FACTOR`	The default load factor for this table (1.0).
`protected ConcurrentReaderHashMap.BarrierLock`	`barrierLock`	Lock used only for its memory effects.
`protected int`	`count`	The total number of mappings in the hash table.
`protected Set`	`entrySet`
`protected Set`	`keySet`
`protected Object`	`lastWrite`	field written to only to guarantee lock ordering.
`protected float`	`loadFactor`	The load factor for the hash table.
`protected ConcurrentReaderHashMap.Entry[]`	`table`	The hash table data.
`protected int`	`threshold`	The table is rehashed when its size exceeds this threshold.
`protected Collection`	`values`

Methods Summary

Methods
Type	Name and description
`def`	`ConcurrentReaderHashMap(int initialCapacity, float loadFactor)` Constructs a new, empty map with the specified initial capacity and the specified load factor.
`def`	`ConcurrentReaderHashMap(int initialCapacity)` Constructs a new, empty map with the specified initial capacity and default load factor.
`def`	`ConcurrentReaderHashMap()` Constructs a new, empty map with a default initial capacity and load factor.
`def`	`ConcurrentReaderHashMap(Map t)` Constructs a new map with the same mappings as the given map.
`int`	`capacity()` @return the number of slots in this table
`void`	`clear()` Removes all mappings from this map.
`Object`	`clone()` Returns a shallow copy of this `ConcurrentReaderHashMap` instance: the keys and values themselves are not cloned.
`boolean`	`contains(Object value)` Tests if some key maps into the specified value in this table.
`boolean`	`containsKey(Object key)` Tests if the specified object is a key in this table.
`boolean`	`containsValue(Object value)` Returns `true` if this map maps one or more keys to the specified value.
`Enumeration`	`elements()` Returns an enumeration of the values in this table.
`Set`	`entrySet()` Returns a collection view of the mappings contained in this map.
`protected boolean`	`eq(Object x, Object y)` Check for equality of non-null references x and y.
`protected boolean`	`findAndRemoveEntry(Map.Entry entry)` Helper method for entrySet.remove
`Object`	`get(Object key)` Returns the value to which the specified key is mapped in this table.
`protected ConcurrentReaderHashMap.Entry[]`	`getTableForReading()` Get ref to table; the reference and the cells it accesses will be at least as fresh as from last use of barrierLock
`boolean`	`isEmpty()` Returns `true` if this map contains no key-value mappings.
`Set`	`keySet()` Returns a set view of the keys contained in this map.
`Enumeration`	`keys()` Returns an enumeration of the keys in this table.
`float`	`loadFactor()` @return the load factor
`Object`	`put(Object key, Object value)` Maps the specified `key` to the specified `value` in this table.
`void`	`putAll(Map t)` Copies all of the mappings from the specified map to this one.
`protected void`	`recordModification(Object x)` Force a memory synchronization that will cause all readers to see table.
`protected void`	`rehash()` Rehashes the contents of this map into a new table with a larger capacity.
`Object`	`remove(Object key)` Removes the key (and its corresponding value) from this table.
`int`	`size()` Returns the number of key-value mappings in this map.
`protected Object`	`sput(Object key, Object value, int hash)` Continuation of put(), called only when sync lock is held and interference has been detected.
`protected Object`	`sremove(Object key, int hash)` Continuation of remove(), called only when sync lock is held and interference has been detected.
`Collection`	`values()` Returns a collection view of the values contained in this map.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractMap`	`remove, get, put, equals, toString, values, hashCode, clear, isEmpty, size, entrySet, putAll, keySet, containsKey, containsValue, wait, wait, wait, getClass, notify, notifyAll`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final int DEFAULT_INITIAL_CAPACITY
    
    The default initial number of table slots for this table (32). Used when not otherwise specified in constructor.
  - public static final float DEFAULT_LOAD_FACTOR
    
    The default load factor for this table (1.0). Used when not otherwise specified in constructor.
  - protected final ConcurrentReaderHashMap.BarrierLock barrierLock
    
    Lock used only for its memory effects.
  - protected int count
    
    The total number of mappings in the hash table.
  - protected Set entrySet
  - protected Set keySet
  - protected Object lastWrite
    
    field written to only to guarantee lock ordering.
  - protected float loadFactor
    
    The load factor for the hash table.
    serial:
  - protected ConcurrentReaderHashMap.Entry[] table
    
    The hash table data.
  - protected int threshold
    
    The table is rehashed when its size exceeds this threshold. (The value of this field is always (int)(capacity * loadFactor).)
    serial:
  - protected Collection values
- Method Detail
  - public def ConcurrentReaderHashMap(int initialCapacity, float loadFactor)
    
    Constructs a new, empty map with the specified initial capacity and the specified load factor.
    throws:
    IllegalArgumentException if the initial maximum number of elements is less than zero, or if the load factor is non-positive.
    
    Parameters:
    initialCapacity - the initial capacity The actual initial capacity is rounded to the nearest power of two.
    loadFactor - the load factor of the ConcurrentReaderHashMap
  - public def ConcurrentReaderHashMap(int initialCapacity)
    
    Constructs a new, empty map with the specified initial capacity and default load factor.
    throws:
    IllegalArgumentException if the initial maximum number of elements is less than zero.
    
    Parameters:
    initialCapacity - the initial capacity of the ConcurrentReaderHashMap.
  - public def ConcurrentReaderHashMap()
    
    Constructs a new, empty map with a default initial capacity and load factor.
  - public def ConcurrentReaderHashMap(Map t)
    
    Constructs a new map with the same mappings as the given map. The map is created with a capacity of twice the number of mappings in the given map or 16 (whichever is greater), and a default load factor.
  - public int capacity()
    
    Returns:
    the number of slots in this table
  - public void clear()
    
    Removes all mappings from this map.
  - public Object clone()
    
    Returns a shallow copy of this ConcurrentReaderHashMap instance: the keys and values themselves are not cloned.
    Returns:
    a shallow copy of this map.
  - public boolean contains(Object value)
    
    Tests if some key maps into the specified value in this table. This operation is more expensive than the containsKey method.
    Note that this method is identical in functionality to containsValue, (which is part of the Map interface in the collections framework).
    Throws:
    NullPointerException if the value is null.
    Parameters:
    value - a value to search for.
    Returns:
    true if and only if some key maps to the value argument in this table as determined by the equals method; false otherwise.
    See Also:
    containsKey(Object)
    containsValue(Object)
    Map
  - public boolean containsKey(Object key)
    
    Tests if the specified object is a key in this table.
    Throws:
    NullPointerException if the key is null.
    Parameters:
    key - possible key.
    Returns:
    true if and only if the specified object is a key in this table, as determined by the equals method; false otherwise.
    See Also:
    contains(Object)
  - public boolean containsValue(Object value)
    
    Returns true if this map maps one or more keys to the specified value. Note: This method requires a full internal traversal of the hash table, and so is much slower than method containsKey.
    Throws:
    NullPointerException if the value is null.
    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.
  - public Enumeration elements()
    
    Returns an enumeration of the values in this table. Use the Enumeration methods on the returned object to fetch the elements sequentially.
    Returns:
    an enumeration of the values in this table.
    See Also:
    Enumeration
    keys()
    values()
    Map
  - public Set entrySet()
    
    Returns a collection view of the mappings contained in this map. Each element in the returned collection is a Map.Entry. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
    Returns:
    a collection view of the mappings contained in this map.
  - protected boolean eq(Object x, Object y)
    
    Check for equality of non-null references x and y.
  - protected boolean findAndRemoveEntry(Map.Entry entry)
    
    Helper method for entrySet.remove
  - public Object get(Object key)
    
    Returns the value to which the specified key is mapped in this table.
    Throws:
    NullPointerException if the key is null.
    Parameters:
    key - a key in the table.
    Returns:
    the value to which the key is mapped in this table; null if the key is not mapped to any value in this table.
    See Also:
    put(Object, Object)
  - protected final ConcurrentReaderHashMap.Entry[] getTableForReading()
    
    Get ref to table; the reference and the cells it accesses will be at least as fresh as from last use of barrierLock
  - public boolean isEmpty()
    
    Returns true if this map contains no key-value mappings.
    Returns:
    true if this map contains no key-value mappings.
  - public Set keySet()
    
    Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
    Returns:
    a set view of the keys contained in this map.
  - public Enumeration keys()
    
    Returns an enumeration of the keys in this table.
    Returns:
    an enumeration of the keys in this table.
    See Also:
    Enumeration
    elements()
    keySet()
    Map
  - public float loadFactor()
    
    Returns:
    the load factor
  - public Object put(Object key, Object value)
    
    Maps the specified key to the specified value in this table. Neither the key nor the value can be null.
    The value can be retrieved by calling the get method with a key that is equal to the original key.
    Throws:
    NullPointerException if the key or value is null.
    Parameters:
    key - the table key.
    value - the value.
    Returns:
    the previous value of the specified key in this table, or null if it did not have one.
    See Also:
    Object.equals
    get(Object)
  - public void putAll(Map t)
    
    Copies all of the mappings from the specified map to this one. These mappings replace any mappings that this map had for any of the keys currently in the specified Map.
    Parameters:
    t - Mappings to be stored in this map.
  - protected final void recordModification(Object x)
    
    Force a memory synchronization that will cause all readers to see table. Call only when already holding main sync lock.
  - protected void rehash()
    
    Rehashes the contents of this map into a new table with a larger capacity. This method is called automatically when the number of keys in this map exceeds its capacity and load factor.
  - public Object remove(Object key)
    
    Removes the key (and its corresponding value) from this table. This method does nothing if the key is not in the table.
    Throws:
    NullPointerException if the key is null.
    Parameters:
    key - the key that needs to be removed.
    Returns:
    the value to which the key had been mapped in this table, or null if the key did not have a mapping.
  - public int size()
    
    Returns the number of key-value mappings in this map.
    Returns:
    the number of key-value mappings in this map.
  - protected Object sput(Object key, Object value, int hash)
    
    Continuation of put(), called only when sync lock is held and interference has been detected.
  - protected Object sremove(Object key, int hash)
    
    Continuation of remove(), called only when sync lock is held and interference has been detected.
  - public Collection values()
    
    Returns a collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Collection.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
    Returns:
    a collection view of the values contained in this map.

Summary:
Nested
Field
Method

| Detail:
Field
Method

[Java] Class ConcurrentReaderHashMap

Nested Class Summary

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final int DEFAULT_INITIAL_CAPACITY

public static final float DEFAULT_LOAD_FACTOR

protected final ConcurrentReaderHashMap.BarrierLock barrierLock

protected int count

protected Set entrySet

protected Set keySet

protected Object lastWrite

protected float loadFactor

protected ConcurrentReaderHashMap.Entry[] table

protected int threshold

protected Collection values

Method Detail

public def ConcurrentReaderHashMap(int initialCapacity, float loadFactor)

public def ConcurrentReaderHashMap(int initialCapacity)

public def ConcurrentReaderHashMap()

public def ConcurrentReaderHashMap(Map t)

public int capacity()

public void clear()

public Object clone()

public boolean contains(Object value)

public boolean containsKey(Object key)

public boolean containsValue(Object value)

public Enumeration elements()

public Set entrySet()

protected boolean eq(Object x, Object y)

protected boolean findAndRemoveEntry(Map.Entry entry)

public Object get(Object key)

protected final ConcurrentReaderHashMap.Entry[] getTableForReading()

public boolean isEmpty()

public Set keySet()

public Enumeration keys()

public float loadFactor()

public Object put(Object key, Object value)

public void putAll(Map t)

protected final void recordModification(Object x)

protected void rehash()

public Object remove(Object key)

public int size()

protected Object sput(Object key, Object value, int hash)

protected Object sremove(Object key, int hash)

public Collection values()