Update Maven plugins

By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot 2021-07-03 11:06:15 +10:00
parent 34e6b033ad
commit 6dd24e4af2
25 changed files with 98 additions and 102 deletions

View File

@ -136,7 +136,7 @@
<dependency> <dependency>
<groupId>org.eclipse.jdt</groupId> <groupId>org.eclipse.jdt</groupId>
<artifactId>ecj</artifactId> <artifactId>ecj</artifactId>
<version>3.24.0</version> <version>3.26.0</version>
</dependency> </dependency>
</dependencies> </dependencies>
</plugin> </plugin>
@ -158,7 +158,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId> <artifactId>maven-shade-plugin</artifactId>
<version>3.2.3</version> <version>3.2.4</version>
<executions> <executions>
<execution> <execution>
<phase>package</phase> <phase>package</phase>
@ -183,12 +183,12 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version> <version>3.3.0</version>
<configuration> <configuration>
<links> <links>
<link>https://guava.dev/releases/21.0/api/docs/</link> <link>https://guava.dev/releases/21.0/api/docs/</link>
<link>https://javadoc.io/doc/org.yaml/snakeyaml/1.27/</link> <link>https://javadoc.io/doc/org.yaml/snakeyaml/1.28/</link>
<link>https://javadoc.io/doc/org.jetbrains/annotations-java5/20.1.0/</link> <link>https://javadoc.io/doc/org.jetbrains/annotations-java5/21.0.1/</link>
</links> </links>
</configuration> </configuration>
</plugin> </plugin>
@ -206,7 +206,7 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId> <artifactId>maven-checkstyle-plugin</artifactId>
<version>3.1.1</version> <version>3.1.2</version>
<executions> <executions>
<execution> <execution>
<phase>process-classes</phase> <phase>process-classes</phase>
@ -223,14 +223,14 @@
<dependency> <dependency>
<groupId>com.puppycrawl.tools</groupId> <groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId> <artifactId>checkstyle</artifactId>
<version>8.39</version> <version>8.44</version>
</dependency> </dependency>
</dependencies> </dependencies>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.codehaus.mojo</groupId> <groupId>org.codehaus.mojo</groupId>
<artifactId>animal-sniffer-maven-plugin</artifactId> <artifactId>animal-sniffer-maven-plugin</artifactId>
<version>1.19</version> <version>1.20</version>
<executions> <executions>
<execution> <execution>
<phase>process-classes</phase> <phase>process-classes</phase>

View File

@ -883,11 +883,11 @@ public final class Bukkit {
* This will return an object even if the player does not exist. To this * This will return an object even if the player does not exist. To this
* method, all players will exist. * method, all players will exist.
* *
* @deprecated Persistent storage of users should be by UUID as names are no longer
* unique past a single session.
* @param name the name the player to retrieve * @param name the name the player to retrieve
* @return an offline player * @return an offline player
* @see #getOfflinePlayer(java.util.UUID) * @see #getOfflinePlayer(java.util.UUID)
* @deprecated Persistent storage of users should be by UUID as names are no longer
* unique past a single session.
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -1278,11 +1278,11 @@ public final class Bukkit {
* guaranteed to throw an implementation-defined {@link Exception}. * guaranteed to throw an implementation-defined {@link Exception}.
* *
* @param file the file to load the from * @param file the file to load the from
* @return a cached server-icon that can be used for a {@link
* ServerListPingEvent#setServerIcon(CachedServerIcon)}
* @throws IllegalArgumentException if image is null * @throws IllegalArgumentException if image is null
* @throws Exception if the image does not meet current server server-icon * @throws Exception if the image does not meet current server server-icon
* specifications * specifications
* @return a cached server-icon that can be used for a {@link
* ServerListPingEvent#setServerIcon(CachedServerIcon)}
*/ */
@NotNull @NotNull
public static CachedServerIcon loadServerIcon(@NotNull File file) throws IllegalArgumentException, Exception { public static CachedServerIcon loadServerIcon(@NotNull File file) throws IllegalArgumentException, Exception {
@ -1296,11 +1296,11 @@ public final class Bukkit {
* guaranteed to throw an implementation-defined {@link Exception}. * guaranteed to throw an implementation-defined {@link Exception}.
* *
* @param image the image to use * @param image the image to use
* @return a cached server-icon that can be used for a {@link
* ServerListPingEvent#setServerIcon(CachedServerIcon)}
* @throws IllegalArgumentException if image is null * @throws IllegalArgumentException if image is null
* @throws Exception if the image does not meet current server * @throws Exception if the image does not meet current server
* server-icon specifications * server-icon specifications
* @return a cached server-icon that can be used for a {@link
* ServerListPingEvent#setServerIcon(CachedServerIcon)}
*/ */
@NotNull @NotNull
public static CachedServerIcon loadServerIcon(@NotNull BufferedImage image) throws IllegalArgumentException, Exception { public static CachedServerIcon loadServerIcon(@NotNull BufferedImage image) throws IllegalArgumentException, Exception {
@ -1599,8 +1599,8 @@ public final class Bukkit {
} }
/** /**
* @see UnsafeValues
* @return the unsafe values instance * @return the unsafe values instance
* @see UnsafeValues
*/ */
@Deprecated @Deprecated
@NotNull @NotNull

View File

@ -365,9 +365,9 @@ public final class FireworkEffect implements ConfigurationSerializable {
} }
/** /**
* @see ConfigurationSerializable
* @param map the map to deserialize * @param map the map to deserialize
* @return the resulting serializable * @return the resulting serializable
* @see ConfigurationSerializable
*/ */
@NotNull @NotNull
public static ConfigurationSerializable deserialize(@NotNull Map<String, Object> map) { public static ConfigurationSerializable deserialize(@NotNull Map<String, Object> map) {

View File

@ -339,10 +339,10 @@ public class Location implements Cloneable, ConfigurationSerializable {
/** /**
* Adds the location by another. * Adds the location by another.
* *
* @see Vector
* @param vec The other location * @param vec The other location
* @return the same location * @return the same location
* @throws IllegalArgumentException for differing worlds * @throws IllegalArgumentException for differing worlds
* @see Vector
*/ */
@NotNull @NotNull
public Location add(@NotNull Location vec) { public Location add(@NotNull Location vec) {
@ -359,9 +359,9 @@ public class Location implements Cloneable, ConfigurationSerializable {
/** /**
* Adds the location by a vector. * Adds the location by a vector.
* *
* @see Vector
* @param vec Vector to use * @param vec Vector to use
* @return the same location * @return the same location
* @see Vector
*/ */
@NotNull @NotNull
public Location add(@NotNull Vector vec) { public Location add(@NotNull Vector vec) {
@ -374,11 +374,11 @@ public class Location implements Cloneable, ConfigurationSerializable {
/** /**
* Adds the location by another. Not world-aware. * Adds the location by another. Not world-aware.
* *
* @see Vector
* @param x X coordinate * @param x X coordinate
* @param y Y coordinate * @param y Y coordinate
* @param z Z coordinate * @param z Z coordinate
* @return the same location * @return the same location
* @see Vector
*/ */
@NotNull @NotNull
public Location add(double x, double y, double z) { public Location add(double x, double y, double z) {
@ -391,10 +391,10 @@ public class Location implements Cloneable, ConfigurationSerializable {
/** /**
* Subtracts the location by another. * Subtracts the location by another.
* *
* @see Vector
* @param vec The other location * @param vec The other location
* @return the same location * @return the same location
* @throws IllegalArgumentException for differing worlds * @throws IllegalArgumentException for differing worlds
* @see Vector
*/ */
@NotNull @NotNull
public Location subtract(@NotNull Location vec) { public Location subtract(@NotNull Location vec) {
@ -411,9 +411,9 @@ public class Location implements Cloneable, ConfigurationSerializable {
/** /**
* Subtracts the location by a vector. * Subtracts the location by a vector.
* *
* @see Vector
* @param vec The vector to use * @param vec The vector to use
* @return the same location * @return the same location
* @see Vector
*/ */
@NotNull @NotNull
public Location subtract(@NotNull Vector vec) { public Location subtract(@NotNull Vector vec) {
@ -427,11 +427,11 @@ public class Location implements Cloneable, ConfigurationSerializable {
* Subtracts the location by another. Not world-aware and * Subtracts the location by another. Not world-aware and
* orientation independent. * orientation independent.
* *
* @see Vector
* @param x X coordinate * @param x X coordinate
* @param y Y coordinate * @param y Y coordinate
* @param z Z coordinate * @param z Z coordinate
* @return the same location * @return the same location
* @see Vector
*/ */
@NotNull @NotNull
public Location subtract(double x, double y, double z) { public Location subtract(double x, double y, double z) {

View File

@ -736,11 +736,11 @@ public interface Server extends PluginMessageRecipient {
* This will return an object even if the player does not exist. To this * This will return an object even if the player does not exist. To this
* method, all players will exist. * method, all players will exist.
* *
* @deprecated Persistent storage of users should be by UUID as names are no longer
* unique past a single session.
* @param name the name the player to retrieve * @param name the name the player to retrieve
* @return an offline player * @return an offline player
* @see #getOfflinePlayer(java.util.UUID) * @see #getOfflinePlayer(java.util.UUID)
* @deprecated Persistent storage of users should be by UUID as names are no longer
* unique past a single session.
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -1067,11 +1067,11 @@ public interface Server extends PluginMessageRecipient {
* guaranteed to throw an implementation-defined {@link Exception}. * guaranteed to throw an implementation-defined {@link Exception}.
* *
* @param file the file to load the from * @param file the file to load the from
* @return a cached server-icon that can be used for a {@link
* ServerListPingEvent#setServerIcon(CachedServerIcon)}
* @throws IllegalArgumentException if image is null * @throws IllegalArgumentException if image is null
* @throws Exception if the image does not meet current server server-icon * @throws Exception if the image does not meet current server server-icon
* specifications * specifications
* @return a cached server-icon that can be used for a {@link
* ServerListPingEvent#setServerIcon(CachedServerIcon)}
*/ */
@NotNull @NotNull
CachedServerIcon loadServerIcon(@NotNull File file) throws IllegalArgumentException, Exception; CachedServerIcon loadServerIcon(@NotNull File file) throws IllegalArgumentException, Exception;
@ -1083,11 +1083,11 @@ public interface Server extends PluginMessageRecipient {
* guaranteed to throw an implementation-defined {@link Exception}. * guaranteed to throw an implementation-defined {@link Exception}.
* *
* @param image the image to use * @param image the image to use
* @return a cached server-icon that can be used for a {@link
* ServerListPingEvent#setServerIcon(CachedServerIcon)}
* @throws IllegalArgumentException if image is null * @throws IllegalArgumentException if image is null
* @throws Exception if the image does not meet current server * @throws Exception if the image does not meet current server
* server-icon specifications * server-icon specifications
* @return a cached server-icon that can be used for a {@link
* ServerListPingEvent#setServerIcon(CachedServerIcon)}
*/ */
@NotNull @NotNull
CachedServerIcon loadServerIcon(@NotNull BufferedImage image) throws IllegalArgumentException, Exception; CachedServerIcon loadServerIcon(@NotNull BufferedImage image) throws IllegalArgumentException, Exception;
@ -1349,8 +1349,8 @@ public interface Server extends PluginMessageRecipient {
List<Entity> selectEntities(@NotNull CommandSender sender, @NotNull String selector) throws IllegalArgumentException; List<Entity> selectEntities(@NotNull CommandSender sender, @NotNull String selector) throws IllegalArgumentException;
/** /**
* @see UnsafeValues
* @return the unsafe values instance * @return the unsafe values instance
* @see UnsafeValues
*/ */
@Deprecated @Deprecated
@NotNull @NotNull

View File

@ -238,12 +238,12 @@ public class WorldCreator {
* is as follows: * is as follows:
* <code>{"structures": {"structures": {"village": {"salt": 8015723, "spacing": 32, "separation": 8}}}, "layers": [{"block": "stone", "height": 1}, {"block": "grass", "height": 1}], "biome":"plains"}</code> * <code>{"structures": {"structures": {"village": {"salt": 8015723, "spacing": 32, "separation": 8}}}, "layers": [{"block": "stone", "height": 1}, {"block": "grass", "height": 1}], "biome":"plains"}</code>
* *
* @see <a href="https://minecraft.gamepedia.com/Custom_dimension">Custom
* dimension</a> (scroll to "When the generator ID type is
* <code>minecraft:flat</code>)"
* @param generatorSettings The settings that should be used by the * @param generatorSettings The settings that should be used by the
* generator * generator
* @return This object, for chaining * @return This object, for chaining
* @see <a href="https://minecraft.gamepedia.com/Custom_dimension">Custom
* dimension</a> (scroll to "When the generator ID type is
* <code>minecraft:flat</code>)"
*/ */
@NotNull @NotNull
public WorldCreator generatorSettings(@NotNull String generatorSettings) { public WorldCreator generatorSettings(@NotNull String generatorSettings) {

View File

@ -27,18 +27,16 @@ public interface Lectern extends TileState, BlockInventoryHolder {
void setPage(int page); void setPage(int page);
/** /**
* @see Container#getInventory()
*
* @return inventory * @return inventory
* @see Container#getInventory()
*/ */
@NotNull @NotNull
@Override @Override
Inventory getInventory(); Inventory getInventory();
/** /**
* @see Container#getSnapshotInventory()
*
* @return snapshot inventory * @return snapshot inventory
* @see Container#getSnapshotInventory()
*/ */
@NotNull @NotNull
Inventory getSnapshotInventory(); Inventory getSnapshotInventory();

View File

@ -22,8 +22,8 @@ public interface Sign extends TileState, Colorable {
* For example, getLine(0) will return the first line of text. * For example, getLine(0) will return the first line of text.
* *
* @param index Line number to get the text from, starting at 0 * @param index Line number to get the text from, starting at 0
* @throws IndexOutOfBoundsException Thrown when the line does not exist
* @return Text on the given line * @return Text on the given line
* @throws IndexOutOfBoundsException Thrown when the line does not exist
*/ */
@NotNull @NotNull
public String getLine(int index) throws IndexOutOfBoundsException; public String getLine(int index) throws IndexOutOfBoundsException;

View File

@ -13,8 +13,8 @@ public interface ArmorStand extends LivingEntity {
* Returns the item the armor stand is currently holding. * Returns the item the armor stand is currently holding.
* *
* @return the held item * @return the held item
* @deprecated prefer {@link EntityEquipment#getItemInHand()}
* @see #getEquipment() * @see #getEquipment()
* @deprecated prefer {@link EntityEquipment#getItemInHand()}
*/ */
@NotNull @NotNull
@Deprecated @Deprecated
@ -24,9 +24,9 @@ public interface ArmorStand extends LivingEntity {
* Sets the item the armor stand is currently holding. * Sets the item the armor stand is currently holding.
* *
* @param item the item to hold * @param item the item to hold
* @see #getEquipment()
* @deprecated prefer * @deprecated prefer
* {@link EntityEquipment#setItemInHand(org.bukkit.inventory.ItemStack)} * {@link EntityEquipment#setItemInHand(org.bukkit.inventory.ItemStack)}
* @see #getEquipment()
*/ */
@Deprecated @Deprecated
void setItemInHand(@Nullable ItemStack item); void setItemInHand(@Nullable ItemStack item);
@ -35,8 +35,8 @@ public interface ArmorStand extends LivingEntity {
* Returns the item currently being worn by the armor stand on its feet. * Returns the item currently being worn by the armor stand on its feet.
* *
* @return the worn item * @return the worn item
* @deprecated prefer {@link EntityEquipment#getBoots()}
* @see #getEquipment() * @see #getEquipment()
* @deprecated prefer {@link EntityEquipment#getBoots()}
*/ */
@NotNull @NotNull
@Deprecated @Deprecated
@ -46,9 +46,9 @@ public interface ArmorStand extends LivingEntity {
* Sets the item currently being worn by the armor stand on its feet. * Sets the item currently being worn by the armor stand on its feet.
* *
* @param item the item to wear * @param item the item to wear
* @see #getEquipment()
* @deprecated prefer * @deprecated prefer
* {@link EntityEquipment#setBoots(org.bukkit.inventory.ItemStack)} * {@link EntityEquipment#setBoots(org.bukkit.inventory.ItemStack)}
* @see #getEquipment()
*/ */
@Deprecated @Deprecated
void setBoots(@Nullable ItemStack item); void setBoots(@Nullable ItemStack item);
@ -57,8 +57,8 @@ public interface ArmorStand extends LivingEntity {
* Returns the item currently being worn by the armor stand on its legs. * Returns the item currently being worn by the armor stand on its legs.
* *
* @return the worn item * @return the worn item
* @deprecated prefer {@link EntityEquipment#getLeggings()}
* @see #getEquipment() * @see #getEquipment()
* @deprecated prefer {@link EntityEquipment#getLeggings()}
*/ */
@NotNull @NotNull
@Deprecated @Deprecated
@ -68,9 +68,9 @@ public interface ArmorStand extends LivingEntity {
* Sets the item currently being worn by the armor stand on its legs. * Sets the item currently being worn by the armor stand on its legs.
* *
* @param item the item to wear * @param item the item to wear
* @see #getEquipment()
* @deprecated prefer * @deprecated prefer
* {@link EntityEquipment#setLeggings(org.bukkit.inventory.ItemStack)} * {@link EntityEquipment#setLeggings(org.bukkit.inventory.ItemStack)}
* @see #getEquipment()
*/ */
@Deprecated @Deprecated
void setLeggings(@Nullable ItemStack item); void setLeggings(@Nullable ItemStack item);
@ -79,8 +79,8 @@ public interface ArmorStand extends LivingEntity {
* Returns the item currently being worn by the armor stand on its chest. * Returns the item currently being worn by the armor stand on its chest.
* *
* @return the worn item * @return the worn item
* @deprecated prefer {@link EntityEquipment#getChestplate()}
* @see #getEquipment() * @see #getEquipment()
* @deprecated prefer {@link EntityEquipment#getChestplate()}
*/ */
@NotNull @NotNull
@Deprecated @Deprecated
@ -90,9 +90,9 @@ public interface ArmorStand extends LivingEntity {
* Sets the item currently being worn by the armor stand on its chest. * Sets the item currently being worn by the armor stand on its chest.
* *
* @param item the item to wear * @param item the item to wear
* @see #getEquipment()
* @deprecated prefer * @deprecated prefer
* {@link EntityEquipment#setChestplate(org.bukkit.inventory.ItemStack)} * {@link EntityEquipment#setChestplate(org.bukkit.inventory.ItemStack)}
* @see #getEquipment()
*/ */
@Deprecated @Deprecated
void setChestplate(@Nullable ItemStack item); void setChestplate(@Nullable ItemStack item);
@ -101,8 +101,8 @@ public interface ArmorStand extends LivingEntity {
* Returns the item currently being worn by the armor stand on its head. * Returns the item currently being worn by the armor stand on its head.
* *
* @return the worn item * @return the worn item
* @deprecated prefer {@link EntityEquipment#getHelmet()}
* @see #getEquipment() * @see #getEquipment()
* @deprecated prefer {@link EntityEquipment#getHelmet()}
*/ */
@NotNull @NotNull
@Deprecated @Deprecated
@ -112,9 +112,9 @@ public interface ArmorStand extends LivingEntity {
* Sets the item currently being worn by the armor stand on its head. * Sets the item currently being worn by the armor stand on its head.
* *
* @param item the item to wear * @param item the item to wear
* @see #getEquipment()
* @deprecated prefer * @deprecated prefer
* {@link EntityEquipment#setHelmet(org.bukkit.inventory.ItemStack)} * {@link EntityEquipment#setHelmet(org.bukkit.inventory.ItemStack)}
* @see #getEquipment()
*/ */
@Deprecated @Deprecated
void setHelmet(@Nullable ItemStack item); void setHelmet(@Nullable ItemStack item);

View File

@ -57,8 +57,8 @@ public class CauldronLevelChangeEvent extends BlockEvent implements Cancellable
* Gets the old level of the cauldron. * Gets the old level of the cauldron.
* *
* @return old level * @return old level
* @deprecated not all cauldron contents are Levelled
* @see #getBlock() * @see #getBlock()
* @deprecated not all cauldron contents are Levelled
*/ */
@Deprecated @Deprecated
public int getOldLevel() { public int getOldLevel() {
@ -70,8 +70,8 @@ public class CauldronLevelChangeEvent extends BlockEvent implements Cancellable
* Gets the new level of the cauldron. * Gets the new level of the cauldron.
* *
* @return new level * @return new level
* @deprecated not all cauldron contents are Levelled
* @see #getNewState() * @see #getNewState()
* @deprecated not all cauldron contents are Levelled
*/ */
@Deprecated @Deprecated
public int getNewLevel() { public int getNewLevel() {
@ -83,8 +83,8 @@ public class CauldronLevelChangeEvent extends BlockEvent implements Cancellable
* Sets the new level of the cauldron. * Sets the new level of the cauldron.
* *
* @param newLevel new level * @param newLevel new level
* @deprecated not all cauldron contents are Levelled
* @see #getNewState() * @see #getNewState()
* @deprecated not all cauldron contents are Levelled
*/ */
@Deprecated @Deprecated
public void setNewLevel(int newLevel) { public void setNewLevel(int newLevel) {

View File

@ -165,8 +165,8 @@ public class InventoryClickEvent extends InventoryInteractEvent {
/** /**
* Gets the inventory corresponding to the clicked slot. * Gets the inventory corresponding to the clicked slot.
* *
* @see InventoryView#getInventory(int)
* @return inventory, or null if clicked outside * @return inventory, or null if clicked outside
* @see InventoryView#getInventory(int)
*/ */
@Nullable @Nullable
public Inventory getClickedInventory() { public Inventory getClickedInventory() {

View File

@ -47,9 +47,9 @@ public class AsyncPlayerPreLoginEvent extends Event {
* Gets the current result of the login, as an enum * Gets the current result of the login, as an enum
* *
* @return Current Result of the login * @return Current Result of the login
* @see #getLoginResult()
* @deprecated This method uses a deprecated enum from {@link * @deprecated This method uses a deprecated enum from {@link
* PlayerPreLoginEvent} * PlayerPreLoginEvent}
* @see #getLoginResult()
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -70,9 +70,9 @@ public class AsyncPlayerPreLoginEvent extends Event {
* Sets the new result of the login, as an enum * Sets the new result of the login, as an enum
* *
* @param result New result to set * @param result New result to set
* @see #setLoginResult(Result)
* @deprecated This method uses a deprecated enum from {@link * @deprecated This method uses a deprecated enum from {@link
* PlayerPreLoginEvent} * PlayerPreLoginEvent}
* @see #setLoginResult(Result)
*/ */
@Deprecated @Deprecated
public void setResult(@NotNull final PlayerPreLoginEvent.Result result) { public void setResult(@NotNull final PlayerPreLoginEvent.Result result) {
@ -123,9 +123,9 @@ public class AsyncPlayerPreLoginEvent extends Event {
* *
* @param result New result for disallowing the player * @param result New result for disallowing the player
* @param message Kick message to display to the user * @param message Kick message to display to the user
* @see #disallow(Result, String)
* @deprecated This method uses a deprecated enum from {@link * @deprecated This method uses a deprecated enum from {@link
* PlayerPreLoginEvent} * PlayerPreLoginEvent}
* @see #disallow(Result, String)
*/ */
@Deprecated @Deprecated
public void disallow(@NotNull final PlayerPreLoginEvent.Result result, @NotNull final String message) { public void disallow(@NotNull final PlayerPreLoginEvent.Result result, @NotNull final String message) {

View File

@ -122,9 +122,9 @@ public class PlayerCommandPreprocessEvent extends PlayerEvent implements Cancell
* UnsupportedOperationException} if the event caller provides an * UnsupportedOperationException} if the event caller provides an
* unmodifiable set. * unmodifiable set.
* *
* @return All Players who will see this chat message
* @deprecated This method is provided for backward compatibility with no * @deprecated This method is provided for backward compatibility with no
* guarantee to the effect of viewing or modifying the set. * guarantee to the effect of viewing or modifying the set.
* @return All Players who will see this chat message
*/ */
@NotNull @NotNull
@Deprecated @Deprecated

View File

@ -19,9 +19,8 @@ public class PlayerLocaleChangeEvent extends PlayerEvent {
} }
/** /**
* @see Player#getLocale()
*
* @return the player's new locale * @return the player's new locale
* @see Player#getLocale()
*/ */
@NotNull @NotNull
public String getLocale() { public String getLocale() {

View File

@ -32,7 +32,7 @@ public final class HelpTopicComparator implements Comparator<HelpTopic> {
} }
public static final class TopicNameComparator implements Comparator<String> { public static final class TopicNameComparator implements Comparator<String> {
private TopicNameComparator(){} private TopicNameComparator() {}
@Override @Override
public int compare(@NotNull String lhs, @NotNull String rhs) { public int compare(@NotNull String lhs, @NotNull String rhs) {

View File

@ -87,11 +87,11 @@ public interface EntityEquipment {
/** /**
* Gets a copy of the item the entity is currently holding * Gets a copy of the item the entity is currently holding
* *
* @deprecated entities can duel wield now use the methods for the * @return the currently held item
* specific hand instead
* @see #getItemInMainHand() * @see #getItemInMainHand()
* @see #getItemInOffHand() * @see #getItemInOffHand()
* @return the currently held item * @deprecated entities can duel wield now use the methods for the
* specific hand instead
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -100,11 +100,11 @@ public interface EntityEquipment {
/** /**
* Sets the item the entity is holding * Sets the item the entity is holding
* *
* @deprecated entities can duel wield now use the methods for the * @param stack The item to put into the entities hand
* specific hand instead
* @see #setItemInMainHand(ItemStack) * @see #setItemInMainHand(ItemStack)
* @see #setItemInOffHand(ItemStack) * @see #setItemInOffHand(ItemStack)
* @param stack The item to put into the entities hand * @deprecated entities can duel wield now use the methods for the
* specific hand instead
*/ */
@Deprecated @Deprecated
void setItemInHand(@Nullable ItemStack stack); void setItemInHand(@Nullable ItemStack stack);
@ -222,21 +222,21 @@ public interface EntityEquipment {
void clear(); void clear();
/** /**
* @deprecated entities can duel wield now use the methods for the specific * @return drop chance
* hand instead
* @see #getItemInMainHandDropChance() * @see #getItemInMainHandDropChance()
* @see #getItemInOffHandDropChance() * @see #getItemInOffHandDropChance()
* @return drop chance * @deprecated entities can duel wield now use the methods for the specific
* hand instead
*/ */
@Deprecated @Deprecated
float getItemInHandDropChance(); float getItemInHandDropChance();
/** /**
* @deprecated entities can duel wield now use the methods for the specific * @param chance drop chance
* hand instead
* @see #setItemInMainHandDropChance(float) * @see #setItemInMainHandDropChance(float)
* @see #setItemInOffHandDropChance(float) * @see #setItemInOffHandDropChance(float)
* @param chance drop chance * @deprecated entities can duel wield now use the methods for the specific
* hand instead
*/ */
@Deprecated @Deprecated
void setItemInHandDropChance(float chance); void setItemInHandDropChance(float chance);

View File

@ -192,11 +192,11 @@ public interface PlayerInventory extends Inventory {
/** /**
* Gets a copy of the item the player is currently holding * Gets a copy of the item the player is currently holding
* *
* @deprecated players can duel wield now use the methods for the * @return the currently held item
* specific hand instead
* @see #getItemInMainHand() * @see #getItemInMainHand()
* @see #getItemInOffHand() * @see #getItemInOffHand()
* @return the currently held item * @deprecated players can duel wield now use the methods for the
* specific hand instead
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -205,11 +205,11 @@ public interface PlayerInventory extends Inventory {
/** /**
* Sets the item the player is holding * Sets the item the player is holding
* *
* @deprecated players can duel wield now use the methods for the * @param stack The item to put into the player's hand
* specific hand instead
* @see #setItemInMainHand(ItemStack) * @see #setItemInMainHand(ItemStack)
* @see #setItemInOffHand(ItemStack) * @see #setItemInOffHand(ItemStack)
* @param stack The item to put into the player's hand * @deprecated players can duel wield now use the methods for the
* specific hand instead
*/ */
@Deprecated @Deprecated
public void setItemInHand(@Nullable ItemStack stack); public void setItemInHand(@Nullable ItemStack stack);

View File

@ -15,12 +15,12 @@ public interface MapMeta extends ItemMeta {
* Checks for existence of a map ID number. * Checks for existence of a map ID number.
* *
* @return true if this has a map ID number. * @return true if this has a map ID number.
* @see #hasMapView()
* @deprecated These methods are poor API: They rely on the caller to pass * @deprecated These methods are poor API: They rely on the caller to pass
* in an only an integer property, and have poorly defined implementation * in an only an integer property, and have poorly defined implementation
* behavior if that integer is not a valid map (the current implementation * behavior if that integer is not a valid map (the current implementation
* for example will generate a new map with a different ID). The xxxMapView * for example will generate a new map with a different ID). The xxxMapView
* family of methods should be used instead. * family of methods should be used instead.
* @see #hasMapView()
*/ */
@Deprecated @Deprecated
boolean hasMapId(); boolean hasMapId();
@ -33,12 +33,12 @@ public interface MapMeta extends ItemMeta {
* calling this method. * calling this method.
* *
* @return the map ID that is set * @return the map ID that is set
* @see #getMapView()
* @deprecated These methods are poor API: They rely on the caller to pass * @deprecated These methods are poor API: They rely on the caller to pass
* in an only an integer property, and have poorly defined implementation * in an only an integer property, and have poorly defined implementation
* behavior if that integer is not a valid map (the current implementation * behavior if that integer is not a valid map (the current implementation
* for example will generate a new map with a different ID). The xxxMapView * for example will generate a new map with a different ID). The xxxMapView
* family of methods should be used instead. * family of methods should be used instead.
* @see #getMapView()
*/ */
@Deprecated @Deprecated
int getMapId(); int getMapId();
@ -47,12 +47,12 @@ public interface MapMeta extends ItemMeta {
* Sets the map ID. This is used to determine what map is displayed. * Sets the map ID. This is used to determine what map is displayed.
* *
* @param id the map id to set * @param id the map id to set
* @see #setMapView(org.bukkit.map.MapView)
* @deprecated These methods are poor API: They rely on the caller to pass * @deprecated These methods are poor API: They rely on the caller to pass
* in an only an integer property, and have poorly defined implementation * in an only an integer property, and have poorly defined implementation
* behavior if that integer is not a valid map (the current implementation * behavior if that integer is not a valid map (the current implementation
* for example will generate a new map with a different ID). The xxxMapView * for example will generate a new map with a different ID). The xxxMapView
* family of methods should be used instead. * family of methods should be used instead.
* @see #setMapView(org.bukkit.map.MapView)
*/ */
@Deprecated @Deprecated
void setMapId(int id); void setMapId(int id);

View File

@ -141,9 +141,9 @@ public class Potion {
* Returns a collection of {@link PotionEffect}s that this {@link Potion} * Returns a collection of {@link PotionEffect}s that this {@link Potion}
* would confer upon a {@link LivingEntity}. * would confer upon a {@link LivingEntity}.
* *
* @return The effects that this potion applies
* @see PotionBrewer#getEffectsFromDamage(int) * @see PotionBrewer#getEffectsFromDamage(int)
* @see Potion#toDamageValue() * @see Potion#toDamageValue()
* @return The effects that this potion applies
*/ */
@NotNull @NotNull
public Collection<PotionEffect> getEffects() { public Collection<PotionEffect> getEffects() {

View File

@ -184,10 +184,10 @@ public abstract class PotionEffectType {
* Creates a PotionEffect from this PotionEffectType, applying duration * Creates a PotionEffect from this PotionEffectType, applying duration
* modifiers and checks. * modifiers and checks.
* *
* @see PotionBrewer#createEffect(PotionEffectType, int, int)
* @param duration time in ticks * @param duration time in ticks
* @param amplifier the effect's amplifier * @param amplifier the effect's amplifier
* @return a resulting potion effect * @return a resulting potion effect
* @see PotionBrewer#createEffect(PotionEffectType, int, int)
*/ */
@NotNull @NotNull
public PotionEffect createEffect(int duration, int amplifier) { public PotionEffect createEffect(int duration, int amplifier) {

View File

@ -22,11 +22,11 @@ public interface BukkitScheduler {
public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay); public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay);
/** /**
* @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)}
* @param plugin Plugin that owns the task * @param plugin Plugin that owns the task
* @param task Task to be executed * @param task Task to be executed
* @param delay Delay in server ticks before executing task * @param delay Delay in server ticks before executing task
* @return Task id number (-1 if scheduling failed) * @return Task id number (-1 if scheduling failed)
* @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)}
*/ */
@Deprecated @Deprecated
public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay); public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay);
@ -43,10 +43,10 @@ public interface BukkitScheduler {
public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task); public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull Runnable task);
/** /**
* @deprecated Use {@link BukkitRunnable#runTask(Plugin)}
* @param plugin Plugin that owns the task * @param plugin Plugin that owns the task
* @param task Task to be executed * @param task Task to be executed
* @return Task id number (-1 if scheduling failed) * @return Task id number (-1 if scheduling failed)
* @deprecated Use {@link BukkitRunnable#runTask(Plugin)}
*/ */
@Deprecated @Deprecated
public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task); public int scheduleSyncDelayedTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task);
@ -65,12 +65,12 @@ public interface BukkitScheduler {
public int scheduleSyncRepeatingTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay, long period); public int scheduleSyncRepeatingTask(@NotNull Plugin plugin, @NotNull Runnable task, long delay, long period);
/** /**
* @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}
* @param plugin Plugin that owns the task * @param plugin Plugin that owns the task
* @param task Task to be executed * @param task Task to be executed
* @param delay Delay in server ticks before executing first repeat * @param delay Delay in server ticks before executing first repeat
* @param period Period in server ticks of the task * @param period Period in server ticks of the task
* @return Task id number (-1 if scheduling failed) * @return Task id number (-1 if scheduling failed)
* @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}
*/ */
@Deprecated @Deprecated
public int scheduleSyncRepeatingTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay, long period); public int scheduleSyncRepeatingTask(@NotNull Plugin plugin, @NotNull BukkitRunnable task, long delay, long period);
@ -230,13 +230,12 @@ public interface BukkitScheduler {
public void runTask(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task) throws IllegalArgumentException; public void runTask(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task) throws IllegalArgumentException;
/** /**
* @deprecated Use {@link BukkitRunnable#runTask(Plugin)}
*
* @param plugin the reference to the plugin scheduling task * @param plugin the reference to the plugin scheduling task
* @param task the task to be run * @param task the task to be run
* @return a BukkitTask that contains the id number * @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null * @throws IllegalArgumentException if task is null
* @deprecated Use {@link BukkitRunnable#runTask(Plugin)}
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -271,12 +270,12 @@ public interface BukkitScheduler {
public void runTaskAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task) throws IllegalArgumentException; public void runTaskAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task) throws IllegalArgumentException;
/** /**
* @deprecated Use {@link BukkitRunnable#runTaskAsynchronously(Plugin)}
* @param plugin the reference to the plugin scheduling task * @param plugin the reference to the plugin scheduling task
* @param task the task to be run * @param task the task to be run
* @return a BukkitTask that contains the id number * @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null * @throws IllegalArgumentException if task is null
* @deprecated Use {@link BukkitRunnable#runTaskAsynchronously(Plugin)}
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -309,13 +308,13 @@ public interface BukkitScheduler {
public void runTaskLater(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task, long delay) throws IllegalArgumentException; public void runTaskLater(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task, long delay) throws IllegalArgumentException;
/** /**
* @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)}
* @param plugin the reference to the plugin scheduling task * @param plugin the reference to the plugin scheduling task
* @param task the task to be run * @param task the task to be run
* @param delay the ticks to wait before running the task * @param delay the ticks to wait before running the task
* @return a BukkitTask that contains the id number * @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null * @throws IllegalArgumentException if task is null
* @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)}
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -354,13 +353,13 @@ public interface BukkitScheduler {
public void runTaskLaterAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task, long delay) throws IllegalArgumentException; public void runTaskLaterAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task, long delay) throws IllegalArgumentException;
/** /**
* @deprecated Use {@link BukkitRunnable#runTaskLaterAsynchronously(Plugin, long)}
* @param plugin the reference to the plugin scheduling task * @param plugin the reference to the plugin scheduling task
* @param task the task to be run * @param task the task to be run
* @param delay the ticks to wait before running the task * @param delay the ticks to wait before running the task
* @return a BukkitTask that contains the id number * @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null * @throws IllegalArgumentException if task is null
* @deprecated Use {@link BukkitRunnable#runTaskLaterAsynchronously(Plugin, long)}
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -395,7 +394,6 @@ public interface BukkitScheduler {
public void runTaskTimer(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task, long delay, long period) throws IllegalArgumentException; public void runTaskTimer(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task, long delay, long period) throws IllegalArgumentException;
/** /**
* @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}
* @param plugin the reference to the plugin scheduling task * @param plugin the reference to the plugin scheduling task
* @param task the task to be run * @param task the task to be run
* @param delay the ticks to wait before running the task * @param delay the ticks to wait before running the task
@ -403,6 +401,7 @@ public interface BukkitScheduler {
* @return a BukkitTask that contains the id number * @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null * @throws IllegalArgumentException if task is null
* @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -445,7 +444,6 @@ public interface BukkitScheduler {
public void runTaskTimerAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task, long delay, long period) throws IllegalArgumentException; public void runTaskTimerAsynchronously(@NotNull Plugin plugin, @NotNull Consumer<BukkitTask> task, long delay, long period) throws IllegalArgumentException;
/** /**
* @deprecated Use {@link BukkitRunnable#runTaskTimerAsynchronously(Plugin, long, long)}
* @param plugin the reference to the plugin scheduling task * @param plugin the reference to the plugin scheduling task
* @param task the task to be run * @param task the task to be run
* @param delay the ticks to wait before running the task for the first * @param delay the ticks to wait before running the task for the first
@ -454,6 +452,7 @@ public interface BukkitScheduler {
* @return a BukkitTask that contains the id number * @return a BukkitTask that contains the id number
* @throws IllegalArgumentException if plugin is null * @throws IllegalArgumentException if plugin is null
* @throws IllegalArgumentException if task is null * @throws IllegalArgumentException if task is null
* @deprecated Use {@link BukkitRunnable#runTaskTimerAsynchronously(Plugin, long, long)}
*/ */
@Deprecated @Deprecated
@NotNull @NotNull

View File

@ -116,8 +116,8 @@ public interface Objective {
* @return Score tracking the Objective and player specified * @return Score tracking the Objective and player specified
* @throws IllegalArgumentException if player is null * @throws IllegalArgumentException if player is null
* @throws IllegalStateException if this objective has been unregistered * @throws IllegalStateException if this objective has been unregistered
* @deprecated Scoreboards can contain entries that aren't players
* @see #getScore(String) * @see #getScore(String)
* @deprecated Scoreboards can contain entries that aren't players
*/ */
@Deprecated @Deprecated
@NotNull @NotNull

View File

@ -15,8 +15,8 @@ public interface Score {
* Gets the OfflinePlayer being tracked by this Score * Gets the OfflinePlayer being tracked by this Score
* *
* @return this Score's tracked player * @return this Score's tracked player
* @deprecated Scoreboards can contain entries that aren't players
* @see #getEntry() * @see #getEntry()
* @deprecated Scoreboards can contain entries that aren't players
*/ */
@Deprecated @Deprecated
@NotNull @NotNull

View File

@ -116,8 +116,8 @@ public interface Scoreboard {
* @param player the player whose scores are being retrieved * @param player the player whose scores are being retrieved
* @return immutable set of all scores tracked for the player * @return immutable set of all scores tracked for the player
* @throws IllegalArgumentException if player is null * @throws IllegalArgumentException if player is null
* @deprecated Scoreboards can contain entries that aren't players
* @see #getScores(String) * @see #getScores(String)
* @deprecated Scoreboards can contain entries that aren't players
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -138,8 +138,8 @@ public interface Scoreboard {
* *
* @param player the player to drop all current scores for * @param player the player to drop all current scores for
* @throws IllegalArgumentException if player is null * @throws IllegalArgumentException if player is null
* @deprecated Scoreboards can contain entries that aren't players
* @see #resetScores(String) * @see #resetScores(String)
* @deprecated Scoreboards can contain entries that aren't players
*/ */
@Deprecated @Deprecated
void resetScores(@NotNull OfflinePlayer player) throws IllegalArgumentException; void resetScores(@NotNull OfflinePlayer player) throws IllegalArgumentException;
@ -158,8 +158,8 @@ public interface Scoreboard {
* @param player the player to search for * @param player the player to search for
* @return the player's Team or null if the player is not on a team * @return the player's Team or null if the player is not on a team
* @throws IllegalArgumentException if player is null * @throws IllegalArgumentException if player is null
* @deprecated Scoreboards can contain entries that aren't players
* @see #getEntryTeam(String) * @see #getEntryTeam(String)
* @deprecated Scoreboards can contain entries that aren't players
*/ */
@Deprecated @Deprecated
@Nullable @Nullable
@ -208,8 +208,8 @@ public interface Scoreboard {
* Gets all players tracked by this Scoreboard * Gets all players tracked by this Scoreboard
* *
* @return immutable set of all tracked players * @return immutable set of all tracked players
* @deprecated Scoreboards can contain entries that aren't players
* @see #getEntries() * @see #getEntries()
* @deprecated Scoreboards can contain entries that aren't players
*/ */
@Deprecated @Deprecated
@NotNull @NotNull

View File

@ -165,9 +165,9 @@ public interface Team {
* Gets the Set of players on the team * Gets the Set of players on the team
* *
* @return players on the team * @return players on the team
* @throws IllegalStateException if this team has been unregistered\ * @throws IllegalStateException if this team has been unregistered
* @deprecated Teams can contain entries that aren't players
* @see #getEntries() * @see #getEntries()
* @deprecated Teams can contain entries that aren't players
*/ */
@Deprecated @Deprecated
@NotNull @NotNull
@ -207,8 +207,8 @@ public interface Team {
* @param player the player to add * @param player the player to add
* @throws IllegalArgumentException if player is null * @throws IllegalArgumentException if player is null
* @throws IllegalStateException if this team has been unregistered * @throws IllegalStateException if this team has been unregistered
* @deprecated Teams can contain entries that aren't players
* @see #addEntry(String) * @see #addEntry(String)
* @deprecated Teams can contain entries that aren't players
*/ */
@Deprecated @Deprecated
void addPlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException; void addPlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException;
@ -231,8 +231,8 @@ public interface Team {
* @return if the player was on this team * @return if the player was on this team
* @throws IllegalArgumentException if player is null * @throws IllegalArgumentException if player is null
* @throws IllegalStateException if this team has been unregistered * @throws IllegalStateException if this team has been unregistered
* @deprecated Teams can contain entries that aren't players
* @see #removeEntry(String) * @see #removeEntry(String)
* @deprecated Teams can contain entries that aren't players
*/ */
@Deprecated @Deprecated
boolean removePlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException; boolean removePlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException;
@ -261,8 +261,8 @@ public interface Team {
* @return true if the player is a member of this team * @return true if the player is a member of this team
* @throws IllegalArgumentException if player is null * @throws IllegalArgumentException if player is null
* @throws IllegalStateException if this team has been unregistered * @throws IllegalStateException if this team has been unregistered
* @deprecated Teams can contain entries that aren't players
* @see #hasEntry(String) * @see #hasEntry(String)
* @deprecated Teams can contain entries that aren't players
*/ */
@Deprecated @Deprecated
boolean hasPlayer(@NotNull OfflinePlayer player) throws IllegalArgumentException, IllegalStateException; boolean hasPlayer(@NotNull OfflinePlayer player) throws IllegalArgumentException, IllegalStateException;