Package io.deephaven.engine.updategraph

Class AbstractNotification

java.lang.Object

io.deephaven.engine.updategraph.AbstractNotification

All Implemented Interfaces:

LogOutputAppendable, NotificationQueue.Notification, IntrusiveDoublyLinkedNode<NotificationQueue.Notification>, Runnable

Direct Known Subclasses:

EmptyNotification, InstrumentedTableListenerBase.ErrorNotification, InstrumentedTableListenerBase.NotificationBase, NotificationAdapter, TerminalNotification, WaitNotification

public abstract class AbstractNotification
extends Object
implements NotificationQueue.Notification

Common base class for notifications.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.util.datastructures.linked.IntrusiveDoublyLinkedNode

IntrusiveDoublyLinkedNode.Adapter<NODE_TYPE extends IntrusiveDoublyLinkedNode<NODE_TYPE>>, IntrusiveDoublyLinkedNode.Impl<NODE_TYPE extends IntrusiveDoublyLinkedNode.Impl<NODE_TYPE>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNotification(boolean isTerminal)

Method Summary

Modifier and Type	Method	Description
LogOutput	append(LogOutput output)
NotificationQueue.Notification	getNext()	Get the next node after this node.
NotificationQueue.Notification	getPrev()	Get the previous node before this node.
boolean	isTerminal()	Terminal notifications guarantee that they will not queue additional notifications or mutate data structures that should result in additional notifications.
boolean	mustExecuteWithUpdateGraphLock()	If a terminal notification must be executed serially (typically under an UpdateGraph's exclusive lock), it must override this method so that the notification is not executed concurrently with other notifications.
void	setNext(NotificationQueue.Notification other)	Set this node's next node.
void	setPrev(NotificationQueue.Notification other)	Set this node's previous node.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.updategraph.NotificationQueue.Notification

canExecute

Methods inherited from interface java.lang.Runnable

run

Constructor Details

AbstractNotification

protected AbstractNotification(boolean isTerminal)

Method Details

mustExecuteWithUpdateGraphLock

public boolean mustExecuteWithUpdateGraphLock()

Description copied from interface: NotificationQueue.Notification

If a terminal notification must be executed serially (typically under an UpdateGraph's exclusive lock), it must override this method so that the notification is not executed concurrently with other notifications.

It is an error to return true if this notification is not terminal

Specified by:

mustExecuteWithUpdateGraphLock in interface NotificationQueue.Notification

Returns:

true if this notification must be executed serially

toString

public String toString()

Overrides:

toString in class Object

append

public LogOutput append(LogOutput output)

Specified by:

append in interface LogOutputAppendable

isTerminal

public boolean isTerminal()

Description copied from interface: NotificationQueue.Notification

Terminal notifications guarantee that they will not queue additional notifications or mutate data structures that should result in additional notifications. They are in turn guaranteed to be called after all non-terminal notifications for a given cycle through the notification queue.

Specified by:

isTerminal in interface NotificationQueue.Notification

Returns:

True iff this notification is terminal.

getNext

@NotNull
public NotificationQueue.Notification getNext()

Description copied from interface: IntrusiveDoublyLinkedNode

Get the next node after this node.

Specified by:

getNext in interface IntrusiveDoublyLinkedNode<NotificationQueue.Notification>

Returns:

This node's next node

setNext

public void setNext(@NotNull
 NotificationQueue.Notification other)

Description copied from interface: IntrusiveDoublyLinkedNode

Set this node's next node.

Specified by:

setNext in interface IntrusiveDoublyLinkedNode<NotificationQueue.Notification>

Parameters:

other - This node's new next node

getPrev

@NotNull
public NotificationQueue.Notification getPrev()

Description copied from interface: IntrusiveDoublyLinkedNode

Get the previous node before this node.

Specified by:

getPrev in interface IntrusiveDoublyLinkedNode<NotificationQueue.Notification>

Returns:

This node's previous node

setPrev

public void setPrev(@NotNull
 NotificationQueue.Notification other)

Description copied from interface: IntrusiveDoublyLinkedNode

Set this node's previous node.

Specified by:

setPrev in interface IntrusiveDoublyLinkedNode<NotificationQueue.Notification>

Parameters:

other - This node's new previous node