Package com.illumon.iris.db.v2

Class InstrumentedListener

java.lang.Object

com.illumon.util.referencecounting.ReferenceCounted

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

com.illumon.iris.db.v2.InstrumentedListenerBase

com.illumon.iris.db.v2.InstrumentedListener

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable, NotificationQueue.Dependency, LivenessManager, LivenessNode, LivenessReferent, Listener, ListenerBase, Serializable

Direct Known Subclasses:

BaseTable.ListenerImpl, InstrumentedListenerAdapter

public abstract class InstrumentedListener
extends InstrumentedListenerBase
implements Listener

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	InstrumentedListener.Notification	Delivers the desired update, bracketed by performance instrumentation.

Nested classes/interfaces inherited from class com.illumon.iris.db.v2.InstrumentedListenerBase

InstrumentedListenerBase.ErrorNotification, InstrumentedListenerBase.NotificationBase

Constructor Summary

Constructors

Constructor	Description
InstrumentedListener(String description)
InstrumentedListener(String description, boolean terminalListener)

Method Summary

Modifier and Type	Method	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.
AbstractIndexUpdateNotification	getNotification(Index added, Index removed, Index modified)	Creates a notification for the table changes.
WeakReference<? extends LivenessReferent>	getWeakReference()	Get a WeakReference to this referent.
void	initializeTransientFieldsForLiveness()	Package-private for Serializable sub-classes to use in readObject only.
protected void	onReferenceCountAtZero()	Callback method that will be invoked when the reference count returns to zero.
void	setInitialImage(Index initialImage)	Sets the index for the initial data.
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.

Methods inherited from class com.illumon.iris.db.v2.InstrumentedListenerBase

append, canExecute, getEntry, getErrorNotification, onFailure, onFailureInternal, onFailureInternalWithDependent, satisfied, setVerboseLogging, toString

Methods inherited from class com.illumon.iris.db.util.liveness.LivenessArtifact

manageWithCurrentScope, unmanage, unmanage

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

decrementReferenceCount, incrementReferenceCount, resetReferenceCount, 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.v2.Listener

onUpdate

Methods inherited from interface com.illumon.iris.db.v2.ListenerBase

getErrorNotification, onFailure

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

manage, tryManage

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

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

Constructor Details

InstrumentedListener

public InstrumentedListener(@Nullable String description)

InstrumentedListener

public InstrumentedListener(@Nullable String description, boolean terminalListener)

Method Details

getNotification

public AbstractIndexUpdateNotification getNotification(Index added, Index removed, Index modified)

Description copied from interface: Listener

Creates a notification for the table changes.

Specified by:

getNotification in interface Listener

Parameters:

added - rows added

removed - rows removed

modified - rows modified

Returns:

table change notification

setInitialImage

public void setInitialImage(Index initialImage)

Description copied from interface: Listener

Sets the index for the initial data.

Specified by:

setInitialImage in interface Listener

Parameters:

initialImage - initial image

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