org.craftercms.commons.upgrade.UpgradeConfigurationProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2007-2023 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program 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 this program.  If not, see .
 */
package org.craftercms.commons.upgrade;

import org.craftercms.commons.upgrade.exception.UpgradeException;

/**
 * Provides the configuration for an upgrade process
 *
 * @param  The expected configuration object type
 * @since 4.1.2
 */
public interface UpgradeConfigurationProvider {
    /**
     * Gets the configuration for the upgrade process
     *
     * @return the configuration
     * @throws UpgradeException if there is any error getting the configuration. e.g.: a {@link java.io.IOException} while loading a file
     */
    T getConfiguration() throws UpgradeException;
}