diff options
| author | shedaniel <daniel@shedaniel.me> | 2020-07-29 12:25:47 +0800 |
|---|---|---|
| committer | shedaniel <daniel@shedaniel.me> | 2020-07-29 14:25:53 +0800 |
| commit | ba446965dad004cb38679f0f0e1a526151d84213 (patch) | |
| tree | 60fe2736316a63d47cf533a02bf29fbd5045b91c /RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/EntryRegistry.java | |
| parent | 929ca0ed6de9dd25208304cd0f51a8f2d0f22ceb (diff) | |
| download | RoughlyEnoughItems-ba446965dad004cb38679f0f0e1a526151d84213.tar.gz RoughlyEnoughItems-ba446965dad004cb38679f0f0e1a526151d84213.tar.bz2 RoughlyEnoughItems-ba446965dad004cb38679f0f0e1a526151d84213.zip | |
5.x - 20w30a
Signed-off-by: shedaniel <daniel@shedaniel.me>
Diffstat (limited to 'RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/EntryRegistry.java')
| -rw-r--r-- | RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/EntryRegistry.java | 158 |
1 files changed, 158 insertions, 0 deletions
diff --git a/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/EntryRegistry.java b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/EntryRegistry.java new file mode 100644 index 000000000..fd7fac2d8 --- /dev/null +++ b/RoughlyEnoughItems-api/src/main/java/me/shedaniel/rei/api/EntryRegistry.java @@ -0,0 +1,158 @@ +/* + * This file is licensed under the MIT License, part of Roughly Enough Items. + * Copyright (c) 2018, 2019, 2020 shedaniel + * + * 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 me.shedaniel.rei.api; + +import me.shedaniel.rei.impl.Internals; +import net.fabricmc.api.EnvType; +import net.fabricmc.api.Environment; +import net.minecraft.item.Item; +import net.minecraft.item.ItemStack; +import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.function.Predicate; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +@Environment(EnvType.CLIENT) +public interface EntryRegistry { + + /** + * @return the instance of {@link me.shedaniel.rei.api.EntryRegistry} + */ + @NotNull + static EntryRegistry getInstance() { + return Internals.getEntryRegistry(); + } + + /** + * Gets the current modifiable stacks list + * + * @return a stacks list + */ + @Deprecated + @ApiStatus.ScheduledForRemoval + @NotNull + default List<EntryStack> getStacksList() { + return getEntryStacks().collect(Collectors.toList()); + } + + @NotNull + Stream<EntryStack> getEntryStacks(); + + @NotNull + List<EntryStack> getPreFilteredList(); + + @ApiStatus.Experimental + void refilter(); + + @NotNull + List<ItemStack> appendStacksForItem(@NotNull Item item); + + /** + * Gets all possible stacks from an item + * + * @param item the item to find + * @return the array of possible stacks + */ + @NotNull + ItemStack[] getAllStacksFromItem(@NotNull Item item); + + default void registerEntry(@NotNull EntryStack stack) { + registerEntryAfter(null, stack); + } + + /** + * Registers an new stack to the entry list + * + * @param afterEntry the stack to put after + * @param stack the stack to register + */ + void registerEntryAfter(@Nullable EntryStack afterEntry, @NotNull EntryStack stack); + + /** + * Registers an new stack to the entry list + * + * @param afterEntry the stack to put after + * @param stack the stack to register + * @param checkAlreadyContains whether the list should check if it is already on the list + * @see #queueRegisterEntryAfter(EntryStack, Collection) for a faster method + */ + @Deprecated + @ApiStatus.ScheduledForRemoval + default void registerEntryAfter(@Nullable EntryStack afterEntry, @NotNull EntryStack stack, boolean checkAlreadyContains) { + registerEntryAfter(afterEntry, stack); + } + + @Deprecated + @ApiStatus.ScheduledForRemoval + default void queueRegisterEntryAfter(@Nullable EntryStack afterEntry, @NotNull Collection<@NotNull ? extends EntryStack> stacks) { + registerEntriesAfter(afterEntry, stacks); + } + + /** + * Registers multiple stacks to the item list + * + * @param afterStack the stack to put after + * @param stacks the stacks to register + */ + default void registerEntriesAfter(@Nullable EntryStack afterStack, @NotNull EntryStack... stacks) { + registerEntriesAfter(afterStack, Arrays.asList(stacks)); + } + + /** + * Registers multiple stacks to the item list + * + * @param afterStack the stack to put after + * @param stacks the stacks to register + */ + void registerEntriesAfter(@Nullable EntryStack afterStack, @NotNull Collection<@NotNull ? extends EntryStack> stacks); + + /** + * Registers multiple stacks to the item list + * + * @param stacks the stacks to register + */ + default void registerEntries(@NotNull EntryStack... stacks) { + registerEntriesAfter(null, stacks); + } + + /** + * Checks if a stack is already registered + * + * @param stack the stack to check + * @return whether the stack has been registered + */ + boolean alreadyContain(EntryStack stack); + + @ApiStatus.Experimental + void removeEntry(EntryStack stack); + + @ApiStatus.Experimental + void removeEntryIf(Predicate<EntryStack> stackPredicate); +} |
