ru.tinkoff.kora.config.common.Config Maven / Gradle / Ivy

Go to download

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

Kora config-common module

The newest version!

package ru.tinkoff.kora.config.common;

import ru.tinkoff.kora.config.common.impl.ConfigResolver;
import ru.tinkoff.kora.config.common.origin.ConfigOrigin;

/**
 * Русский: Базовое предоставления конфигурации в Kora.
 * 
 * English: Basic configuration representation in Kora.
 */
public interface Config {

    /**
     * @return Русский: Описание источника происхождения конфигурации
     * 
     * English: Description of the source of origin of the configuration
     */
    ConfigOrigin origin();

    /**
     * @return Русский: Корень древа конфигурации
     * 
     * English: The root of the configuration tree
     */
    ConfigValue.ObjectValue root();

    default Config resolve() {
        return ConfigResolver.resolve(this);
    }

    default ConfigValue get(ConfigValuePath path) {
        return ConfigHelper.get(this, path);
    }

    /**
     * @return Русский: Получение значения конфигурации используя путь как аргумент
     * 
     * English: The root of the configuration tree
     * 

     * 

     * Пример / Example:
     *      * {@code
     * @Json
     * var configValue = config.get("test.config.path")
     * }
     * 
     */
    default ConfigValue get(String path) {
        return this.get(ConfigValuePath.parse(path));
    }
}