WeakKey (Apache Axis2 - Metadata 1.6.3 API)

java.lang.Object
- java.lang.ref.Reference<T>
- - java.lang.ref.WeakReference<java.lang.Object>
  - - org.apache.axis2.jaxws.util.WeakKey

```
public class WeakKey
extends java.lang.ref.WeakReference<java.lang.Object>
```
Implement a WeakReference key to be used in a collection. Being a WeakReference, it will not prevent the key from being Garbage Collected. The key can only be created with a reference queue so that users of this class provide cleanup logic which uses the items in the reference queue to cleanup entries in the collection. Note that the ReferenceQueue will contain the WeakKey instance that assocaited with the referent that was GC'd. So, the elements on the ReferenceQueue can be used to directly access and remove entries in the collection it is a key for. For example, one could do something like the following in cleanup logic: Object gcKey = null; while ((gcKey = q.poll()) != null) { WeakKey wk = (WeakKey) gcKey; removedEntry = collection.remove(wk); ... }

Constructors
Constructor and Description
`WeakKey(java.lang.Object key, java.lang.ref.ReferenceQueue q)`

Methods
Modifier and Type	Method and Description
`static WeakKey`	`comparisonKey(java.lang.Object checkKey)` Return an instance of WeakKey that can be used in comparsion operations.
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`

Methods inherited from class java.lang.ref.Reference
clear, enqueue, get, isEnqueued

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Class WeakKey