Package io.deephaven.engine.liveness

Class ReferenceCountedLivenessReferent

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

All Implemented Interfaces:

LogOutputAppendable, LivenessReferent

Direct Known Subclasses:

LivePyObjectWrapper, ReferenceCountedLivenessNode

public class ReferenceCountedLivenessReferent
extends ReferenceCounted
implements LivenessReferent

LivenessReferent implementation that relies on reference counting to determine its liveness.

Constructor Summary

Constructors

Constructor	Description
ReferenceCountedLivenessReferent()

Method Summary

Modifier and Type	Method	Description
protected void	destroy()	Attempt to release (destructively when necessary) resources held by this object.
final void	dropReference()	Drop a previously-retained reference to this referent.
WeakReference<? extends LivenessReferent>	getWeakReference()	Get a WeakReference to this referent.
protected void	onReferenceCountAtZero()	Callback method that will be invoked when the reference count returns to zero.
final boolean	tryRetainReference()	If this referent is "live", behave as LivenessReferent.retainReference() and return true.

Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent

getReferentDescription, retainReference

Constructor Details

ReferenceCountedLivenessReferent

public ReferenceCountedLivenessReferent()

Method Details

tryRetainReference

public final boolean tryRetainReference()

Description copied from interface: LivenessReferent

If this referent is "live", behave as LivenessReferent.retainReference() and return true. Otherwise, returns false rather than throwing an exception.

Specified by:

tryRetainReference in interface LivenessReferent

Returns:

True if this referent was retained, false otherwise

dropReference

public final void dropReference()

Description copied from interface: LivenessReferent

Drop a previously-retained reference to this referent.

Specified by:

dropReference in interface LivenessReferent

getWeakReference

public WeakReference<? extends LivenessReferent> getWeakReference()

Description copied from interface: LivenessReferent

Get a WeakReference to this referent. This may be cached, or newly created.

Specified by:

getWeakReference in interface LivenessReferent

Returns:

A new or cached reference to this referent

destroy

protected void destroy()

Attempt to release (destructively when necessary) resources held by this object. This may render the object unusable for subsequent operations. Implementations should be sure to call super.destroy().

This is intended to only ever be used as a side effect of decreasing the reference count to 0.

onReferenceCountAtZero

protected void onReferenceCountAtZero()

Description copied from class: ReferenceCounted

Callback method that will be invoked when the reference count returns to zero.

Specified by:

onReferenceCountAtZero in class ReferenceCounted