com.dyngr

类 PollerBuilder<V>

java.lang.Object

com.dyngr.PollerBuilder<V>

类型参数:

V - result type of Poller's polling for.

public class PollerBuilder<V>
extends Object

A builder to build a Poller.

作者:

dingye

构造器概要

构造器

构造器和说明
PollerBuilder()

方法概要

限定符和类型	方法和说明
Poller<V>	build() Finally build the Poller instance.
static <V> PollerBuilder<V>	newBuilder() Constructs a new builder
PollerBuilder<V>	polling(AttemptMaker<V> attemptMaker) Sets the code of actual polling.
PollerBuilder<V>	stopIfException(boolean stopIfException) Set if poller should stop when an exception is thrown.
PollerBuilder<V>	withExecutorService(ExecutorService executorService) Sets the ExecutorService on which Poller will be running.
PollerBuilder<V>	withStopStrategy(StopStrategy... stopStrategies) Sets a list of stop strategies used to decide when to stop retrying. polling will stop if any stop strategy's condition is fulfilled.
PollerBuilder<V>	withStopStrategy(StopStrategy stopStrategy) Sets the stop strategy used to decide when to stop retrying.
PollerBuilder<V>	withWaitStrategy(WaitStrategy... waitStrategies) Sets a list of wait strategy used to decide how long to sleep between failed attempts.
PollerBuilder<V>	withWaitStrategy(WaitStrategy waitStrategy) Sets the wait strategy used to decide how long to sleep between failed attempts.

从类继承的方法 java.lang.Object

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

构造器详细资料

PollerBuilder

public PollerBuilder()

方法详细资料

withWaitStrategy

public PollerBuilder<V> withWaitStrategy(WaitStrategy waitStrategy)

Sets the wait strategy used to decide how long to sleep between failed attempts. The default strategy is to retry immediately after a failed attempt.

参数:

waitStrategy - the strategy used to sleep between failed attempts

返回:

this

抛出:

IllegalStateException - if a wait strategy has already been set.

withWaitStrategy

public PollerBuilder<V> withWaitStrategy(WaitStrategy... waitStrategies)

Sets a list of wait strategy used to decide how long to sleep between failed attempts. Actual wait time will be a total of all computed wait time.

参数:

waitStrategies - list of strategies used to sleep between failed attempts

返回:

this

抛出:

IllegalStateException - if a wait strategy has already been set.

stopIfException

public PollerBuilder<V> stopIfException(boolean stopIfException)

Set if poller should stop when an exception is thrown. The default value is true.

参数:

stopIfException - whether poller should stop if exception occurred

返回:

this

withStopStrategy

public PollerBuilder<V> withStopStrategy(StopStrategy stopStrategy)

Sets the stop strategy used to decide when to stop retrying. The default strategy is to not stop at all .

参数:

stopStrategy - the strategy used to decide when to stop retrying

返回:

this

抛出:

IllegalStateException - if a stop strategy has already been set.

withStopStrategy

public PollerBuilder<V> withStopStrategy(StopStrategy... stopStrategies)

Sets a list of stop strategies used to decide when to stop retrying. polling will stop if any stop strategy's condition is fulfilled.

参数:

stopStrategies - list of strategies used to decide when to stop retrying.

返回:

this

抛出:

IllegalStateException - if a stop strategy has already been set.

withExecutorService

public PollerBuilder<V> withExecutorService(ExecutorService executorService)

Sets the ExecutorService on which Poller will be running. The default is on the thread that calls Poller.start().

参数:

executorService - the executor service which is used to do the polling.

返回:

this

抛出:

IllegalStateException - if an executor service has already been set.

polling

public PollerBuilder<V> polling(AttemptMaker<V> attemptMaker)

Sets the code of actual polling.

参数:

attemptMaker - the polling body.

返回:

this

抛出:

IllegalArgumentException - if an attempt maker has already been set.

build

public Poller<V> build()

Finally build the Poller instance.

返回:

the built poller.

newBuilder

public static <V> PollerBuilder<V> newBuilder()

Constructs a new builder

类型参数:

V - result type of Poller's polling for.

返回:

the new builder