com.illumon.iris.db.util.liveness

Interface LivenessReferent

All Known Subinterfaces:

DynamicTable, Listener, LivenessNode, Table, TableMap

All Known Implementing Classes:

InstrumentedListener, InstrumentedListenerAdapter, LivenessArtifact, LivenessScope, LiveTableRefreshCombiner, ReverseLookupListener

public interface LivenessReferent

Interface for objects that continue to "live" while retained by a LivenessManager.

Method Summary

Modifier and Type	Method and Description
void	dropReference() Drop a previously-retained reference to this referent.
default String	getReferentDescription() Get a name that is suitable for uniquely identifying this LivenessReferent in debug and error messages.
WeakReference<? extends LivenessReferent>	getWeakReference() Get a WeakReference to this referent.
default void	retainReference() Record a reference to this LivenessReferent, which must later be dropped.
boolean	tryRetainReference() If this referent is "live", behave as LivenessReferent.retainReference() and return true.

Method Detail

retainReference

default void retainReference()

Record a reference to this LivenessReferent, which must later be dropped.

Throws:

LivenessStateException - If this referent is no longer "live"

tryRetainReference

boolean tryRetainReference()

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

Returns:

True if this referent was retained, false otherwise

dropReference

void dropReference()

Drop a previously-retained reference to this referent.

getWeakReference

WeakReference<? extends LivenessReferent> getWeakReference()

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

Returns:

A new or cached reference to this referent

getReferentDescription

default String getReferentDescription()

Get a name that is suitable for uniquely identifying this LivenessReferent in debug and error messages. This is usually not the same as Object.toString().

Returns:

A unique name for this referent for debugging and error message purposes