net.freeutils.util.config.Configurable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jelementary Show documentation

The Java Elementary Utilities package

The newest version!

/*
 *  Copyright © 2003-2024 Amichai Rothman
 *
 *  This file is part of JElementary - the Java Elementary Utilities package.
 *
 *  JElementary is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  JElementary is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with JElementary.  If not, see .
 *
 *  For additional info see https://www.freeutils.net/source/jelementary/
 */

package net.freeutils.util.config;

/**
 * The {@code Configurable} interface allows a component to be configured.
 */
public interface Configurable {

    /**
     * Configures the component using the given configuration section.
     *
     * @param conf the configuration section containing the configuration data
     * @throws Exception if an error occurs which prevents the component
     *         from being configured
     */
    void configure(Configuration conf) throws Exception;

}