Interface OptionProvider

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

OptionProvider.BuilderBase.OptionProviderImpl

public interface OptionProvider
extends Prototype.Api

Definition of an option that is a provider (i.e. loaded through registry or service loader).

See Also:

• builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OptionProvider.Builder	builder()	Create a new fluent API builder to customize configuration.
static OptionProvider.Builder	builder(OptionProvider instance)	Create a new fluent API builder from an existing instance.
default Option.Provider.ConfigForm	configForm()	Configured provider outer configuration form.
boolean	discoverServices()	Whether to discover services by default.
default Option.Provider.Identity	providerIdentity()	Configured provider identity.
TypeName	providerType()	Type of the provider to lookup.

Method Details

builder

static OptionProvider.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static OptionProvider.Builder builder(OptionProvider 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

providerType

TypeName providerType()

Type of the provider to lookup.

Returns:

provider type

providerIdentity

default Option.Provider.Identity providerIdentity()

Configured provider identity. The compatibility default identifies providers by both type and name.

Returns:

configured provider identity

configForm

default Option.Provider.ConfigForm configForm()

Configured provider outer configuration form. The compatibility default derives the accepted form from the provider identity.

Returns:

configured provider outer configuration form

discoverServices

boolean discoverServices()

Whether to discover services by default.

Returns:

whether to discover services