DMDirc-Plugins/nickcolours/src/com/dmdirc/addons/nickcolours/NickColourModule.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.addons.nickcolours;

import com.dmdirc.addons.ui_swing.injection.SwingModule;
import com.dmdirc.plugins.PluginDomain;
import com.dmdirc.plugins.PluginInfo;

import dagger.Module;
import dagger.Provides;

/**
 * DI module for the nick colour plugin.
 */
@Module(injects = NickColourManager.class, addsTo = SwingModule.class)
public class NickColourModule {

    /** This plugin's plugin info. */
    private final PluginInfo pluginInfo;
    /** The domain for plugin settings. */
    private final String domain;

    public NickColourModule(final PluginInfo pluginInfo, final String domain) {
        this.pluginInfo = pluginInfo;
        this.domain = domain;
    }

    /**
     * Provides the domain that the swing settings should be stored under.
     *
     * @return The settings domain for the swing plugin.
     */
    @Provides
    @PluginDomain(NickColourPlugin.class)
    public String getSettingsDomain() {
        return domain;
    }

    @Provides
    public PluginInfo getPluginInfo() {
        return pluginInfo;
    }

}