#831: Add a standard of annotations for Minecraft experimental things and API

By: Doc <nachito94@msn.com>
Also-by: 2008Choco <hawkeboyz2@hotmail.com>
This commit is contained in:
Bukkit/Spigot
2023-04-07 09:41:58 +10:00
parent 0bf4318605
commit bec81a9aff
40 changed files with 559 additions and 36 deletions

View File

@@ -1,11 +1,15 @@
package org.bukkit.inventory;
import org.bukkit.MinecraftExperimental;
import org.bukkit.block.ChiseledBookshelf;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.Nullable;
/**
* Interface to the inventory of a chiseled bookshelf.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface ChiseledBookshelfInventory extends Inventory {
@Nullable

View File

@@ -1,5 +1,8 @@
package org.bukkit.inventory;
import org.bukkit.MinecraftExperimental;
import org.jetbrains.annotations.ApiStatus;
/**
* A ItemFlag can hide some Attributes from ItemStacks
*/
@@ -37,5 +40,7 @@ public enum ItemFlag {
/**
* Setting to show/hide armor trim from leather armor.
*/
@MinecraftExperimental
@ApiStatus.Experimental
HIDE_ARMOR_TRIM;
}

View File

@@ -1,10 +1,15 @@
package org.bukkit.inventory;
import org.bukkit.MinecraftExperimental;
import org.jetbrains.annotations.Nullable;
/**
* Interface to the inventory of a Smithing table.
*
* @apiNote Check {@link #getType()} to better handle either the current or experimental
* variant of this inventory
*/
@MinecraftExperimental
public interface SmithingInventory extends Inventory {
/**

View File

@@ -1,12 +1,19 @@
package org.bukkit.inventory;
import org.bukkit.Material;
import org.bukkit.MinecraftExperimental;
import org.bukkit.NamespacedKey;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
/**
* Represents a smithing trim recipe.
*
* @apiNote This recipe is part of an experimental feature of Minecraft and
* hence subject to change.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public class SmithingTrimRecipe extends SmithingRecipe implements ComplexRecipe {
private final RecipeChoice template;

View File

@@ -1,10 +1,14 @@
package org.bukkit.inventory.meta;
import java.util.List;
import org.bukkit.MinecraftExperimental;
import org.bukkit.inventory.ItemStack;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@MinecraftExperimental
@ApiStatus.Experimental
public interface BundleMeta extends ItemMeta {
/**

View File

@@ -1,8 +1,10 @@
package org.bukkit.inventory.meta;
import org.bukkit.MinecraftExperimental;
import org.bukkit.NamespacedKey;
import org.bukkit.OfflinePlayer;
import org.bukkit.profile.PlayerProfile;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -88,6 +90,8 @@ public interface SkullMeta extends ItemMeta {
*
* @param noteBlockSound the key of the sound to be played, or null
*/
@MinecraftExperimental
@ApiStatus.Experimental
void setNoteBlockSound(@Nullable NamespacedKey noteBlockSound);
/**
@@ -98,6 +102,8 @@ public interface SkullMeta extends ItemMeta {
*
* @return the key of the sound, or null
*/
@MinecraftExperimental
@ApiStatus.Experimental
@Nullable
NamespacedKey getNoteBlockSound();