Module com.softwaremill.jox

Package com.softwaremill.jox

Class CollectSource<V,T>

java.lang.Object

com.softwaremill.jox.CollectSource<V,T>

All Implemented Interfaces:

CloseableChannel, Source<T>

public class CollectSource<V,T>
extends Object
implements Source<T>

Constructor Summary

Constructors

Constructor	Description
CollectSource(Source<V> original, Function<V,T> f)	A view on the original source, which transforms the received values using the provided function f.

Method Summary

Modifier and Type	Method	Description
ChannelClosed	closedForReceive()
ChannelClosed	closedForSend()
void	done()	Close the channel, indicating that no more elements will be sent.
Object	doneOrClosed()	Close the channel, indicating that no more elements will be sent.
void	error(Throwable reason)	Close the channel, indicating an error.
Object	errorOrClosed(Throwable reason)	Close the channel, indicating an error.
T	receive()	Receive a value from the channel.
SelectClause<T>	receiveClause()	Create a clause which can be used in Select.select(SelectClause[]).
<U> SelectClause<U>	receiveClause(Function<T,U> callback)	Create a clause which can be used in Select.select(SelectClause[]).
Object	receiveOrClosed()	Receive a value from the channel.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.softwaremill.jox.CloseableChannel

isClosedForReceive, isClosedForSend

Methods inherited from interface com.softwaremill.jox.Source

collectAsView, filterAsView, forEach, toList

Constructor Details

CollectSource

public CollectSource(Source<V> original,
 Function<V,T> f)

A view on the original source, which transforms the received values using the provided function f. If f returns null, the value will be skipped, and another value will be received.

The same logic applies to receive clauses created using this source, which can be used in Select.select(SelectClause[]).

Parameters:

original - The original source, from which values are received.

f - The mapping / filtering function. If the function returns null, the value will be skipped.

Method Details

receive

public T receive()
          throws InterruptedException

Description copied from interface: Source

Receive a value from the channel.

Specified by:

receive in interface Source<V>

Throws:

InterruptedException

receiveOrClosed

public Object receiveOrClosed()
                       throws InterruptedException

Description copied from interface: Source

Receive a value from the channel. Doesn't throw exceptions when the channel is closed, but returns a value.

Specified by:

receiveOrClosed in interface Source<V>

Returns:

Either a value of type T, or ChannelClosed, when the channel is closed.

Throws:

InterruptedException

receiveClause

public SelectClause<T> receiveClause()

Description copied from interface: Source

Create a clause which can be used in Select.select(SelectClause[]). The clause will receive a value from the current channel.

Specified by:

receiveClause in interface Source<V>

receiveClause

public <U> SelectClause<U> receiveClause(Function<T,U> callback)

Description copied from interface: Source

Create a clause which can be used in Select.select(SelectClause[]). The clause will receive a value from the current channel, and transform it using the provided callback.

Specified by:

receiveClause in interface Source<V>

done

public void done()

Description copied from interface: CloseableChannel

Close the channel, indicating that no more elements will be sent.

Any elements that are already buffered will be delivered. Any send operations that are in progress will complete normally, when a receiver arrives. Any pending receive operations will complete with a channel closed result.

Subsequent Sink.send(Object) operations will throw ChannelClosedException.

Specified by:

done in interface CloseableChannel

doneOrClosed

public Object doneOrClosed()

Description copied from interface: CloseableChannel

Close the channel, indicating that no more elements will be sent. Doesn't throw exceptions when the channel is closed, but returns a value.

Any elements that are already buffered will be delivered. Any send operations that are in progress will complete normally, when a receiver arrives. Any pending receive operations will complete with a channel closed result.

Subsequent Sink.send(Object) operations will throw ChannelClosedException.

Specified by:

doneOrClosed in interface CloseableChannel

Returns:

Either null, or ChannelClosed, when the channel is already closed.

error

public void error(Throwable reason)

Description copied from interface: CloseableChannel

Close the channel, indicating an error.

Any elements that are already buffered won't be delivered. Any send or receive operations that are in progress will complete with a channel closed result.

Subsequent Sink.send(Object) and Source.receive() operations will throw ChannelClosedException.

Specified by:

error in interface CloseableChannel

Parameters:

reason - The reason of the error. Not null.

errorOrClosed

public Object errorOrClosed(Throwable reason)

Description copied from interface: CloseableChannel

Close the channel, indicating an error. Doesn't throw exceptions when the channel is closed, but returns a value.

Any elements that are already buffered won't be delivered. Any send or receive operations that are in progress will complete with a channel closed result.

Subsequent Sink.send(Object) and Source.receive() operations will throw ChannelClosedException.

Specified by:

errorOrClosed in interface CloseableChannel

Returns:

Either null, or ChannelClosed, when the channel is already closed.

closedForSend

public ChannelClosed closedForSend()

Specified by:

closedForSend in interface CloseableChannel

Returns:

Non-null if no more values can be sent to this channel; Sink.send(Object) will throw ChannelClosedException or return ChannelClosed (in the or-closed variant).

null if the channel is not closed, and values can be sent.

When closed for send, receiving using Source.receive() might still be possible, if the channel is done, and not in an error. This can be verified using CloseableChannel.isClosedForReceive().

closedForReceive

public ChannelClosed closedForReceive()

Specified by:

closedForReceive in interface CloseableChannel

Returns:

Non-null if no more values can be received from this channel; Source.receive() will throw ChannelClosedException or return ChannelClosed (in the or-closed variant).

null if the channel is not closed, and values can be received.

When closed for receive, sending values is also not possible, CloseableChannel.isClosedForSend() will return true.