com.illumon.iris.db.util.liveness

Class LivenessArtifact

java.lang.Object

com.illumon.util.referencecounting.ReferenceCounted

com.illumon.iris.db.util.liveness.LivenessArtifact

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, Serializable

Direct Known Subclasses:

InstrumentedListener, LiveTableRefreshCombiner, ReverseLookupListener

public class LivenessArtifact
extends ReferenceCounted
implements Serializable

A query engine artifact that is also a LivenessNode. These referents are added to the current top of the LivenessScopeStack on construction or deserialization.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LivenessArtifact()

Method Summary

Modifier and Type	Method and Description
protected void	destroy() Attempt to release (destructively when necessary) resources held by this object.
void	dropReference() Drop a previously-retained reference to this referent.
WeakReference<? extends LivenessReferent>	getWeakReference() Get a WeakReference to this referent.
void	initializeTransientFieldsForLiveness() Package-private for Serializable sub-classes to use in readObject only.
void	manageWithCurrentScope() Add this artifact to the current manager provided by the LivenessScopeStack.
protected void	onReferenceCountAtZero() Callback method that will be invoked when the reference count returns to zero.
boolean	tryManage(LivenessReferent referent) Attempt to add the specified referent to this manager.
boolean	tryRetainReference() If this referent is "live", behave as LivenessReferent.retainReference() and return true.
protected void	unmanage(Collection<? extends LivenessReferent> referents) For each referent in referents, if this manages referent one or more times, drop one such reference.
protected void	unmanage(LivenessReferent referent) If this manages referent one or more times, drop one such reference.

Methods inherited from class com.illumon.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, 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 com.illumon.iris.db.util.liveness.LivenessReferent

getReferentDescription, retainReference

Methods inherited from interface com.illumon.iris.db.util.liveness.LivenessManager

manage

Constructor Detail

LivenessArtifact

protected LivenessArtifact()

Method Detail

manageWithCurrentScope

public final void manageWithCurrentScope()

Add this artifact to the current manager provided by the LivenessScopeStack.

unmanage

protected final void unmanage(@NotNull
                              LivenessReferent referent)

If this manages referent one or more times, drop one such reference.

Parameters:

referent - The referent to drop

unmanage

protected final void unmanage(@NotNull
                              Collection<? extends LivenessReferent> referents)

For each referent in referents, if this manages referent one or more times, drop one such reference.

Parameters:

referents - The referents to drop

initializeTransientFieldsForLiveness

@VisibleForTesting
public final void initializeTransientFieldsForLiveness()

Package-private for Serializable sub-classes to use in readObject only. Public to allow unit tests in another package to work around mock issues where the constructor is never invoked.

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

tryManage

public final boolean tryManage(@NotNull
                               LivenessReferent referent)

Description copied from interface: LivenessManager

Attempt to add the specified referent to this manager.

Specified by:

tryManage in interface LivenessManager

Parameters:

referent - The referent to add

Returns:

Whether the referent was in fact added

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 final 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