DMDirc-Client/api/src/main/java/com/dmdirc/interfaces/config/ConfigProviderMigrator.java

/*
 * Copyright (c) 2006-2015 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.interfaces.config;

/**
 * Describes an object that can migrate a specific {@link AggregateConfigProvider} to use different
 * settings.
 */
public interface ConfigProviderMigrator {

    /**
     * Migrates this associated provider from its current configuration to the appropriate one for
     * the specified new parameters, firing listeners where settings have changed.
     *
     * @param protocol The protocol for this manager
     * @param ircd     The new name of the ircd for this manager
     * @param network  The new name of the network for this manager
     * @param server   The new name of the server for this manager
     */
    void migrate(String protocol, String ircd, String network, String server);

    /**
     * Migrates the associated provider from its current configuration to the appropriate one for
     * the specified new parameters, firing listeners where settings have changed.
     *
     * @param protocol The protocol for this manager
     * @param ircd     The new name of the ircd for this manager
     * @param network  The new name of the network for this manager
     * @param server   The new name of the server for this manager
     * @param channel  The new name of the channel for this manager
     */
    void migrate(String protocol, String ircd, String network, String server, String channel);

    /**
     * Returns the config provider that this migrator is operating on.
     *
     * @return A config provider which may be migrated by this migrator.
     */
    AggregateConfigProvider getConfigProvider();

}