Package org.yamcs

Class ParameterCaptor

java.lang.Object

org.yamcs.ParameterCaptor

public class ParameterCaptor
extends Object

Utility class for queueing parameter deliveries as they are received from a subscription to Yamcs. This is intended for use in unit tests only.

Method Summary

Modifier and Type	Method	Description
void	assertSilence()
void	clear()
List<org.yamcs.protobuf.Pvalue.ParameterValue>	expectTimely()	Returns the next delivery.
org.yamcs.protobuf.Yamcs.NamedObjectId	expectTimelyInvalidIdentifier()
int	getPendingCount()	Returns the number of unprocessed value deliveries.
boolean	isEmpty()	Returns true if there are not currently any unprocessed deliveries.
static ParameterCaptor	of(ParameterSubscription subscription)
List<org.yamcs.protobuf.Pvalue.ParameterValue>	poll()	Returns the next delivery.
List<org.yamcs.protobuf.Pvalue.ParameterValue>	poll(long timeout)	Returns the next delivery.

Methods inherited from class java.lang.Object

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

Method Detail

poll

public List<org.yamcs.protobuf.Pvalue.ParameterValue> poll()

Returns the next delivery. Or null, if nothing was received yet.

poll

public List<org.yamcs.protobuf.Pvalue.ParameterValue> poll(long timeout)
                                                    throws InterruptedException

Returns the next delivery. Or null, if nothing was received yet.

Throws:

InterruptedException

expectTimely

public List<org.yamcs.protobuf.Pvalue.ParameterValue> expectTimely()
                                                            throws InterruptedException,
                                                                   TimeoutException

Returns the next delivery. If there is nothing available yet, this will block for the specified time awaiting delivery.

Throws:

InterruptedException

TimeoutException

assertSilence

public void assertSilence()
                   throws InterruptedException

Throws:

InterruptedException

clear

public void clear()

isEmpty

public boolean isEmpty()

Returns true if there are not currently any unprocessed deliveries.

getPendingCount

public int getPendingCount()

Returns the number of unprocessed value deliveries.

expectTimelyInvalidIdentifier

public org.yamcs.protobuf.Yamcs.NamedObjectId expectTimelyInvalidIdentifier()
                                                                     throws InterruptedException,
                                                                            TimeoutException

Throws:

InterruptedException

TimeoutException

of

public static ParameterCaptor of(ParameterSubscription subscription)