org.eclipse.edc.spi.system.SettingResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of boot-spi Show documentation
edc :: boot-spi
The newest version!
/*
 *  Copyright (c) 2021 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
 *
 *  This program and the accompanying materials are made available under the
 *  terms of the Apache License, Version 2.0 which is available at
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 *  SPDX-License-Identifier: Apache-2.0
 *
 *  Contributors:
 *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
 *       Fraunhofer Institute for Software and Systems Engineering - Improvements
 *
 */

package org.eclipse.edc.spi.system;

import org.eclipse.edc.spi.system.configuration.Config;

/**
 * Resolve config settings and parse them to different primitive types
 */
public interface SettingResolver {

    /**
     * Get the config for the specified path
     */
    Config getConfig(String path);

    /**
     * Get the config from the root
     */
    default Config getConfig() {
        return getConfig("");
    }

    /**
     * Returns the configuration value, or the default value if not found.
     *
     * @param setting the setting key
     * @param defaultValue value returned if no key found
     * @return the config value as int
     */
    default String getSetting(String setting, String defaultValue) {
        return getConfig().getString(setting, defaultValue);
    }

    /**
     * Returns the configuration value parsed as int or the default value if not found
     *
     * @param setting the setting key
     * @param defaultValue value returned if no key found
     * @return the config value as int
     */
    default int getSetting(String setting, int defaultValue) {
        return getConfig().getInteger(setting, defaultValue);
    }

    /**
     * Returns the configuration value parsed as long or the default value if not found
     *
     * @param setting the setting key
     * @param defaultValue value returned if no key found
     * @return the config value as long
     */
    default long getSetting(String setting, long defaultValue) {
        return getConfig().getLong(setting, defaultValue);
    }

    /**
     * Returns the configuration value parsed as boolean or the default value if not found
     *
     * @param setting the setting key
     * @param defaultValue value returned if no key found
     * @return the config value as boolean
     */
    default boolean getSetting(String setting, boolean defaultValue) {
        return getConfig().getBoolean(setting, defaultValue);
    }
}