io.helidon.config.spi.ConfigContext Maven / Gradle / Ivy

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

Configuration Core module.

There is a newer version: 4.1.1

/*
 * Copyright (c) 2017, 2020 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.
 */

package io.helidon.config.spi;

import io.helidon.config.ConfigSourceRuntime;

/**
 * Context created by a {@link io.helidon.config.Config.Builder} as it constructs a
 * {@link io.helidon.config.Config}.
 * 
 * The context is typically used in implementations of {@link io.helidon.config.spi}
 * interfaces to share common information.
 */
public interface ConfigContext {
    /**
     * Create or find a runtime for a config source.
     *
     * @param source source to create runtime for
     * @return a source runtime
     */
    ConfigSourceRuntime sourceRuntime(ConfigSource source);
}