dk.dma.ais.packet

Class AisPacketStream

java.lang.Object

dk.dma.ais.packet.AisPacketStream

public abstract class AisPacketStream
extends Object

A stream of packets.

Author:

Kasper Nielsen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AisPacketStream.StreamConsumer<T> The type Stream consumer.
static interface	AisPacketStream.Subscription A subcription is created each time a new consumer is added to the stream.

Field Summary

Fields

Modifier and Type	Field and Description
static RuntimeException	CANCEL Thrown by a subscriber to indicate that the subscription should be cancelled.

Constructor Summary

Constructors

Constructor and Description
AisPacketStream()

Method Summary

Modifier and Type	Method and Description
void	add(AisPacket p) Adds the specified packet to the stream
abstract AisPacketStream	filter(Predicate<? super AisPacket> predicate) Returns a new stream that only streams packets accepted by the specified predicate.
AisPacketStream	filter(String expression) Filter ais packet stream.
AisPacketStream	filterOnMessageType(int... messageTypes) Filter on message type ais packet stream.
AisPacketStream	immutableStream() Immutable stream ais packet stream.
AisPacketStream	limit(long limit) Limit ais packet stream.
static AisPacketStream	newStream() Returns a new stream.
abstract AisPacketStream.Subscription	subscribe(Consumer<AisPacket> c) Subscribe subscription.
AisPacketStream.Subscription	subscribeMessages(Consumer<AisMessage> c) Subscribe messages subscription.
AisPacketStream.Subscription	subscribeSink(dk.dma.commons.util.io.OutputStreamSink<AisPacket> sink, OutputStream os) Subscribe sink subscription.

Methods inherited from class java.lang.Object

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

Field Detail

CANCEL

public static final RuntimeException CANCEL

Thrown by a subscriber to indicate that the subscription should be cancelled.

Constructor Detail

AisPacketStream

public AisPacketStream()

Method Detail

add

public void add(AisPacket p)

Adds the specified packet to the stream

Parameters:

p - the p

Throws:

UnsupportedOperationException - if the stream is immutable

filter

public abstract AisPacketStream filter(Predicate<? super AisPacket> predicate)

Returns a new stream that only streams packets accepted by the specified predicate.

Parameters:

predicate - the predicate to test against each element

Returns:

the new stream

filter

public AisPacketStream filter(String expression)

Filter ais packet stream.

Parameters:

expression - the expression

Returns:

the ais packet stream

filterOnMessageType

public AisPacketStream filterOnMessageType(int... messageTypes)

Filter on message type ais packet stream.

Parameters:

messageTypes - the message types

Returns:

the ais packet stream

immutableStream

public final AisPacketStream immutableStream()

Immutable stream ais packet stream.

Returns:

the ais packet stream

limit

public AisPacketStream limit(long limit)

Limit ais packet stream.

Parameters:

limit - the limit

Returns:

the ais packet stream

subscribe

public abstract AisPacketStream.Subscription subscribe(Consumer<AisPacket> c)

Subscribe subscription.

Parameters:

c - the c

Returns:

the subscription

subscribeMessages

public AisPacketStream.Subscription subscribeMessages(Consumer<AisMessage> c)

Subscribe messages subscription.

Parameters:

c - the c

Returns:

the subscription

subscribeSink

public AisPacketStream.Subscription subscribeSink(dk.dma.commons.util.io.OutputStreamSink<AisPacket> sink,
                                                  OutputStream os)

Subscribe sink subscription.

Parameters:

sink - the sink

os - the os

Returns:

the subscription

newStream

public static AisPacketStream newStream()

Returns a new stream.

Returns:

the new stream