SPIGOT-2540: Add nullability annotations to entire Bukkit API

By: Darkyenus <darkyenus@gmail.com>
This commit is contained in:
Bukkit/Spigot
2019-03-13 17:42:57 +11:00
parent e069a80fd8
commit 416c865476
565 changed files with 5372 additions and 2008 deletions

View File

@@ -11,6 +11,7 @@ import org.bukkit.event.HandlerList;
import org.bukkit.event.inventory.InventoryEvent;
import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull;
/**
* Called when an ItemStack is successfully enchanted (currently at
@@ -26,7 +27,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
private final Player enchanter;
private int button;
public EnchantItemEvent(final Player enchanter, final InventoryView view, final Block table, final ItemStack item, final int level, final Map<Enchantment, Integer> enchants, final int i) {
public EnchantItemEvent(@NotNull final Player enchanter, @NotNull final InventoryView view, @NotNull final Block table, @NotNull final ItemStack item, final int level, @NotNull final Map<Enchantment, Integer> enchants, final int i) {
super(view);
this.enchanter = enchanter;
this.table = table;
@@ -42,6 +43,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
*
* @return enchanting player
*/
@NotNull
public Player getEnchanter() {
return enchanter;
}
@@ -51,6 +53,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
*
* @return the block used for enchanting
*/
@NotNull
public Block getEnchantBlock() {
return table;
}
@@ -60,6 +63,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
*
* @return ItemStack of item
*/
@NotNull
public ItemStack getItem() {
return item;
}
@@ -89,6 +93,7 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
*
* @return map of enchantment levels, keyed by enchantment
*/
@NotNull
public Map<Enchantment, Integer> getEnchantsToAdd() {
return enchants;
}
@@ -110,11 +115,13 @@ public class EnchantItemEvent extends InventoryEvent implements Cancellable {
this.cancelled = cancel;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}

View File

@@ -8,6 +8,7 @@ import org.bukkit.event.HandlerList;
import org.bukkit.event.inventory.InventoryEvent;
import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.NotNull;
/**
* Called when an ItemStack is inserted in an enchantment table - can be
@@ -22,7 +23,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
private boolean cancelled;
private final Player enchanter;
public PrepareItemEnchantEvent(final Player enchanter, InventoryView view, final Block table, final ItemStack item, final EnchantmentOffer[] offers, final int bonus) {
public PrepareItemEnchantEvent(@NotNull final Player enchanter, @NotNull InventoryView view, @NotNull final Block table, @NotNull final ItemStack item, @NotNull final EnchantmentOffer[] offers, final int bonus) {
super(view);
this.enchanter = enchanter;
this.table = table;
@@ -36,6 +37,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
*
* @return enchanting player
*/
@NotNull
public Player getEnchanter() {
return enchanter;
}
@@ -45,6 +47,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
*
* @return the block used for enchanting
*/
@NotNull
public Block getEnchantBlock() {
return table;
}
@@ -54,6 +57,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
*
* @return ItemStack of item
*/
@NotNull
public ItemStack getItem() {
return item;
}
@@ -64,6 +68,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
* @return experience level costs offered
* @deprecated Use {@link #getOffers()} instead of this method
*/
@NotNull
public int[] getExpLevelCostsOffered() {
int[] levelOffers = new int[offers.length];
for (int i = 0; i < offers.length; i++) {
@@ -80,6 +85,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
*
* @return list of available enchantment offers
*/
@NotNull
public EnchantmentOffer[] getOffers() {
return offers;
}
@@ -103,11 +109,13 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab
this.cancelled = cancel;
}
@NotNull
@Override
public HandlerList getHandlers() {
return handlers;
}
@NotNull
public static HandlerList getHandlerList() {
return handlers;
}