org.apache.gobblin.util.limiter

Class NonRefillableLimiter

java.lang.Object

org.apache.gobblin.util.limiter.NonRefillableLimiter

All Implemented Interfaces:

Limiter

Direct Known Subclasses:

CountBasedLimiter, RateBasedLimiter, TimeBasedLimiter

public abstract class NonRefillableLimiter
extends Object
implements Limiter

A type of Limiters that do not support permit refills by returning a no-op Closeable in acquirePermits(long).

Field Summary

Fields

Modifier and Type	Field and Description
protected static Closeable	NO_OP_CLOSEABLE

Constructor Summary

Constructors

Constructor and Description
NonRefillableLimiter()

Method Summary

Modifier and Type	Method and Description
Closeable	acquirePermits(long permits) Acquire a given number of permits.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.gobblin.util.limiter.Limiter

start, stop

Field Detail

NO_OP_CLOSEABLE

protected static final Closeable NO_OP_CLOSEABLE

Constructor Detail

NonRefillableLimiter

public NonRefillableLimiter()

Method Detail

acquirePermits

public Closeable acquirePermits(long permits)
                         throws InterruptedException

Description copied from interface: Limiter

Acquire a given number of permits.

Depending on the implementation, the caller of this method may be blocked. It is also up to the caller to decide how to deal with the return value.

Specified by:

acquirePermits in interface Limiter

Parameters:

permits - number of permits to get

Returns:

a Closeable instance if the requested permits have been successfully acquired, or null if otherwise; in the former case, calling Closeable.close() on the returned Closeable instance will release the acquired permits.

Throws:

InterruptedException - if the caller is interrupted while being blocked