com.robopupu.api.graph.nodes

Class ThreadNode<IN,OUT>

java.lang.Object

com.robopupu.api.graph.Node<IN,OUT>

com.robopupu.api.graph.nodes.ThreadNode<IN,OUT>

Type Parameters:

IN - The type of input value.

OUT - The type of output value.

All Implemented Interfaces:

InputNode<IN>, OutputNode<OUT>

public class ThreadNode<IN,OUT>
extends Node<IN,OUT>

ThreadNode implements a Node that can be used to transfer execution to a worker Thread or to main Thread.

Field Summary

Fields inherited from class com.robopupu.api.graph.Node

graph, inputNodes

Constructor Summary

Constructors

Constructor and Description
ThreadNode() Constructs a new instance of ThreadNode.
ThreadNode(boolean executeInMainThread) Constructs a new instance of ThreadNode for transferring the execution to main or background Thread depending on the given boolean flag.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the worker Thread.
void	doOnReset() Invoked by InputNode.onCompleted(OutputNode).
void	emitOutput() Invoked to emit available output value(s) from this OutputNode.
protected void	emitOutput(OUT output) Invoked to emit the given output to attached InputNodes, if any.
protected OUT	processInput(OutputNode<IN> outputNode, IN input) Invoked by InputNode.onInput(OutputNode, Object) when the given input Object has been received from the OutputNode that emitted it.

Methods inherited from class com.robopupu.api.graph.Node

action, action, addInputNode, attach, begin, begin, beginTimer, beginTimer, buffer, completed, concat, concatStrings, count, createErrorMessage, detach, dispatchError, dispatchReset, distinct, doOnCompleted, doOnError, doOnInput, filter, first, first, getGraph, hasInputNodes, isErrorReceived, last, last, map, merge, nth, observer, observer, onAttached, onCompleted, onDetached, onError, onInput, onReset, removeInputNode, repeat, reverse, setErrorReceived, setGraph, skip, skipWhile, start, string, sum, take, timer, timer, toBoolean, toByte, toChar, toDouble, toFloat, toInt, toLong, toMain, toShort, toWorker, whenClicked, whenTextChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadNode

public ThreadNode()

Constructs a new instance of ThreadNode.

ThreadNode

public ThreadNode(boolean executeInMainThread)

Constructs a new instance of ThreadNode for transferring the execution to main or background Thread depending on the given boolean flag.

Parameters:

executeInMainThread - A boolean flag.

Method Detail

cancel

public void cancel()

Cancels the worker Thread.

emitOutput

public void emitOutput()

Description copied from interface: OutputNode

Invoked to emit available output value(s) from this OutputNode.

Specified by:

emitOutput in interface OutputNode<OUT>

Overrides:

emitOutput in class Node<IN,OUT>

processInput

protected OUT processInput(OutputNode<IN> outputNode,
                           IN input)

Description copied from class: Node

Invoked by InputNode.onInput(OutputNode, Object) when the given input Object has been received from the OutputNode that emitted it.

Overrides:

processInput in class Node<IN,OUT>

Parameters:

outputNode - An OutputNode that emitted the input.

input - The input Object.

emitOutput

protected void emitOutput(OUT output)

Description copied from class: Node

Invoked to emit the given output to attached InputNodes, if any.

Overrides:

emitOutput in class Node<IN,OUT>

Parameters:

output - The outbut Object.

doOnReset

public void doOnReset()

Description copied from class: Node

Invoked by InputNode.onCompleted(OutputNode). This method can be overridden in subclasses for hooking on the reset events.

Overrides:

doOnReset in class Node<IN,OUT>