Module io.helidon.config

Package io.helidon.config

Interface ConfigItem

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

ConfigItem.BuilderBase.ConfigItemImpl

public interface ConfigItem
extends Prototype.Api

Configuration item policy. Contains information about the given item to improve its handling.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ConfigItem.Builder	builder()	Create a new fluent API builder to customize configuration.
static ConfigItem.Builder	builder(ConfigItem instance)	Create a new fluent API builder from an existing instance.
boolean	cacheItem()	Whether to cache this handled config item or not.
static ConfigItem	create()	Create a new instance with default values.
String	item()	Handled config item.

Method Details

builder

static ConfigItem.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ConfigItem.Builder builder(ConfigItem 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 ConfigItem create()

Create a new instance with default values.

Returns:

a new instance

cacheItem

boolean cacheItem()

Whether to cache this handled config item or not. If overall caching is disabled, this will not turn it on even if set to true.

Returns:

whether to cache handled config item

item

String item()

Handled config item.

Returns:

config item