io.helidon.config.spi.MergingStrategy 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) 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 java.util.List;

/**
 * An algorithm for combining multiple {@code ConfigNode.ObjectNode} root nodes
 * into a single {@code ConfigNode.ObjectNode} root node.
 *
 * @see #fallback() default merging strategy
 */
public interface MergingStrategy {
    /**
     * Merges an ordered list of {@link io.helidon.config.spi.ConfigNode.ObjectNode}s into a
     * single instance.
     * 
     * Typically nodes (object, list or value) from a root earlier in the
     * list are considered to have a higher priority than nodes from a root
     * that appears later in the list, but this is not required and is
     * entirely up to each {@code MergingStrategy} implementation.
     *
     * @param rootNodes list of root nodes to combine
     * @return ObjectNode root node resulting from the merge
     */
    ConfigNode.ObjectNode merge(List rootNodes);

    /**
     * Returns an implementation of {@code MergingStrategy} in which nodes
     * from a root earlier in the list have higher priority than nodes from
     * a root later in the list.
     * 
     * The merged behavior is as if the resulting merged {@code Config},
     * when resolving a value of a key, consults the {@code Config} roots in
     * the order they were passed to {@code merge}. As soon as it finds a
     * {@code Config} tree containing a value for the key is it immediately
     * returns that value, disregarding other later config roots.
     *
     * @return new instance of fallback merging strategy
     */
    static MergingStrategy fallback() {
        return new FallbackMergingStrategy();
    }

}