/*
 * This file is part of LanternServer, licensed under the MIT License (MIT).
 *
 * Copyright (c) LanternPowered <https://www.lanternpowered.org>
 * Copyright (c) SpongePowered <https://www.spongepowered.org>
 * Copyright (c) contributors
 *
 * 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 org.lanternpowered.api.script.function.condition;

import com.google.common.collect.ImmutableList;
import org.lanternpowered.api.script.ScriptContext;
import org.lanternpowered.api.script.Parameter;

/**
 * Represents a condition that must return true in order for
 * a specific action to be executed.
 */
@FunctionalInterface
public interface Condition {

    static AndCondition and(Iterable<Condition> conditions) {
        return new AndCondition(ImmutableList.copyOf(conditions));
    }

    static AndCondition and(Condition... conditions) {
        return new AndCondition(ImmutableList.copyOf(conditions));
    }

    static OrCondition or(Iterable<Condition> conditions) {
        return new OrCondition(ImmutableList.copyOf(conditions));
    }

    static OrCondition or(Condition... conditions) {
        return new OrCondition(ImmutableList.copyOf(conditions));
    }

    /**
     * Gets the result of this condition for the specified {@link ScriptContext}.
     *
     * @param scriptContext The script context
     * @return The result
     */
    boolean test(@Parameter(ScriptContext.CONTEXT_PARAMETER) ScriptContext scriptContext);

}