Interface AsyncConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<Async>

All Known Implementing Classes:

AsyncConfig.BuilderBase.AsyncConfigImpl

public interface AsyncConfig
extends Prototype.Api

Async configuration bean.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AsyncConfig.Builder	Fluent API builder for Async.
static class	AsyncConfig.BuilderBase<BUILDER extends AsyncConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends AsyncConfig>	Fluent API builder base for AsyncConfig.

Method Summary

Modifier and Type	Method	Description
static AsyncConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static AsyncConfig.Builder	builder(AsyncConfig instance)	Create a new fluent API builder from an existing instance.
static AsyncConfig	create()	Create a new instance with default values.
static AsyncConfig	create(Config config)	Create a new instance from configuration.
Optional<ExecutorService>	executor()	Executor service.
Optional<String>	executorName()	Name of an executor service.
Optional<String>	name()	Name for debugging, error reporting, monitoring.
Optional<CompletableFuture<Async>>	onStart()	A future that is completed when execution of the asynchronous task starts.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
Async	build()	Create a new instance of the runtime type from this config object.

Method Details

builder

static AsyncConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static AsyncConfig.Builder builder(AsyncConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static AsyncConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static AsyncConfig create()

Create a new instance with default values.

Returns:

a new instance

name

Optional<String> name()

Name for debugging, error reporting, monitoring.

Returns:

name of this async

executorName

Optional<String> executorName()

Name of an executor service. This is only honored when service registry is used.

Returns:

name fo the ExecutorService to lookup

See Also:

• executor()

executor

Optional<ExecutorService> executor()

Executor service. Will be used to run the asynchronous tasks.

Returns:

explicit executor service

onStart

Optional<CompletableFuture<Async>> onStart()

A future that is completed when execution of the asynchronous task starts.

Returns:

future that will be completed by the asynchronous processing