Class TimedSemaphore.Builder

java.lang.Object

org.apache.commons.lang3.concurrent.TimedSemaphore.Builder

All Implemented Interfaces:

Supplier<TimedSemaphore>

Enclosing class:

TimedSemaphore

public static class TimedSemaphore.Builder
extends Object
implements Supplier<TimedSemaphore>

Builds new TimedSemaphore.

Since:

3.20.0

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructs a new Builder.

Method Summary

Modifier and Type	Method	Description
TimedSemaphore	get()
TimedSemaphore.Builder	setFair(boolean fair)	Sets whether blocking acquisitions use FIFO ordering.
TimedSemaphore.Builder	setLimit(int limit)	Sets the limit.
TimedSemaphore.Builder	setPeriod(long period)	Sets the time period.
TimedSemaphore.Builder	setService(ScheduledExecutorService service)	Sets the executor service.
TimedSemaphore.Builder	setTimeUnit(TimeUnit timeUnit)	Sets the time unit for the period.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Constructs a new Builder.

Method Details

get

public TimedSemaphore get()

Specified by:

get in interface Supplier<TimedSemaphore>

setFair

public TimedSemaphore.Builder setFair(boolean fair)

Sets whether blocking acquisitions use FIFO ordering.

Fairness is disabled by default. When enabled, calls to TimedSemaphore.acquire() are ordered by entry into the internal waiting queue, not by thread start time or method return order. New calls made with the limit disabled and calls to TimedSemaphore.tryAcquire() may bypass waiting callers.

Parameters:

fair - Whether to enable FIFO ordering.

Returns:

this instance.

Since:

3.22.0

setLimit

public TimedSemaphore.Builder setLimit(int limit)

Sets the limit.

Parameters:

limit - The limit.

Returns:

this instance.

setPeriod

public TimedSemaphore.Builder setPeriod(long period)

Sets the time period.

Parameters:

period - The time period.

Returns:

this instance.

setService

public TimedSemaphore.Builder setService(ScheduledExecutorService service)

Sets the executor service.

Parameters:

service - The executor service.

Returns:

this instance.

setTimeUnit

public TimedSemaphore.Builder setTimeUnit(TimeUnit timeUnit)

Sets the time unit for the period.

Parameters:

timeUnit - The time unit for the period.

Returns:

this instance.