org.hypergraphdb.handle

Class PhantomHandle

java.lang.Object

java.lang.ref.Reference<T>

java.lang.ref.PhantomReference<Object>

org.hypergraphdb.handle.PhantomHandle

All Implemented Interfaces:

Comparable<HGHandle>, HGLiveHandle, HGHandle

Direct Known Subclasses:

PhantomManagedHandle

public class PhantomHandle
extends PhantomReference<Object>
implements HGLiveHandle, Comparable<HGHandle>

An implementation of a live handle that tracks garbage collection activity by extending PhantomReference.

Author:

Borislav Iordanov

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadLocal<Boolean>	returnEnqueued This is for internal use ONLY.

Constructor Summary

Constructors

Constructor and Description
PhantomHandle(Object ref, HGPersistentHandle persistentHandle, byte flags, ReferenceQueue<Object> refQueue)

Method Summary

Methods

Modifier and Type	Method and Description
void	accessed()
int	compareTo(HGHandle h)
boolean	equals(Object other)
Object	fetchRef() A getter of the referent that uses reflection to access the field directly.
byte	getFlags()
HGPersistentHandle	getPersistent()
Object	getRef()
int	hashCode()
void	storeRef(Object ref) A setter of the referent.
String	toString()

Methods inherited from class java.lang.ref.PhantomReference

get

Methods inherited from class java.lang.ref.Reference

clear, enqueue, isEnqueued

Methods inherited from class java.lang.Object

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

Field Detail

returnEnqueued

public static ThreadLocal<Boolean> returnEnqueued

This is for internal use ONLY.

See comments in 'getRef' for information about this variable.

Constructor Detail

PhantomHandle

public PhantomHandle(Object ref,
             HGPersistentHandle persistentHandle,
             byte flags,
             ReferenceQueue<Object> refQueue)

Method Detail

getFlags

public byte getFlags()

Specified by:

getFlags in interface HGLiveHandle

getPersistent

public HGPersistentHandle getPersistent()

Specified by:

getPersistent in interface HGHandle

fetchRef

public Object fetchRef()

A getter of the referent that uses reflection to access the field directly. Thus, the field is available even after it's finalized. Therefore, this method should only be called if it doesn't result in the referent becoming strongly reachable again.

storeRef

public void storeRef(Object ref)

A setter of the referent. This setter will block the current Thread while the reference is being enqueued by the grabage collector.

Parameters:

ref -

getRef

public Object getRef()

Specified by:

getRef in interface HGLiveHandle

accessed

public void accessed()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(HGHandle h)

Specified by:

compareTo in interface Comparable<HGHandle>