io.helidon.config.spi.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-config Show documentation

Configuration Core module.

The newest version!

/*
 * Copyright (c) 2017, 2021 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Configuration SPI that defines the behavior developers can implement to extend the config system.
 * 
 * The most likely developer-implemented extension points:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Common Extension PointsInterface Purpose
{@link ConfigSource} Loads configuration data from a type of source.
 * 
{@link ConfigParser} Converts configuration data into a {@link ConfigNode.ObjectNode}.
{@link ConfigFilter} Filters configuration values after they have been read from a
 * {@code ConfigSource} but before they are used in building a
 * {@link io.helidon.config.Config} tree.
{@link ConfigMapperProvider} Converts {@code Config} nodes or subtrees to Java types. See
 * {@link io.helidon.config.ConfigMappers} for the built-in mappers.
{@link OverrideSource} Replaces values pf config nodes whose keys match specified conditions
 * with alternative values.
{@link PollingStrategy} Notifies interested code when the data underlying a {@link Source} might
 * have changed.
{@link RetryPolicy} Controls if and how a {@code Source} attempts to retry failed attempts to
 * load the underlying data.
 *
 * @see io.helidon.config Configuration API
 */
package io.helidon.config.spi;

Interface	Purpose
{@link ConfigSource}	Loads configuration data from a type of source. *
{@link ConfigParser}	Converts configuration data into a {@link ConfigNode.ObjectNode}.
{@link ConfigFilter}	Filters configuration values after they have been read from a * {@code ConfigSource} but before they are used in building a * {@link io.helidon.config.Config} tree.
{@link ConfigMapperProvider}	Converts {@code Config} nodes or subtrees to Java types. See * {@link io.helidon.config.ConfigMappers} for the built-in mappers.
{@link OverrideSource}	Replaces values pf config nodes whose keys match specified conditions * with alternative values.
{@link PollingStrategy}	Notifies interested code when the data underlying a {@link Source} might * have changed.
{@link RetryPolicy}	Controls if and how a {@code Source} attempts to retry failed attempts to * load the underlying data.