Package io.deephaven.engine.liveness

Class LivenessScope

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.engine.liveness.LivenessScope

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, ReleasableLivenessManager

Direct Known Subclasses:

AbstractScriptSession.ScriptSessionQueryScope

public class LivenessScope
extends ReferenceCountedLivenessNode
implements ReleasableLivenessManager

LivenessNode implementation for providing external scope to one or more LivenessReferents.

Constructor Summary

Constructors

Constructor	Description
LivenessScope()	Construct a new scope, which must be release()d in order to release any subsequently added LivenessReferents.
LivenessScope(boolean enforceStrongReachability)	Construct a new scope, which must be release()d in order to release any subsequently added LivenessReferents.

Method Summary

Modifier and Type	Method	Description
final void	release()	Release all referents previously added to this scope in its capacity as a LivenessManager, unless other references to this scope are retained in its capacity as a LivenessReferent.
final void	transferTo(@NotNull LivenessManager other)	Transfer all retained LivenessReferents from this LivenessScope to a compatible LivenessManager.

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessNode

getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryUnmanage, tryUnmanage

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

destroy, dropReference, tryRetainReference

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.LivenessManager

manage, tryManage

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

unmanage, unmanage

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

dropReference, getReferentDescription, retainReference, tryRetainReference

Constructor Details

LivenessScope

public LivenessScope()

Construct a new scope, which must be release()d in order to release any subsequently added LivenessReferents. Will only enforce weak reachability on its LivenessManager.manage(LivenessReferent)ed referents.

LivenessScope

public LivenessScope(boolean enforceStrongReachability)

Construct a new scope, which must be release()d in order to release any subsequently added LivenessReferents.

Parameters:

enforceStrongReachability - Whether this LivenessScope should maintain strong references to its LivenessManager.manage(LivenessReferent)ed referents

Method Details

transferTo

public final void transferTo(@NotNull
 @NotNull LivenessManager other)

Transfer all retained LivenessReferents from this LivenessScope to a compatible LivenessManager. Transfer support compatibility is implementation defined.

Parameters:

other - The other LivenessManager

release

public final void release()

Release all referents previously added to this scope in its capacity as a LivenessManager, unless other references to this scope are retained in its capacity as a LivenessReferent.

Specified by:

release in interface ReleasableLivenessManager