com.opendxl.databus.consumer

Class DatabusPushConsumerFuture

java.lang.Object

com.opendxl.databus.consumer.DatabusPushConsumerFuture

All Implemented Interfaces:

java.util.concurrent.Future<DatabusPushConsumerStatus>

public class DatabusPushConsumerFuture
extends java.lang.Object
implements java.util.concurrent.Future<DatabusPushConsumerStatus>

This class allows SDK Databus client to know the status of a DatabusPushConsumer instance

Constructor Summary

Constructors

Constructor and Description
DatabusPushConsumerFuture(DatabusPushConsumerStatus databusPushConsumerStatus, java.util.concurrent.CountDownLatch countDownLatch) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
DatabusPushConsumerStatus	get()
DatabusPushConsumerStatus	get(long timeout, java.util.concurrent.TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
void	setDatabusPushConsumerListenerStatus(DatabusPushConsumerStatus databusPushConsumerStatus) Set the listener status

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabusPushConsumerFuture

public DatabusPushConsumerFuture(DatabusPushConsumerStatus databusPushConsumerStatus,
                                 java.util.concurrent.CountDownLatch countDownLatch)

Constructor

Parameters:

databusPushConsumerStatus - Listener Status instance

countDownLatch - A latch to signal that the DatabusPushConsumer has finished

Method Detail

setDatabusPushConsumerListenerStatus

public void setDatabusPushConsumerListenerStatus(DatabusPushConsumerStatus databusPushConsumerStatus)

Set the listener status

Parameters:

databusPushConsumerStatus - listener status

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future<DatabusPushConsumerStatus>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<DatabusPushConsumerStatus>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<DatabusPushConsumerStatus>

get

public DatabusPushConsumerStatus get()
                              throws java.lang.InterruptedException,
                                     java.util.concurrent.ExecutionException,
                                     java.util.concurrent.CancellationException

Specified by:

get in interface java.util.concurrent.Future<DatabusPushConsumerStatus>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.CancellationException

get

public DatabusPushConsumerStatus get(long timeout,
                                     java.util.concurrent.TimeUnit unit)
                              throws java.lang.InterruptedException,
                                     java.util.concurrent.ExecutionException,
                                     java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<DatabusPushConsumerStatus>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException