org.spongepowered.api.item.recipe.crafting.CraftingRecipe Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
There is a newer version: 9.0.0
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * 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.spongepowered.api.item.recipe.crafting;

import org.spongepowered.api.Sponge;
import org.spongepowered.api.item.inventory.crafting.CraftingInventory;
import org.spongepowered.api.item.recipe.Recipe;
import org.spongepowered.api.item.recipe.RecipeType;

import java.util.Optional;

/**
 * A CraftingRecipe represents some craftable recipe in the game.
 * Currently supported crafting recipe types are:
 * {@link ShapelessCraftingRecipe} for recipes with simple ingredients/result without pattern in a {@link CraftingInventory}
 * {@link ShapedCraftingRecipe} for recipes with simple ingredients/result in a pattern in a {@link CraftingInventory}
 * {@link SpecialCraftingRecipe} for recipes with complex ingredients and result in a {@link CraftingInventory}
 */
public interface CraftingRecipe extends Recipe {

    @Override
    RecipeType type();

    /**
     * The group this CraftingRecipe belongs to or {@link Optional#empty()} if not defined.
     * This value is used to group recipes in the recipe book.
     *
     * @return The group this Recipe belongs to.
     */
    Optional group();

    /**
     * Provides a builder for a {@link ShapedCraftingRecipe}.
     *
     * @return The builder.
     */
    static ShapedCraftingRecipe.Builder shapedBuilder() {
        return Sponge.game().builderProvider().provide(ShapedCraftingRecipe.Builder.class);
    }

    /**
     * Provides a builder for a {@link ShapelessCraftingRecipe}.
     *
     * @return The builder.
     */
    static ShapelessCraftingRecipe.Builder shapelessBuilder() {
        return Sponge.game().builderProvider().provide(ShapelessCraftingRecipe.Builder.class);
    }

    /**
     * Provides a builder for a {@link SpecialCraftingRecipe}
     *
     * @return The builder.
     */
    static SpecialCraftingRecipe.Builder specialBuilder() {
        return Sponge.game().builderProvider().provide(SpecialCraftingRecipe.Builder.class);
    }

}