Module swim.streamlet

Package swim.streamlet

Class AbstractInlet<I>

java.lang.Object

swim.streamlet.AbstractInlet<I>

All Implemented Interfaces:

Inlet<I>

Direct Known Subclasses:

OutletInlet, RecordFieldUpdater, StreamletInlet, ValueOutput, WatchValueOperator

public abstract class AbstractInlet<I>
extends Object
implements Inlet<I>

Field Summary

Fields

Modifier and Type	Field	Description
protected Outlet<? extends I>	input
protected int	version

Constructor Summary

Constructors

Constructor	Description
AbstractInlet()

Method Summary

Modifier and Type	Method	Description
void	bindInput(Outlet<? extends I> input)	Connects this Inlet to an Outlet from which it will acquire its state.
protected void	didInvalidateOutput()
protected void	didReconcileOutput(int version)
void	disconnectInputs()	Disconnects all Inlets dominated by this Inlet in the dataflow dependency graph.
void	disconnectOutputs()	Disconnects all Outlets dominated by this Inlet in the dataflow graph.
Outlet<? extends I>	input()	Returns the Outlet from which this Inlet acquires its state; returns null if this Inlet is disconnected.
void	invalidateOutput()	Marks this Inlet—and the Streamlet to which this Inlet is attached—as having stale state.
protected void	onInvalidateOutput()
protected void	onReconcileOutput(int version)
void	reconcileOutput(int version)	Reconciles the state of this Inlet, if the version of this Inlet's state differs from the target version.
void	unbindInput()	Disconnects this Inlet from its input Outlet, if connected.
protected void	willInvalidateOutput()
protected void	willReconcileOutput(int version)

Methods inherited from class java.lang.Object

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

Field Detail

input

protected Outlet<? extends I> input

version

protected int version

Constructor Detail

AbstractInlet

public AbstractInlet()

Method Detail

input

public Outlet<? extends I> input()

Description copied from interface: Inlet

Returns the Outlet from which this Inlet acquires its state; returns null if this Inlet is disconnected.

Specified by:

input in interface Inlet<I>

bindInput

public void bindInput(Outlet<? extends I> input)

Description copied from interface: Inlet

Connects this Inlet to an Outlet from which it will acquire its state. If this Inlet is already connected, it will first disconnect from its existing input. Then, after updating its input property, the Inlet will invoke Outlet.bindOutput(Inlet) on its new input.

Specified by:

bindInput in interface Inlet<I>

unbindInput

public void unbindInput()

Description copied from interface: Inlet

Disconnects this Inlet from its input Outlet, if connected. After setting its input property to null, the Inlet will invoke Outlet.unbindOutput(Inlet) on its old input, if defined.

Specified by:

unbindInput in interface Inlet<I>

disconnectInputs

public void disconnectInputs()

Description copied from interface: Inlet

Disconnects all Inlets dominated by this Inlet in the dataflow dependency graph. Used to recursively clean up chains of combinators terminating at this Inlet.

Specified by:

disconnectInputs in interface Inlet<I>

disconnectOutputs

public void disconnectOutputs()

Description copied from interface: Inlet

Disconnects all Outlets dominated by this Inlet in the dataflow graph. Used to recursively clean up chains of combinators passing through this Inlet.

Specified by:

disconnectOutputs in interface Inlet<I>

invalidateOutput

public void invalidateOutput()

Description copied from interface: Inlet

Marks this Inlet—and the Streamlet to which this Inlet is attached—as having stale state. Invalidating an Inlet will recursively invalidate all streamlets that transitively depend on the state of this Inlet. Invalidating an Inlet does not cause its state to be recomputed. A subsequent Inlet.reconcileOutput(int) call will reconcile the state of the Inlet.

Specified by:

invalidateOutput in interface Inlet<I>

reconcileOutput

public void reconcileOutput(int version)

Description copied from interface: Inlet

Reconciles the state of this Inlet, if the version of this Inlet's state differs from the target version. To reconcile its state, the Inlet first invokes Outlet.reconcileInput(int) on its input, to ensure that its input is up-to-date. It then invokes Streamlet.reconcile(int) on the Streamlet to which it's attached, causing the Streamlet to reconcile its own state.

Specified by:

reconcileOutput in interface Inlet<I>

willInvalidateOutput

protected void willInvalidateOutput()

onInvalidateOutput

protected void onInvalidateOutput()

didInvalidateOutput

protected void didInvalidateOutput()

willReconcileOutput

protected void willReconcileOutput(int version)

onReconcileOutput

protected void onReconcileOutput(int version)

didReconcileOutput

protected void didReconcileOutput(int version)