SAPI_Locations.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.managed.scripting.api;

import com.jcwhatever.nucleus.Nucleus;
import com.jcwhatever.nucleus.mixins.IDisposable;
import com.jcwhatever.nucleus.utils.PreCon;
import com.jcwhatever.nucleus.utils.coords.NamedLocation;

import org.bukkit.Location;

import java.util.Collection;
import javax.annotation.Nullable;

/**
 * Sub script API for named locations that can be retrieved by scripts.
 */
public class SAPI_Locations implements IDisposable {

    private boolean _isDisposed;

    @Override
    public boolean isDisposed() {
        return _isDisposed;
    }

    @Override
    public void dispose() {
        _isDisposed = true;
    }

    /**
     * Get a quest script location by name.
     *
     * @param name  The name of the location.
     */
    @Nullable
    public Location get(String name) {
        PreCon.notNullOrEmpty(name);

        NamedLocation result = Nucleus.getScriptManager().getLocations().get(name);
        if (result == null)
            return null;

        return result.toLocation();
    }

    /**
     * Get all script location objects.
     */
    public Collection<NamedLocation> getScriptLocations() {
        return Nucleus.getScriptManager().getLocations().getAll();
    }

    /**
     * Get all script location objects.
     *
     * @param output  The output collection to put results into.
     *
     * @return  The output collection.
     */
    public <T extends Collection<NamedLocation>> T getScriptLocations(T output) {
        PreCon.notNull(output);
        
        return Nucleus.getScriptManager().getLocations().getAll(output);
    }
}