com.github.dm.jrt.channel

Interface ResultChannel<OUT>

Type Parameters:

OUT - the output data type.

All Superinterfaces:

Channel, Channel.InputChannel<OUT>

public interface ResultChannel<OUT>
extends Channel.InputChannel<OUT>

Interface defining a result channel, that is the channel used by the routine invocation to publish the results into the output channel.

Created by davide-maestroni on 09/15/2014.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.dm.jrt.channel.Channel

Channel.InputChannel<IN>, Channel.OutputChannel<OUT>

Method Summary

Methods

Modifier and Type	Method and Description
ResultChannel<OUT>	after(long delay, TimeUnit timeUnit) Tells the channel to delay the transfer of data of the specified time duration. Note that an abortion command will be delayed as well.
ResultChannel<OUT>	after(TimeDuration delay) Tells the channel to delay the transfer of data of the specified time duration. Note that an abortion command will be delayed as well.
ResultChannel<OUT>	now() Tells the channel to not delay the transfer of data.
ResultChannel<OUT>	orderByCall() Tells the channel to sort the passed input data based on the order of the calls to the pass methods.
ResultChannel<OUT>	orderByChance() Tells the channel to avoid sorting the passed input in any particular order.
ResultChannel<OUT>	orderByDelay() Tells the channel to sort the passed input data based on the specific delay. Note that only the inputs passed with a 0 delay will be delivered in the same order as they are passed to the channel, while the others will be delivered as soon as the dedicated runner handles the specific execution.
ResultChannel<OUT>	pass(Channel.OutputChannel<? extends OUT> channel) Passes the data returned by the specified channel to this one.
ResultChannel<OUT>	pass(Iterable<? extends OUT> outputs) Passes the data returned by the specified iterable to this channel.
ResultChannel<OUT>	pass(OUT... outputs) Passes the specified input data to this channel.
ResultChannel<OUT>	pass(OUT output) Passes the specified input to this channel.

Methods inherited from interface com.github.dm.jrt.channel.Channel

abort, abort, isEmpty, isOpen

Method Detail

after

@NotNull
ResultChannel<OUT> after(@NotNull
                               TimeDuration delay)

Tells the channel to delay the transfer of data of the specified time duration.
Note that an abortion command will be delayed as well. Note, however, that a delayed abortion will not prevent the invocation from completing, as input data do.

Specified by:

after in interface Channel.InputChannel<OUT>

Parameters:

delay - the delay.

Returns:

this channel.

after

@NotNull
ResultChannel<OUT> after(long delay,
                               @NotNull
                               TimeUnit timeUnit)

Tells the channel to delay the transfer of data of the specified time duration.
Note that an abortion command will be delayed as well. Note, however, that a delayed abortion will not prevent the invocation from completing, as input data do.

Specified by:

after in interface Channel.InputChannel<OUT>

Parameters:

delay - the delay value.

timeUnit - the delay time unit.

Returns:

this channel.

now

@NotNull
ResultChannel<OUT> now()

Tells the channel to not delay the transfer of data.

Specified by:

now in interface Channel.InputChannel<OUT>

Returns:

this channel.

orderByCall

@NotNull
ResultChannel<OUT> orderByCall()

Tells the channel to sort the passed input data based on the order of the calls to the pass methods.

By default no particular order is applied.

Specified by:

orderByCall in interface Channel.InputChannel<OUT>

Returns:

this channel.

See Also:

Channel.InputChannel.orderByChance(), Channel.InputChannel.orderByDelay()

orderByChance

@NotNull
ResultChannel<OUT> orderByChance()

Tells the channel to avoid sorting the passed input in any particular order.

This is the default behavior.

Specified by:

orderByChance in interface Channel.InputChannel<OUT>

Returns:

this channel.

See Also:

Channel.InputChannel.orderByCall(), Channel.InputChannel.orderByDelay()

orderByDelay

@NotNull
ResultChannel<OUT> orderByDelay()

Tells the channel to sort the passed input data based on the specific delay.
Note that only the inputs passed with a 0 delay will be delivered in the same order as they are passed to the channel, while the others will be delivered as soon as the dedicated runner handles the specific execution.

By default no particular order is applied.

Specified by:

orderByDelay in interface Channel.InputChannel<OUT>

Returns:

this channel.

See Also:

Channel.InputChannel.orderByCall(), Channel.InputChannel.orderByChance()

pass

@NotNull
ResultChannel<OUT> pass(@Nullable
                              Channel.OutputChannel<? extends OUT> channel)

Passes the data returned by the specified channel to this one.

Note that the output channel will be bound as a result of the call, thus effectively preventing any other consumer from getting data from it.

Specified by:

pass in interface Channel.InputChannel<OUT>

Parameters:

channel - the output channel.

Returns:

this channel.

pass

@NotNull
ResultChannel<OUT> pass(@Nullable
                              Iterable<? extends OUT> outputs)

Passes the data returned by the specified iterable to this channel.

Specified by:

pass in interface Channel.InputChannel<OUT>

Parameters:

outputs - the iterable returning the input data.

Returns:

this channel.

pass

@NotNull
ResultChannel<OUT> pass(@Nullable
                              OUT output)

Passes the specified input to this channel.

Specified by:

pass in interface Channel.InputChannel<OUT>

Parameters:

output - the input.

Returns:

this channel.

pass

@NotNull
ResultChannel<OUT> pass(@Nullable
                              OUT... outputs)

Passes the specified input data to this channel.

Specified by:

pass in interface Channel.InputChannel<OUT>

Parameters:

outputs - the input data.

Returns:

this channel.