Class FixedLimitConfig.Builder

java.lang.Object

io.helidon.common.concurrency.limits.FixedLimitConfig.BuilderBase<FixedLimitConfig.Builder, FixedLimitConfig>

io.helidon.common.concurrency.limits.FixedLimitConfig.Builder

All Implemented Interfaces:

Prototype.Builder<FixedLimitConfig.Builder, FixedLimitConfig>, Builder<FixedLimitConfig.Builder, FixedLimit>, ConfigBuilderSupport.ConfiguredBuilder<FixedLimitConfig.Builder, FixedLimitConfig>, Supplier<FixedLimit>

Enclosing interface:

FixedLimitConfig

public static class FixedLimitConfig.Builder
extends FixedLimitConfig.BuilderBase<FixedLimitConfig.Builder, FixedLimitConfig>
implements Builder<FixedLimitConfig.Builder, FixedLimit>

Fluent API builder for FixedLimit.

Nested Class Summary

Nested classes/interfaces inherited from class FixedLimitConfig.BuilderBase

FixedLimitConfig.BuilderBase.FixedLimitConfigImpl

Modifier and Type	Class	Description
protected static class	FixedLimitConfig.BuilderBase.FixedLimitConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
FixedLimit	build()	Create an instance from this builder.
FixedLimitConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class FixedLimitConfig.BuilderBase

clearClock, clearSemaphore, clock, clock, config, config, enableMetrics, enableMetrics, fair, fair, from, from, name, name, permits, permits, preBuildPrototype, queueLength, queueLength, queueTimeout, queueTimeout, semaphore, semaphore, toString, validatePrototype

Modifier and Type	Method	Description
FixedLimitConfig.Builder	clearClock()	Clear existing value of clock.
FixedLimitConfig.Builder	clearSemaphore()	Clear existing value of semaphore.
Optional<Supplier<Long>>	clock()	A clock that supplies nanosecond time.
FixedLimitConfig.Builder	clock(Supplier<Long> clock)	A clock that supplies nanosecond time.
protected Optional<Config>	config()	Configuration used to configure this instance.
FixedLimitConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
boolean	enableMetrics()	Whether to collect metrics for the fixed limit implementation.
FixedLimitConfig.Builder	enableMetrics(boolean enableMetrics)	Whether to collect metrics for the fixed limit implementation.
boolean	fair()	Whether the Semaphore should be Semaphore.isFair().
FixedLimitConfig.Builder	fair(boolean fair)	Whether the Semaphore should be Semaphore.isFair().
FixedLimitConfig.Builder	from(FixedLimitConfig prototype)	Update this builder from an existing prototype instance.
FixedLimitConfig.Builder	from(FixedLimitConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
String	name()	Name of this instance.
FixedLimitConfig.Builder	name(String name)	Name of this instance.
int	permits()	Number of permits to allow.
FixedLimitConfig.Builder	permits(int permits)	Number of permits to allow.
protected void	preBuildPrototype()	Handles providers and decorators.
int	queueLength()	How many requests can be enqueued waiting for a permit.
FixedLimitConfig.Builder	queueLength(int queueLength)	How many requests can be enqueued waiting for a permit.
Duration	queueTimeout()	How long to wait for a permit when enqueued.
FixedLimitConfig.Builder	queueTimeout(Duration queueTimeout)	How long to wait for a permit when enqueued.
Optional<Semaphore>	semaphore()	Explicitly configured semaphore.
FixedLimitConfig.Builder	semaphore(Semaphore semaphore)	Explicitly configured semaphore.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default FixedLimit	get()
default FixedLimitConfig.Builder	identity()	Instance of this builder as the correct type.
default FixedLimitConfig.Builder	update(Consumer<FixedLimitConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default FixedLimitConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public FixedLimitConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<FixedLimitConfig.Builder, FixedLimitConfig>

Returns:

an instance of the setup object created from this builder

build

public FixedLimit build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<FixedLimitConfig.Builder, FixedLimit>

Returns:

instance of the built type