net.morimekta.config.source.ConfigSource Maven / Gradle / Ivy

Go to download

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

Configuration Utilities.

There is a newer version: 2.7.1

package net.morimekta.config.source;

import net.morimekta.config.Config;
import net.morimekta.config.ConfigException;

import java.io.IOException;

/**
 * Config source interface.
 */
public interface ConfigSource {
    /**
     * Load config from the source. This is a blocking call, loading the config
     * from wherever it is, and parsing the data to provide the immutable config
     * object.
     *
     * @return The loaded config.
     * @throws IOException when unable to read the config.
     * @throws ConfigException when unable to parse the config.
     */
    Config load() throws IOException, ConfigException;
}