Module io.helidon.builder.codegen

Package io.helidon.builder.codegen

Interface OptionConfigured

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

OptionConfigured.BuilderBase.OptionConfiguredImpl

public interface OptionConfigured
extends Prototype.Api

Setup of configured option.

See Also:

• builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OptionConfigured.Builder	builder()	Create a new fluent API builder to customize configuration.
static OptionConfigured.Builder	builder(OptionConfigured instance)	Create a new fluent API builder from an existing instance.
String	configKey()	Config key to use.
Optional<FactoryMethod>	factoryMethod()	Factory method for this option.
boolean	merge()	Whether to merge the key with the current object.
boolean	traverse()	Whether to traverse the config node when creating a map.

Method Details

builder

static OptionConfigured.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

configKey

String configKey()

Config key to use.

Returns:

config key

merge

boolean merge()

Whether to merge the key with the current object.

Returns:

whether to merge, defaults to false, i.e. this option will have its own key, named configKey()

traverse

boolean traverse()

Whether to traverse the config node when creating a map.

Returns:

whether to traverse config, defaults to true

factoryMethod

Optional<FactoryMethod> factoryMethod()

Factory method for this option. Factory method will be discovered from PrototypeInfo.configFactories().

Returns:

config factory method if defined