/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2013 AlgorithmX2
 *
 * 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 appeng.api.features;


import java.util.Optional;

import javax.annotation.Nonnull;

import net.minecraft.item.ItemStack;


/**
 * Registration Records for {@link IGrinderRegistry}
 */
public interface IGrinderRecipe
{

	/**
	 * the current input
	 *
	 * @return input that the grinder will accept.
	 */
	@Nonnull
	ItemStack getInput();

	/**
	 * gets the current output
	 *
	 * @return output that the grinder will produce
	 */
	@Nonnull
	ItemStack getOutput();

	/**
	 * gets the current output
	 *
	 * @return output that the grinder will produce
	 */
	@Nonnull
	Optional<ItemStack> getOptionalOutput();

	/**
	 * gets the current output
	 *
	 * @return output that the grinder will produce
	 */
	Optional<ItemStack> getSecondOptionalOutput();

	/**
	 * 0.0 - 1.0 the chance that the optional output will be generated.
	 *
	 * @return chance of optional output
	 */
	@Nonnull
	float getOptionalChance();

	/**
	 * 0.0 - 1.0 the chance that the optional output will be generated.
	 *
	 * @return second optional output chance
	 */
	float getSecondOptionalChance();

	/**
	 * Amount of turns required to process the item.
	 *
	 * @return number of turns it takes to produce the output from the input.
	 */
	int getRequiredTurns();

}