Class TimeoutConfig.Builder

java.lang.Object

io.helidon.faulttolerance.TimeoutConfig.BuilderBase<TimeoutConfig.Builder, TimeoutConfig>

io.helidon.faulttolerance.TimeoutConfig.Builder

All Implemented Interfaces:

Prototype.Builder<TimeoutConfig.Builder, TimeoutConfig>, Builder<TimeoutConfig.Builder, Timeout>, ConfigBuilderSupport.ConfiguredBuilder<TimeoutConfig.Builder, TimeoutConfig>, Supplier<Timeout>

Enclosing interface:

TimeoutConfig

public static class TimeoutConfig.Builder
extends TimeoutConfig.BuilderBase<TimeoutConfig.Builder, TimeoutConfig>
implements Builder<TimeoutConfig.Builder, Timeout>

Fluent API builder for Timeout.

Nested Class Summary

Nested classes/interfaces inherited from class TimeoutConfig.BuilderBase

TimeoutConfig.BuilderBase.TimeoutConfigImpl

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

Method Summary

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

Methods inherited from class TimeoutConfig.BuilderBase

clearExecutor, clearName, config, config, currentThread, currentThread, enableMetrics, enableMetrics, executor, executor, from, from, name, name, preBuildPrototype, timeout, timeout, toString, validatePrototype

Modifier and Type	Method	Description
TimeoutConfig.Builder	clearExecutor()	Clear existing value of executor.
TimeoutConfig.Builder	clearName()	Clear existing value of name.
protected Optional<Config>	config()	Configuration used to configure this instance.
TimeoutConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
boolean	currentThread()	Flag to indicate that code must be executed in current thread instead of in an executor's thread.
TimeoutConfig.Builder	currentThread(boolean currentThread)	Flag to indicate that code must be executed in current thread instead of in an executor's thread.
boolean	enableMetrics()	Flag to enable metrics for this instance.
TimeoutConfig.Builder	enableMetrics(boolean enableMetrics)	Flag to enable metrics for this instance.
Optional<ExecutorService>	executor()	Executor service to schedule the timeout.
TimeoutConfig.Builder	executor(ExecutorService executor)	Executor service to schedule the timeout.
TimeoutConfig.Builder	from(TimeoutConfig prototype)	Update this builder from an existing prototype instance.
TimeoutConfig.Builder	from(TimeoutConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	name()	Name for debugging, error reporting, monitoring.
TimeoutConfig.Builder	name(String name)	Name for debugging, error reporting, monitoring.
protected void	preBuildPrototype()	Handles providers and decorators.
Duration	timeout()	Duration to wait before timing out.
TimeoutConfig.Builder	timeout(Duration timeout)	Duration to wait before timing out.
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 Timeout	get()
default TimeoutConfig.Builder	identity()	Instance of this builder as the correct type.
default TimeoutConfig.Builder	update(Consumer<TimeoutConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public TimeoutConfig 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<TimeoutConfig.Builder, TimeoutConfig>

Returns:

an instance of the setup object created from this builder

build

public Timeout 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<TimeoutConfig.Builder, Timeout>

Returns:

instance of the built type