Closes #1054: Adds an Inscriber API for Developers

src/api/java/appeng/api/features/IInscriberRecipe.java

@@ -0,0 +1,65 @@
+package appeng.api.features;
+
+
+import java.util.List;
+import javax.annotation.Nonnull;
+
+import net.minecraft.item.ItemStack;
+
+import com.google.common.base.Optional;
+
+
+/**
+ * Registration Records for {@link IInscriberRegistry}
+ *
+ * You have to pay attention though, that recipes are not mirrored,
+ * where the top and bottom slots are switching places.
+ *
+ * This is applied on runtime.
+ *
+ * @author thatsIch
+ * @version rv2
+ * @since rv2
+ */
+public interface IInscriberRecipe
+{
+	/**
+	 * the current inputs
+	 *
+	 * @return inputs the inscriber will accept
+	 */
+	@Nonnull
+	List<ItemStack> getInputs();
+
+	/**
+	 * gets the current output
+	 *
+	 * @return output that the recipe will produce
+	 */
+	@Nonnull
+	ItemStack getOutput();
+
+	/**
+	 * gets the top optional
+	 *
+	 * @return item which is used top
+	 */
+	@Nonnull
+	Optional<ItemStack> getTopOptional();
+
+	/**
+	 * gets the bottom optional
+	 *
+	 * @return item which is used bottom
+	 */
+	@Nonnull
+	Optional<ItemStack> getBottomOptional();
+
+	/**
+	 * type of inscriber process
+	 *
+	 * @return type of process the inscriber is doing
+	 */
+	@Nonnull
+	InscriberProcessType getProcessType();
+}

src/api/java/appeng/api/features/IInscriberRecipeBuilder.java

@@ -0,0 +1,88 @@
+package appeng.api.features;
+
+
+import java.util.Collection;
+import javax.annotation.Nonnull;
+
+import net.minecraft.item.ItemStack;
+
+
+/**
+ * Builder for an inscriber recipe
+ *
+ * @author thatsIch
+ * @version rv2
+ * @since rv2
+ */
+public interface IInscriberRecipeBuilder
+{
+	/**
+	 * Creates an inscriber recipe with inputs.
+	 * Needs to be invoked.
+	 *
+	 * @param inputs new inputs for the recipe
+	 *
+	 * @return currently used builder
+	 */
+	@Nonnull
+	IInscriberRecipeBuilder withInputs( @Nonnull Collection<ItemStack> inputs );
+
+	/**
+	 * Creates an inscriber recipe with output.
+	 * Needs to be invoked.
+	 *
+	 * @param output new output for the recipe
+	 *
+	 * @return currently used builder
+	 */
+	@Nonnull
+	IInscriberRecipeBuilder withOutput( @Nonnull ItemStack output );
+
+	/**
+	 * Creates an inscriber recipe with top.
+	 * Either this or bot needs to be invoked.
+	 *
+	 * @param topOptional new top for the recipe
+	 *
+	 * @return currently used builder
+	 */
+	@Nonnull
+	IInscriberRecipeBuilder withTopOptional( @Nonnull ItemStack topOptional );
+
+	/**
+	 * Creates an inscriber recipe with bot.
+	 * Either this or top needs to be invoked.
+	 *
+	 * @param bottomOptional new bot for the recipe
+	 *
+	 * @return currently used builder
+	 */
+	@Nonnull
+	IInscriberRecipeBuilder withBottomOptional( @Nonnull ItemStack bottomOptional );
+
+	/**
+	 * Creates an inscriber recipe with type.
+	 * Needs to be invoked.
+	 *
+	 * @param type new type for the recipe
+	 *
+	 * @return currently used builder
+	 */
+	@Nonnull
+	IInscriberRecipeBuilder withProcessType( @Nonnull InscriberProcessType type );
+
+	/**
+	 * Finalizes the process of making the recipe.
+	 * Needs to be invoked to fetch inscriber recipe.
+	 *
+	 * @return legal inscriber recipe
+	 *
+	 * @throws IllegalStateException when input is not defined
+	 * @throws IllegalStateException when input has no size
+	 * @throws IllegalStateException when output is not defined
+	 * @throws IllegalStateException when both optionals are not defined
+	 * @throws IllegalStateException when process type is not defined
+	 */
+	@Nonnull
+	IInscriberRecipe build();
+}

src/api/java/appeng/api/features/IInscriberRegistry.java

@@ -0,0 +1,69 @@
+package appeng.api.features;
+
+
+import java.util.List;
+import java.util.Set;
+import javax.annotation.Nonnull;
+
+import net.minecraft.item.ItemStack;
+
+
+/**
+ * Lets you manipulate Inscriber Recipes, by adding or editing existing ones.
+ *
+ * @author thatsIch
+ * @version rv2
+ * @since rv2
+ */
+public interface IInscriberRegistry
+{
+	/**
+	 * Current list of registered recipes, you can modify this if you want too.
+	 * Will never contain a null recipe
+	 *
+	 * @return currentlyRegisteredRecipes
+	 */
+	@Nonnull
+	List<IInscriberRecipe> getRecipes();
+
+	/**
+	 * Optional items which are used in the top or bottom slot
+	 *
+	 * @return set of all optional items
+	 */
+	@Nonnull
+	Set<ItemStack> getOptionals();
+
+	/**
+	 * Get all registered items which are valid inputs
+	 *
+	 * @return set of all input items
+	 */
+	@Nonnull
+	Set<ItemStack> getInputs();
+
+	/**
+	 * Extensible way to create an inscriber recipe
+	 *
+	 * @return builder for inscriber recipes
+	 */
+	@Nonnull
+	IInscriberRecipeBuilder builder();
+
+	/**
+	 * add a new recipe the easy way, duplicates will not be added.
+	 * Added recipes will be automatically added to the optionals and inputs.
+	 *
+	 * @param recipe new recipe
+	 *
+	 * @throws IllegalArgumentException if null is added
+	 */
+	void addRecipe( IInscriberRecipe recipe );
+
+	/**
+	 * Removes a recipe from the registry
+	 *
+	 * @param toBeRemovedRecipe to be removed recipe, can be null, makes just no sense
+	 */
+	void removeRecipe( IInscriberRecipe toBeRemovedRecipe );
+}

src/api/java/appeng/api/features/IRegistryContainer.java

@@ -30,6 +30,12 @@ import appeng.api.storage.ICellRegistry;
 import appeng.api.storage.IExternalStorageRegistry;
 
 
+/**
+ * @author AlgorithmX2
+ * @author thatsIch
+ * @version rv2
+ * @since rv0
+ */
 public interface IRegistryContainer
 {
 
@@ -69,6 +75,11 @@ public interface IRegistryContainer
 	 */
 	IGrinderRegistry grinder();
 
+	/**
+	 * Manage inscriber recipes via API
+	 */
+	IInscriberRegistry inscriber();
+
 	/**
 	 * get access to the locatable registry
 	 */

src/api/java/appeng/api/features/InscriberProcessType.java

@@ -0,0 +1,15 @@
+package appeng.api.features;
+
+
+public enum InscriberProcessType
+{
+	/**
+	 * uses the optionals as catalyst
+	 */
+	Inscribe,
+
+	/**
+	 * spends the optionals
+	 */
+	Press
+}