Module swim.system

Package swim.system.lane

Class ValueLaneView<V>

java.lang.Object

swim.system.AbstractWarpRef

swim.system.AbstractTierBinding

swim.system.LaneView

swim.system.warp.WarpLaneView

swim.system.lane.ValueLaneView<V>

All Implemented Interfaces:

DownlinkFactory, Lane, ValueLane<V>, WarpRef, WarpLane, Observable<Object>, ObservableValue<V>, Inlet<V>, Outlet<V>, CellContext, TierBinding, Log

public class ValueLaneView<V>
extends WarpLaneView
implements ValueLane<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected AgentContext	agentContext
protected int	flags
protected Outlet<? extends V>	input
protected ValueLaneModel	laneBinding
protected Inlet<? super V>[]	outputs
protected Form<V>	valueForm
protected int	version

Fields inherited from class swim.system.LaneView

observers

Fields inherited from class swim.system.AbstractTierBinding

CLOSED_PHASE, CLOSED_STATE, CLOSING_STATE, FAILED_STATE, FAILING_STATE, LOADED_PHASE, LOADED_STATE, LOADING_STATE, OPENED_PHASE, OPENED_STATE, OPENING_STATE, PHASE_MASK, PHASE_SHIFT, RECOVERING_STATE, STARTED_PHASE, STARTED_STATE, STARTING_STATE, STATE_MASK, status, STATUS, STOPPING_STATE, UNLOADING_STATE

Constructor Summary

Constructors

Constructor	Description
ValueLaneView(AgentContext agentContext, Form<V> valueForm)

Method Summary

Modifier and Type	Method	Description
AgentContext	agentContext()
void	bindInput(Outlet<? extends V> input)	Connects this Inlet to an Outlet from which it will acquire its state.
void	bindOutput(Inlet<? super V> output)	Adds an output to the set of Inlets that depend on the state of this Outlet.
void	close()
ValueLaneModel	createLaneBinding()
void	decohere()
void	decohereInput()	Marks this Outlet—and all outputs that depend on the state of this Outlet—as having decoherent state.
void	decohereOutput()	Marks this Inlet—and the Streamlet to which this Inlet is attached—as having decoherent state.
ValueLaneView<V>	didCommand(DidCommand didCommand)
protected void	didDecohere()
ValueLaneView<V>	didEnter(DidEnter didEnter)
ValueLaneView<V>	didLeave(DidLeave didLeave)
protected void	didRecohere(int version)
ValueLaneView<V>	didSet(DidSet<V> didSet)
ValueLaneView<V>	didUplink(DidUplink didUplink)
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.
boolean	dispatchDidSet(Link link, V newValue, V oldValue, boolean preemptive)
Map.Entry<Boolean,V>	dispatchWillSet(Link link, V newValue, boolean preemptive)
V	get()	Returns the current state of this Outlet.
Outlet<? extends V>	input()	Returns the Outlet from which this Inlet acquires its state; returns null if this Inlet is disconnected.
boolean	isResident()
ValueLaneView<V>	isResident(boolean isResident)
boolean	isTransient()
ValueLaneView<V>	isTransient(boolean isTransient)
ValueLaneModel	laneBinding()
void	laneDidSet(V newValue, V oldValue)
V	laneWillSet(V newValue)
ValueLaneView<V>	observe(Object observer)
protected void	onDecohere()
protected void	onRecohere(int version)
Iterator<Inlet<? super V>>	outputIterator()	Returns an Iterator over the set of Inlets that depend on the state of this Outlet.
void	recohere(int version)
void	recohereInput(int version)	Updates the state of this Outlet to make it consistent with the target version.
void	recohereOutput(int version)	Updates the state of this Inlet to make it consistent with the target version.
V	set(V newValue)
void	setValueForm(Form<V> valueForm)
protected Object	typesafeObservers(Object observers)
void	unbindInput()	Disconnects this Inlet from its input Outlet, if connected.
void	unbindOutput(Inlet<? super V> output)	Removes an output from the set of Inlets that depend on the state of this Outlet.
void	unbindOutputs()	Disconnects all outputs from this Outlet by invoking Inlet.unbindInput() on each Inelt that depends on the state of this Outlet.
ValueLaneView<V>	unobserve(Object observer)
<V2> ValueLaneView<V2>	valueClass(Class<V2> valueClass)
Form<V>	valueForm()
<V2> ValueLaneView<V2>	valueForm(Form<V2> valueForm)
ValueLaneView<V>	willCommand(WillCommand willCommand)
protected void	willDecohere()
ValueLaneView<V>	willEnter(WillEnter willEnter)
ValueLaneView<V>	willLeave(WillLeave willLeave)
protected void	willRecohere(int version)
ValueLaneView<V>	willSet(WillSet<V> willSet)
ValueLaneView<V>	willUplink(WillUplink willUplink)

Methods inherited from class swim.system.warp.WarpLaneView

dispatchDidCommand, dispatchDidEnter, dispatchDidLeave, dispatchDidUplink, dispatchWillCommand, dispatchWillEnter, dispatchWillLeave, dispatchWillUplink, laneDidCommand, laneDidEnter, laneDidLeave, laneDidUplink, laneWillCommand, laneWillEnter, laneWillLeave, laneWillUplink

Methods inherited from class swim.system.LaneView

bindDownlink, bottomLane, cellAddress, closeDownlink, debug, edgeName, error, fail, hostUri, info, laneContext, laneDidFail, laneUri, meshUri, nodeUri, openDownlink, openMetaDownlink, policy, pushDown, reportDown, schedule, stage, store, tierContext, trace, unwrapLane, warn

Methods inherited from class swim.system.AbstractTierBinding

activate, awaitStart, didClose, didFail, didLoad, didOpen, didStart, didStop, didUnload, isClosed, isLoaded, isOpened, isStarted, load, open, start, stop, unload, willClose, willLoad, willOpen, willStart, willStop, willUnload

Methods inherited from class swim.system.AbstractWarpRef

command, command, command, command, command, command, command, command, command, command, command, command, command, command, command, command, downlink, downlinkHttp, downlinkList, downlinkMap, downlinkValue, downlinkWs, hostRef, hostRef, laneRef, laneRef, laneRef, laneRef, nodeRef, nodeRef, nodeRef, nodeRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface swim.api.Lane

hostUri, laneUri, nodeUri

Methods inherited from interface swim.util.Log

debug, error, fail, info, trace, warn

Methods inherited from interface swim.streamlet.Outlet

map, memoize, watch

Field Detail

agentContext

protected final AgentContext agentContext

valueForm

protected Form<V> valueForm

laneBinding

protected ValueLaneModel laneBinding

flags

protected int flags

input

protected Outlet<? extends V> input

outputs

protected Inlet<? super V>[] outputs

version

protected int version

Constructor Detail

ValueLaneView

public ValueLaneView(AgentContext agentContext,
                     Form<V> valueForm)

Method Detail

agentContext

public AgentContext agentContext()

Specified by:

agentContext in class LaneView

laneBinding

public ValueLaneModel laneBinding()

Specified by:

laneBinding in class LaneView

createLaneBinding

public ValueLaneModel createLaneBinding()

Specified by:

createLaneBinding in class LaneView

valueForm

public final Form<V> valueForm()

Specified by:

valueForm in interface ValueLane<V>

valueForm

public <V2> ValueLaneView<V2> valueForm(Form<V2> valueForm)

Specified by:

valueForm in interface ValueLane<V>

valueClass

public <V2> ValueLaneView<V2> valueClass(Class<V2> valueClass)

Specified by:

valueClass in interface ValueLane<V>

setValueForm

public void setValueForm(Form<V> valueForm)

typesafeObservers

protected Object typesafeObservers(Object observers)

isResident

public final boolean isResident()

Specified by:

isResident in interface ValueLane<V>

isResident

public ValueLaneView<V> isResident(boolean isResident)

Specified by:

isResident in interface ValueLane<V>

isTransient

public final boolean isTransient()

Specified by:

isTransient in interface ValueLane<V>

isTransient

public ValueLaneView<V> isTransient(boolean isTransient)

Specified by:

isTransient in interface ValueLane<V>

close

public void close()

Specified by:

close in interface Lane

Specified by:

close in interface TierBinding

Specified by:

close in interface WarpRef

Specified by:

close in class LaneView

observe

public ValueLaneView<V> observe(Object observer)

Specified by:

observe in interface Lane

Specified by:

observe in interface Observable<V>

Specified by:

observe in interface ObservableValue<V>

Specified by:

observe in interface ValueLane<V>

Specified by:

observe in interface WarpLane

Overrides:

observe in class WarpLaneView

unobserve

public ValueLaneView<V> unobserve(Object observer)

Specified by:

unobserve in interface Lane

Specified by:

unobserve in interface Observable<V>

Specified by:

unobserve in interface ObservableValue<V>

Specified by:

unobserve in interface ValueLane<V>

Specified by:

unobserve in interface WarpLane

Overrides:

unobserve in class WarpLaneView

willSet

public ValueLaneView<V> willSet(WillSet<V> willSet)

Specified by:

willSet in interface ObservableValue<V>

Specified by:

willSet in interface ValueLane<V>

didSet

public ValueLaneView<V> didSet(DidSet<V> didSet)

Specified by:

didSet in interface ObservableValue<V>

Specified by:

didSet in interface ValueLane<V>

willCommand

public ValueLaneView<V> willCommand(WillCommand willCommand)

Specified by:

willCommand in interface ValueLane<V>

Specified by:

willCommand in interface WarpLane

Specified by:

willCommand in class WarpLaneView

didCommand

public ValueLaneView<V> didCommand(DidCommand didCommand)

Specified by:

didCommand in interface ValueLane<V>

Specified by:

didCommand in interface WarpLane

Specified by:

didCommand in class WarpLaneView

willUplink

public ValueLaneView<V> willUplink(WillUplink willUplink)

Specified by:

willUplink in interface ValueLane<V>

Specified by:

willUplink in interface WarpLane

Specified by:

willUplink in class WarpLaneView

didUplink

public ValueLaneView<V> didUplink(DidUplink didUplink)

Specified by:

didUplink in interface ValueLane<V>

Specified by:

didUplink in interface WarpLane

Specified by:

didUplink in class WarpLaneView

willEnter

public ValueLaneView<V> willEnter(WillEnter willEnter)

Specified by:

willEnter in interface ValueLane<V>

Specified by:

willEnter in interface WarpLane

Specified by:

willEnter in class WarpLaneView

didEnter

public ValueLaneView<V> didEnter(DidEnter didEnter)

Specified by:

didEnter in interface ValueLane<V>

Specified by:

didEnter in interface WarpLane

Specified by:

didEnter in class WarpLaneView

willLeave

public ValueLaneView<V> willLeave(WillLeave willLeave)

Specified by:

willLeave in interface ValueLane<V>

Specified by:

willLeave in interface WarpLane

Specified by:

willLeave in class WarpLaneView

didLeave

public ValueLaneView<V> didLeave(DidLeave didLeave)

Specified by:

didLeave in interface ValueLane<V>

Specified by:

didLeave in interface WarpLane

Specified by:

didLeave in class WarpLaneView

dispatchWillSet

public Map.Entry<Boolean,V> dispatchWillSet(Link link,
                                                  V newValue,
                                                  boolean preemptive)

dispatchDidSet

public boolean dispatchDidSet(Link link,
                              V newValue,
                              V oldValue,
                              boolean preemptive)

laneWillSet

public V laneWillSet(V newValue)

laneDidSet

public void laneDidSet(V newValue,
                       V oldValue)

get

public V get()

Description copied from interface: Outlet

Returns the current state of this Outlet.

Specified by:

get in interface ObservableValue<V>

Specified by:

get in interface Outlet<V>

Specified by:

get in interface ValueLane<V>

set

public V set(V newValue)

Specified by:

set in interface ObservableValue<V>

Specified by:

set in interface ValueLane<V>

input

public Outlet<? extends V> 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<V>

bindInput

public void bindInput(Outlet<? extends V> 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<V>

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

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

Specified by:

disconnectInputs in interface Outlet<V>

outputIterator

public Iterator<Inlet<? super V>> outputIterator()

Description copied from interface: Outlet

Returns an Iterator over the set of Inlets that depend on the state of this Outlet.

Specified by:

outputIterator in interface Outlet<V>

bindOutput

public void bindOutput(Inlet<? super V> output)

Description copied from interface: Outlet

Adds an output to the set of Inlets that depend on the state of this Outlet. The output will be decohered when the state of this Outlet is decohered, and recohered when this Outlet is recohered.

Specified by:

bindOutput in interface Outlet<V>

unbindOutput

public void unbindOutput(Inlet<? super V> output)

Description copied from interface: Outlet

Removes an output from the set of Inlets that depend on the state of this Outlet.

Specified by:

unbindOutput in interface Outlet<V>

unbindOutputs

public void unbindOutputs()

Description copied from interface: Outlet

Disconnects all outputs from this Outlet by invoking Inlet.unbindInput() on each Inelt that depends on the state of this Outlet.

Specified by:

unbindOutputs in interface Outlet<V>

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

Specified by:

disconnectOutputs in interface Outlet<V>

decohereOutput

public void decohereOutput()

Description copied from interface: Inlet

Marks this Inlet—and the Streamlet to which this Inlet is attached—as having decoherent state. Decohering an Inlet will recursively decohere all streamlets that transitively depend on the state of this Inlet. Decohering an Inlet does not cause its state to be recomputed. A subsequent Inlet.recohereOutput(int) call will eventually make the state of the Inlet coherent again.

Specified by:

decohereOutput in interface Inlet<V>

decohereInput

public void decohereInput()

Description copied from interface: Outlet

Marks this Outlet—and all outputs that depend on the state of this Outlet—as having decoherent state.

Specified by:

decohereInput in interface Outlet<V>

decohere

public void decohere()

recohereOutput

public void recohereOutput(int version)

Description copied from interface: Inlet

Updates the state of this Inlet to make it consistent with the target version. The Inlet only needs to update if its current version differs from the target version. To update its state, the Inlet first invokes Outlet.recohereInput(int) on its input, to ensure that its input is coherent. It then invokes Streamlet.recohere(int) on the Streamlet to which it's attached, causing the Streamlet to make its own state coherent again.

Specified by:

recohereOutput in interface Inlet<V>

recohereInput

public void recohereInput(int version)

Description copied from interface: Outlet

Updates the state of this Outlet to make it consistent with the target version. The Outlet only needs to update if its current version differs from the target version. To update its state, the Outlet first invokes Streamlet.recohere(int) on the Streamlet to which it's attached. It then invokes Inlet.recohereOutput(int) on each of its dependent outputs.

Specified by:

recohereInput in interface Outlet<V>

recohere

public void recohere(int version)

willDecohere

protected void willDecohere()

onDecohere

protected void onDecohere()

didDecohere

protected void didDecohere()

willRecohere

protected void willRecohere(int version)

onRecohere

protected void onRecohere(int version)

didRecohere

protected void didRecohere(int version)