io.micronaut.starter.feature.config.NestedConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-starter-core Show documentation

Generates Micronaut applications

There is a newer version: 4.7.0

Show newest version

/*
 * Copyright 2017-2022 original authors
 *
 * 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
 *
 * https://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.micronaut.starter.feature.config;

import io.micronaut.core.annotation.NonNull;

import java.util.Map;

/**
 * A utility class to supply nested configuration via {@link io.micronaut.starter.feature.config.ApplicationConfiguration#addNested(NestedConfiguration)}.
 * @author Sergio del Amo
 * @since 3.9.x
 */
public class NestedConfiguration {

    @NonNull
    private final String path;

    @NonNull
    private final Map configuration;

    /**
     * For path = custom.config and configuration = [foo: [enabled: true, name: 'bar'] the generated config will be:
     *      * custom:
     *   config:
     *     foo:
     *       enabled: true
     *       name: bar
     * 
     * @param path root path
     * @param configuration configuration
     */
    public NestedConfiguration(@NonNull String path, @NonNull Map configuration) {
        this.path = path;
        this.configuration = configuration;
    }

    @NonNull
    public String getPath() {
        return path;
    }

    @NonNull
    public Map getConfiguration() {
        return configuration;
    }
}