#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

@@ -2,7 +2,9 @@ package org.bukkit.block;
import java.util.Locale;
import org.bukkit.Keyed;
import org.bukkit.MinecraftExperimental;
import org.bukkit.NamespacedKey;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
/**
@@ -72,6 +74,8 @@ public enum Biome implements Keyed {
FROZEN_PEAKS,
JAGGED_PEAKS,
STONY_PEAKS,
@MinecraftExperimental
@ApiStatus.Experimental
CHERRY_GROVE,
/**
* Represents a custom Biome

View File

@@ -1,12 +1,16 @@
package org.bukkit.block;
import org.bukkit.MinecraftExperimental;
import org.bukkit.inventory.BlockInventoryHolder;
import org.bukkit.inventory.ChiseledBookshelfInventory;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
/**
* Represents a captured state of a chiseled bookshelf.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface ChiseledBookshelf extends TileState, BlockInventoryHolder {
/**

View File

@@ -2,12 +2,16 @@ package org.bukkit.block;
import java.util.List;
import org.bukkit.Material;
import org.bukkit.MinecraftExperimental;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Represents a captured state of a decorated pot.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface DecoratedPot extends TileState {
/**

View File

@@ -1,7 +1,12 @@
package org.bukkit.block;
import org.bukkit.MinecraftExperimental;
import org.jetbrains.annotations.ApiStatus;
/**
* Represents a captured state of a hanging sign.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface HangingSign extends Sign {
}

View File

@@ -1,11 +1,13 @@
package org.bukkit.block;
import org.bukkit.Material;
import org.bukkit.MinecraftExperimental;
import org.bukkit.NamespacedKey;
import org.bukkit.OfflinePlayer;
import org.bukkit.SkullType;
import org.bukkit.block.data.BlockData;
import org.bukkit.profile.PlayerProfile;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -94,6 +96,8 @@ public interface Skull extends TileState {
*
* @return the key of the sound, or null
*/
@MinecraftExperimental
@ApiStatus.Experimental
@Nullable
public NamespacedKey getNoteBlockSound();
@@ -104,7 +108,10 @@ public interface Skull extends TileState {
* see {@link org.bukkit.Instrument}.
*
* @param noteBlockSound the key of the sound to be played, or null
*
*/
@MinecraftExperimental
@ApiStatus.Experimental
public void setNoteBlockSound(@Nullable NamespacedKey noteBlockSound);
/**

View File

@@ -1,12 +1,16 @@
package org.bukkit.block;
import org.bukkit.MinecraftExperimental;
import org.bukkit.inventory.ItemStack;
import org.bukkit.loot.Lootable;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.Nullable;
/**
* Represents a captured state of suspicious sand.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface SuspiciousSand extends Lootable, TileState {
/**

View File

@@ -1,7 +1,9 @@
package org.bukkit.block.data.type;
import java.util.Set;
import org.bukkit.MinecraftExperimental;
import org.bukkit.block.data.Directional;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
/**
@@ -11,6 +13,8 @@ import org.jetbrains.annotations.NotNull;
* <br>
* Block may have 0, 1... {@link #getMaximumOccupiedSlots()}-1 occupied slots.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface ChiseledBookshelf extends Directional {
/**

View File

@@ -1,7 +1,11 @@
package org.bukkit.block.data.type;
import org.bukkit.MinecraftExperimental;
import org.bukkit.block.data.Directional;
import org.bukkit.block.data.Waterlogged;
import org.jetbrains.annotations.ApiStatus;
@MinecraftExperimental
@ApiStatus.Experimental
public interface DecoratedPot extends Directional, Waterlogged {
}

View File

@@ -1,8 +1,12 @@
package org.bukkit.block.data.type;
import org.bukkit.MinecraftExperimental;
import org.bukkit.block.data.Attachable;
import org.bukkit.block.data.Rotatable;
import org.bukkit.block.data.Waterlogged;
import org.jetbrains.annotations.ApiStatus;
@MinecraftExperimental
@ApiStatus.Experimental
public interface HangingSign extends Attachable, Rotatable, Waterlogged {
}

View File

@@ -1,10 +1,14 @@
package org.bukkit.block.data.type;
import org.bukkit.MinecraftExperimental;
import org.bukkit.block.data.Directional;
import org.jetbrains.annotations.ApiStatus;
/**
* 'flower_amount' represents the number of petals.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface PinkPetals extends Directional {
/**

View File

@@ -1,10 +1,14 @@
package org.bukkit.block.data.type;
import org.bukkit.MinecraftExperimental;
import org.bukkit.block.data.BlockData;
import org.jetbrains.annotations.ApiStatus;
/**
* 'dusted' represents how far uncovered by brush the block is.
*/
@MinecraftExperimental
@ApiStatus.Experimental
public interface SuspiciousSand extends BlockData {
/**

View File

@@ -1,7 +1,11 @@
package org.bukkit.block.data.type;
import org.bukkit.MinecraftExperimental;
import org.bukkit.block.data.Directional;
import org.bukkit.block.data.Waterlogged;
import org.jetbrains.annotations.ApiStatus;
@MinecraftExperimental
@ApiStatus.Experimental
public interface WallHangingSign extends Directional, Waterlogged {
}