NucleusKitContext.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * 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.jcwhatever.nucleus.internal.providers.kits;

import com.jcwhatever.nucleus.mixins.IPluginOwned;
import com.jcwhatever.nucleus.providers.kits.IKit;
import com.jcwhatever.nucleus.providers.kits.IKitContext;
import com.jcwhatever.nucleus.providers.kits.IModifiableKit;
import com.jcwhatever.nucleus.storage.IDataNode;
import com.jcwhatever.nucleus.utils.PreCon;
import com.jcwhatever.nucleus.utils.managers.NamedInsensitiveDataManager;

import org.bukkit.inventory.ItemStack;
import org.bukkit.plugin.Plugin;

import javax.annotation.Nullable;

/**
 * Nucleus implementation of {@link IKitContext}.
 */
public final class NucleusKitContext extends NamedInsensitiveDataManager<IKit>
        implements IKitContext, IPluginOwned {

    private final Plugin _plugin;

    /**
     * Constructor.
     *
     * @param plugin    The owning plugin.
     * @param dataNode  Config section settings to store and retrieve kit information.
     */
    public NucleusKitContext(Plugin plugin, @Nullable IDataNode dataNode) {
        this(plugin, dataNode, true);
    }

    /**
     * Constructor.
     *
     * @param plugin    The owning plugin.
     * @param dataNode  Config section settings to store and retrieve kit information.
     * @param loadKits  True to load kits from the data node during the constructor.
     */
    public NucleusKitContext(Plugin plugin, @Nullable IDataNode dataNode, boolean loadKits) {
        super(dataNode, false);
        PreCon.notNull(plugin);

        _plugin = plugin;

        if (loadKits)
            load();
    }

    @Override
    public Plugin getPlugin() {
        return _plugin;
    }

    @Override
    public IKit add(String name) {
        PreCon.notNullOrEmpty(name);
        PreCon.validNodeName(name);

        name = getName(name);

        if (contains(name))
            return null;

        IKit kit = new NucleusKit(this, name);
        add(kit);

        return kit;
    }

    @Override
    public IModifiableKit modifyKit(IKit kit) {
        PreCon.notNull(kit);

        IKit current = _map.get(getName(kit));
        if (current == null || kit != current) {
            return null;
        }

        return getModifiableKit(kit);
    }

    @Nullable
    @Override
    protected IKit load(String name, IDataNode kitNode) {
        IKit kit = new NucleusKit(this, getName(name));
        IModifiableKit modKit = getModifiableKit(kit);
        assert modKit != null;

        ItemStack[] items = kitNode.getItemStacks("items");
        ItemStack[] armor = kitNode.getItemStacks("armor");

        if (items != null)
            modKit.addItems(items);

        if (armor != null)
            modKit.addAnyItems(armor);

        return kit;
    }

    @Nullable
    @Override
    protected void save(IKit kit, IDataNode node) {
        node.set("items", kit.getItems());
        node.set("armor", kit.getArmor());
    }

    protected void save(IKit item) {
        if (_dataNode == null)
            return;

        IDataNode dataNode = _dataNode.getNode(getName(item));
        save(item, dataNode);
        dataNode.save();
    }

    /**
     * Get a {@link IModifiableKit} used to modify the contents
     * of the specified {@link IKit}.
     *
     * @param kit  The kit to modify.
     *
     * @return  Null if the kit cannot be modified.
     */
    private IModifiableKit getModifiableKit(IKit kit) {
        if (kit instanceof NucleusKit) {
            return new NucleusKitModifier(this, (NucleusKit)kit);
        }
        return null;
    }
}