API doc fixes
This commit is contained in:
@@ -1,6 +1,5 @@
|
|||||||
package com.raoulvdberge.refinedstorage.api.autocrafting.craftingmonitor;
|
package com.raoulvdberge.refinedstorage.api.autocrafting.craftingmonitor;
|
||||||
|
|
||||||
import java.util.Collection;
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
|
||||||
public interface ICraftingMonitorElementList {
|
public interface ICraftingMonitorElementList {
|
||||||
@@ -19,13 +18,6 @@ public interface ICraftingMonitorElementList {
|
|||||||
*/
|
*/
|
||||||
void add(ICraftingMonitorElement element);
|
void add(ICraftingMonitorElement element);
|
||||||
|
|
||||||
/**
|
|
||||||
* @param elements a {@link Collection} of {@link ICraftingMonitorElement}s to be added
|
|
||||||
*/
|
|
||||||
default void addAll(Collection<ICraftingMonitorElement> elements) {
|
|
||||||
elements.forEach(this::add);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Finishes a current merge operation.
|
* Finishes a current merge operation.
|
||||||
*/
|
*/
|
||||||
@@ -34,7 +26,7 @@ public interface ICraftingMonitorElementList {
|
|||||||
/**
|
/**
|
||||||
* This also commits the last changes.
|
* This also commits the last changes.
|
||||||
*
|
*
|
||||||
* @return Get the current list of elements
|
* @return the current list of elements
|
||||||
*/
|
*/
|
||||||
List<ICraftingMonitorElement> getElements();
|
List<ICraftingMonitorElement> getElements();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,6 +5,9 @@ import io.netty.buffer.ByteBuf;
|
|||||||
import net.minecraftforge.fml.relauncher.Side;
|
import net.minecraftforge.fml.relauncher.Side;
|
||||||
import net.minecraftforge.fml.relauncher.SideOnly;
|
import net.minecraftforge.fml.relauncher.SideOnly;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents a crafting preview element.
|
||||||
|
*/
|
||||||
public interface ICraftingPreviewElement<T> {
|
public interface ICraftingPreviewElement<T> {
|
||||||
/**
|
/**
|
||||||
* @return the underlying element to display
|
* @return the underlying element to display
|
||||||
@@ -30,9 +33,9 @@ public interface ICraftingPreviewElement<T> {
|
|||||||
int getToCraft();
|
int getToCraft();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* When this is true {@link #getToCraft()} will be the missing items
|
* When this is true {@link #getToCraft()} will be the missing items.
|
||||||
*
|
*
|
||||||
* @return true when items are missing
|
* @return true when items are missing, false otherwise
|
||||||
*/
|
*/
|
||||||
boolean hasMissing();
|
boolean hasMissing();
|
||||||
|
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ public interface ICraftingTask {
|
|||||||
int getQuantity();
|
int getQuantity();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return the stack requested
|
* @return the stack requested, or null if no specific stack is associated with this task
|
||||||
*/
|
*/
|
||||||
@Nullable
|
@Nullable
|
||||||
ItemStack getRequested();
|
ItemStack getRequested();
|
||||||
@@ -79,7 +79,7 @@ public interface ICraftingTask {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@link ICraftingTask#calculate()} must be run before this
|
* {@link ICraftingTask#calculate()} must be run before this!
|
||||||
*
|
*
|
||||||
* @return the elements of this task for display in the crafting monitor
|
* @return the elements of this task for display in the crafting monitor
|
||||||
*/
|
*/
|
||||||
@@ -91,9 +91,9 @@ public interface ICraftingTask {
|
|||||||
ICraftingPattern getPattern();
|
ICraftingPattern getPattern();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@link ICraftingTask#calculate()} must be run before this
|
* {@link ICraftingTask#calculate()} must be run before this!
|
||||||
*
|
*
|
||||||
* @return the processable items in this task
|
* @return the steps for this task
|
||||||
*/
|
*/
|
||||||
List<ICraftingStep> getSteps();
|
List<ICraftingStep> getSteps();
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import com.raoulvdberge.refinedstorage.api.autocrafting.preview.ICraftingPreview
|
|||||||
* This {@link FunctionalInterface} is used to define a draw/render function.
|
* This {@link FunctionalInterface} is used to define a draw/render function.
|
||||||
* This function use x and y coords and the element to draw.
|
* This function use x and y coords and the element to draw.
|
||||||
* Usually packaged in a {@link IElementDrawers}.
|
* Usually packaged in a {@link IElementDrawers}.
|
||||||
* Used in {@link ICraftingPreviewElement#draw(int, int, IElementDrawers)} and {@link ICraftingMonitorElement#draw(int, int, IElementDrawers)}
|
* Used in {@link ICraftingPreviewElement#draw(int, int, IElementDrawers)} and {@link ICraftingMonitorElement#draw(int, int, IElementDrawers)}.
|
||||||
*
|
*
|
||||||
* @param <T> the element to draw, usually {@link String}, {@link net.minecraft.item.ItemStack} or {@link net.minecraftforge.fluids.FluidStack}
|
* @param <T> the element to draw, usually {@link String}, {@link net.minecraft.item.ItemStack} or {@link net.minecraftforge.fluids.FluidStack}
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -103,7 +103,7 @@ public interface IFluidStackList {
|
|||||||
void clear();
|
void clear();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes all stacks with size zero
|
* Removes all stacks with size zero.
|
||||||
*/
|
*/
|
||||||
void clean();
|
void clean();
|
||||||
|
|
||||||
|
|||||||
@@ -64,10 +64,13 @@ public interface IItemStackList {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Restore all tracked removes
|
* Restore all tracked removes.
|
||||||
*/
|
*/
|
||||||
void undo();
|
void undo();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return the remove tracker
|
||||||
|
*/
|
||||||
List<ItemStack> getRemoveTracker();
|
List<ItemStack> getRemoveTracker();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user