modules/configuration-api/src/main/java/org/apache/ignite/configuration/ConfigurationTree.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.ignite.configuration;

import java.util.Map;
import java.util.concurrent.Future;
import java.util.function.Consumer;

/**
 * Configuration tree with configuration values and other configuration trees as child nodes.
 *
 * @param <VIEW> Value type of the node.
 * @param <CHANGE> Type of the object that changes this node's value.
 */
public interface ConfigurationTree<VIEW, CHANGE> extends ConfigurationProperty<VIEW, CHANGE> {
    /**
     * Children of the tree.
     *
     * @return Map from {@code String} to a corresponding {@link ConfigurationProperty}.
     */
    Map<String, ConfigurationProperty<?, ?>> members();

    /**
     * Changes this configuration node value.
     *
     * @param change CHANGE object.
     * @return Future that is completed when configuration change is finished either successfully or not.
     */
    Future<Void> change(Consumer<CHANGE> change);
}