Package ch.psi.wica.model.stream

Class WicaStream

java.lang.Object

ch.psi.wica.model.stream.WicaStream

Direct Known Subclasses:

WicaStreamSerializer.WicaStreamDeserializerMixin, WicaStreamSerializer.WicaStreamSerializerMixin

@Immutable
public class WicaStream
extends Object

Represents a collection of unique wica channels that are grouped together for the purpose of real-time monitoring.

Constructor Summary

Constructors

Constructor	Description
WicaStream()
WicaStream(WicaStreamId wicaStreamId, WicaStreamProperties wicaStreamProperties, Set<WicaChannel> wicaChannels)	Constructs a new stream for the specified channels with the specified stream properties.
WicaStream(WicaStreamProperties wicaStreamProperties, Set<WicaChannel> wicaChannels)

Method Summary

Modifier and Type	Method	Description
Optional<WicaChannel>	getWicaChannel(String wicaChannelName)	Returns the channel with the specified name (if present).
Set<WicaChannel>	getWicaChannels()	Returns the stream's channels.
WicaStreamId	getWicaStreamId()	Returns the stream's id.
WicaStreamProperties	getWicaStreamProperties()	Returns the stream's properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

WicaStream

public WicaStream()

WicaStream

public WicaStream(WicaStreamProperties wicaStreamProperties,
 Set<WicaChannel> wicaChannels)

WicaStream

public WicaStream(WicaStreamId wicaStreamId,
 WicaStreamProperties wicaStreamProperties,
 Set<WicaChannel> wicaChannels)

Constructs a new stream for the specified channels with the specified stream properties.

Parameters:

wicaStreamId - the stream's id.

wicaStreamProperties - the stream's properties.

wicaChannels - the stream's channels.

Method Details

getWicaStreamId

public WicaStreamId getWicaStreamId()

Returns the stream's id.

Returns:

the object.

getWicaStreamProperties

public WicaStreamProperties getWicaStreamProperties()

Returns the stream's properties.

Returns:

the object.

getWicaChannels

public Set<WicaChannel> getWicaChannels()

Returns the stream's channels.

Returns:

the object.

getWicaChannel

public Optional<WicaChannel> getWicaChannel(String wicaChannelName)

Returns the channel with the specified name (if present).

Parameters:

wicaChannelName - the channel name.

Returns:

optionally empty result.

toString

public String toString()

Overrides:

toString in class Object