#1064: Add specific getTopInventory methods for InventoryView derivatives

By: Miles Holder <mwholder@proton.me>
This commit is contained in:
Bukkit/Spigot 2024-10-06 18:45:07 +11:00
parent 68492a4f7e
commit 196d06aa91
10 changed files with 56 additions and 0 deletions

View File

@ -1,6 +1,8 @@
package org.bukkit.inventory.view; package org.bukkit.inventory.view;
import org.bukkit.inventory.AnvilInventory;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
/** /**
@ -9,6 +11,10 @@ import org.jetbrains.annotations.Nullable;
*/ */
public interface AnvilView extends InventoryView { public interface AnvilView extends InventoryView {
@NotNull
@Override
AnvilInventory getTopInventory();
/** /**
* Gets the rename text specified within the anvil's text field. * Gets the rename text specified within the anvil's text field.
* *

View File

@ -1,7 +1,9 @@
package org.bukkit.inventory.view; package org.bukkit.inventory.view;
import org.bukkit.inventory.BeaconInventory;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.bukkit.potion.PotionEffectType; import org.bukkit.potion.PotionEffectType;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
/** /**
@ -10,6 +12,10 @@ import org.jetbrains.annotations.Nullable;
*/ */
public interface BeaconView extends InventoryView { public interface BeaconView extends InventoryView {
@NotNull
@Override
BeaconInventory getTopInventory();
/** /**
* Gets the tier of the beacon * Gets the tier of the beacon
* <p> * <p>

View File

@ -1,6 +1,8 @@
package org.bukkit.inventory.view; package org.bukkit.inventory.view;
import org.bukkit.inventory.BrewerInventory;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.jetbrains.annotations.NotNull;
/** /**
* An instance of {@link InventoryView} which provides extra methods related to * An instance of {@link InventoryView} which provides extra methods related to
@ -8,6 +10,10 @@ import org.bukkit.inventory.InventoryView;
*/ */
public interface BrewingStandView extends InventoryView { public interface BrewingStandView extends InventoryView {
@NotNull
@Override
BrewerInventory getTopInventory();
/** /**
* Gets the fuel level of this brewing stand. * Gets the fuel level of this brewing stand.
* <p> * <p>

View File

@ -1,6 +1,8 @@
package org.bukkit.inventory.view; package org.bukkit.inventory.view;
import org.bukkit.inventory.CrafterInventory;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.jetbrains.annotations.NotNull;
/** /**
* An instance of {@link InventoryView} which provides extra methods related to * An instance of {@link InventoryView} which provides extra methods related to
@ -8,6 +10,10 @@ import org.bukkit.inventory.InventoryView;
*/ */
public interface CrafterView extends InventoryView { public interface CrafterView extends InventoryView {
@NotNull
@Override
CrafterInventory getTopInventory();
/** /**
* Checks if the given crafter slot is disabled. * Checks if the given crafter slot is disabled.
* *

View File

@ -1,6 +1,7 @@
package org.bukkit.inventory.view; package org.bukkit.inventory.view;
import org.bukkit.enchantments.EnchantmentOffer; import org.bukkit.enchantments.EnchantmentOffer;
import org.bukkit.inventory.EnchantingInventory;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@ -10,6 +11,10 @@ import org.jetbrains.annotations.NotNull;
*/ */
public interface EnchantmentView extends InventoryView { public interface EnchantmentView extends InventoryView {
@NotNull
@Override
EnchantingInventory getTopInventory();
/** /**
* Gets the random enchantment seed used in this view * Gets the random enchantment seed used in this view
* *

View File

@ -1,7 +1,9 @@
package org.bukkit.inventory.view; package org.bukkit.inventory.view;
import org.bukkit.block.Furnace; import org.bukkit.block.Furnace;
import org.bukkit.inventory.FurnaceInventory;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.jetbrains.annotations.NotNull;
/** /**
* An instance of {@link InventoryView} which provides extra methods related to * An instance of {@link InventoryView} which provides extra methods related to
@ -9,6 +11,10 @@ import org.bukkit.inventory.InventoryView;
*/ */
public interface FurnaceView extends InventoryView { public interface FurnaceView extends InventoryView {
@NotNull
@Override
FurnaceInventory getTopInventory();
/** /**
* The cook time for this view. * The cook time for this view.
* <p> * <p>

View File

@ -1,6 +1,8 @@
package org.bukkit.inventory.view; package org.bukkit.inventory.view;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.LecternInventory;
import org.jetbrains.annotations.NotNull;
/** /**
* An instance of {@link InventoryView} which provides extra methods related to * An instance of {@link InventoryView} which provides extra methods related to
@ -8,6 +10,10 @@ import org.bukkit.inventory.InventoryView;
*/ */
public interface LecternView extends InventoryView { public interface LecternView extends InventoryView {
@NotNull
@Override
LecternInventory getTopInventory();
/** /**
* Gets the page that the LecternView is on. * Gets the page that the LecternView is on.
* *

View File

@ -3,6 +3,7 @@ package org.bukkit.inventory.view;
import java.util.List; import java.util.List;
import org.bukkit.block.banner.PatternType; import org.bukkit.block.banner.PatternType;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.LoomInventory;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
/** /**
@ -11,6 +12,10 @@ import org.jetbrains.annotations.NotNull;
*/ */
public interface LoomView extends InventoryView { public interface LoomView extends InventoryView {
@NotNull
@Override
LoomInventory getTopInventory();
/** /**
* Gets a list of all selectable to the player. * Gets a list of all selectable to the player.
* *

View File

@ -2,6 +2,7 @@ package org.bukkit.inventory.view;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.Merchant; import org.bukkit.inventory.Merchant;
import org.bukkit.inventory.MerchantInventory;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
/** /**
@ -10,6 +11,10 @@ import org.jetbrains.annotations.NotNull;
*/ */
public interface MerchantView extends InventoryView { public interface MerchantView extends InventoryView {
@NotNull
@Override
MerchantInventory getTopInventory();
/** /**
* Gets the merchant that this view is for. * Gets the merchant that this view is for.
* *

View File

@ -2,6 +2,7 @@ package org.bukkit.inventory.view;
import java.util.List; import java.util.List;
import org.bukkit.inventory.InventoryView; import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.StonecutterInventory;
import org.bukkit.inventory.StonecuttingRecipe; import org.bukkit.inventory.StonecuttingRecipe;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@ -11,6 +12,10 @@ import org.jetbrains.annotations.NotNull;
*/ */
public interface StonecutterView extends InventoryView { public interface StonecutterView extends InventoryView {
@NotNull
@Override
StonecutterInventory getTopInventory();
/** /**
* Gets the current index of the selected recipe. * Gets the current index of the selected recipe.
* *