Skip to content

Commit 47bbe06

Browse files
committed
Add apiNote to ItemMeta methods
1 parent 9693df3 commit 47bbe06

6 files changed

+34
-31
lines changed

patches/api/0006-Adventure.patch

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4713,10 +4713,10 @@ index 9bab73c3c2ca759b8e1c7d07d98cc593c961666a..f0c6943da3f783101ca647b75b3230fa
47134713
throw new UnsupportedOperationException("Not supported yet.");
47144714
}
47154715
diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
4716-
index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45c826908f 100644
4716+
index 69d6de6e9618dd27f5ba73b931f8455912caf060..753a756525f6afea981dd0c2984e7a747d4d148b 100644
47174717
--- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
47184718
+++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
4719-
@@ -38,12 +38,62 @@ import org.jetbrains.annotations.Nullable;
4719+
@@ -38,12 +38,65 @@ import org.jetbrains.annotations.Nullable;
47204720
*/
47214721
public interface ItemMeta extends Cloneable, ConfigurationSerializable, PersistentDataHolder {
47224722

@@ -4747,6 +4747,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
47474747
/**
47484748
* Checks for existence of a display name.
47494749
*
4750+
+ * @apiNote This method is obsolete, use {@link #hasCustomName()} instead.
47504751
* @return true if this has a display name
47514752
*/
47524753
- boolean hasDisplayName();
@@ -4760,6 +4761,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
47604761
+ *
47614762
+ * <p>Plugins should check that {@link #hasDisplayName()} returns <code>true</code> before calling this method.</p>
47624763
+ *
4764+
+ * @apiNote This method is obsolete, use {@link #customName()} instead.
47634765
+ * @return the display name
47644766
+ */
47654767
+ @ApiStatus.Obsolete(since = "1.21.4")
@@ -4771,6 +4773,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
47714773
+ * Sets the display name.
47724774
+ *
47734775
+ * @param displayName the display name to set
4776+
+ * @apiNote This method is obsolete, use {@link #customName(Component)} instead.
47744777
+ */
47754778
+ @ApiStatus.Obsolete(since = "1.21.4")
47764779
+ default void displayName(final net.kyori.adventure.text.@Nullable Component displayName) {
@@ -4780,7 +4783,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
47804783

47814784
/**
47824785
* Gets the display name that is set.
4783-
@@ -52,7 +102,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4786+
@@ -52,7 +105,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
47844787
* before calling this method.
47854788
*
47864789
* @return the display name that is set
@@ -4790,7 +4793,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
47904793
@NotNull
47914794
String getDisplayName();
47924795

4793-
@@ -60,7 +112,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4796+
@@ -60,7 +115,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
47944797
* Sets the display name.
47954798
*
47964799
* @param name the name to set
@@ -4800,7 +4803,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
48004803
void setDisplayName(@Nullable String name);
48014804

48024805
/**
4803-
@@ -73,6 +127,32 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4806+
@@ -73,6 +130,32 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
48044807
*/
48054808
boolean hasItemName();
48064809

@@ -4833,7 +4836,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
48334836
/**
48344837
* Gets the item name that is set.
48354838
* <br>
4836-
@@ -83,7 +163,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4839+
@@ -83,7 +166,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
48374840
* calling this method.
48384841
*
48394842
* @return the item name that is set
@@ -4843,7 +4846,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
48434846
@NotNull
48444847
String getItemName();
48454848

4846-
@@ -94,7 +176,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4849+
@@ -94,7 +179,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
48474850
* anvil, is not styled with italics, and does not show labels.
48484851
*
48494852
* @param name the name to set
@@ -4853,7 +4856,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
48534856
void setItemName(@Nullable String name);
48544857

48554858
/**
4856-
@@ -135,6 +219,24 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4859+
@@ -135,6 +222,24 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
48574860
*/
48584861
boolean hasLore();
48594862

@@ -4878,7 +4881,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
48784881
/**
48794882
* Gets the lore that is set.
48804883
* <p>
4881-
@@ -142,7 +244,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4884+
@@ -142,7 +247,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
48824885
* calling this method.
48834886
*
48844887
* @return a list of lore that is set
@@ -4888,7 +4891,7 @@ index 69d6de6e9618dd27f5ba73b931f8455912caf060..1181d62f13ad53a47bf3280f00f7ed45
48884891
@Nullable
48894892
List<String> getLore();
48904893

4891-
@@ -151,7 +255,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4894+
@@ -151,7 +258,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
48924895
* Removes lore when given null.
48934896
*
48944897
* @param lore the lore that will be set

patches/api/0053-Fix-upstream-javadocs.patch

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1622,10 +1622,10 @@ index 35c6594fd1040a1af1029e7260e5e3a9307b107d..d58719ee75bef8bc265bfc81bc5d88a4
16221622
void addChargedProjectile(@NotNull ItemStack item);
16231623
}
16241624
diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
1625-
index 1181d62f13ad53a47bf3280f00f7ed45c826908f..93cce20187ae7142977233f5520e672cb554e369 100644
1625+
index 753a756525f6afea981dd0c2984e7a747d4d148b..c083ac4344dd1b2b56cbe103ce80daac945defd5 100644
16261626
--- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
16271627
+++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
1628-
@@ -325,7 +325,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1628+
@@ -328,7 +328,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
16291629
/**
16301630
* Gets the enchantable component. Higher values allow higher enchantments.
16311631
*
@@ -1634,7 +1634,7 @@ index 1181d62f13ad53a47bf3280f00f7ed45c826908f..93cce20187ae7142977233f5520e672c
16341634
*/
16351635
int getEnchantable();
16361636

1637-
@@ -658,11 +658,6 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1637+
@@ -661,11 +661,6 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
16381638

16391639
/**
16401640
* Gets the item which this item will convert to when used.
@@ -1646,7 +1646,7 @@ index 1181d62f13ad53a47bf3280f00f7ed45c826908f..93cce20187ae7142977233f5520e672c
16461646
*
16471647
* @return remainder
16481648
*/
1649-
@@ -799,7 +794,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1649+
@@ -802,7 +797,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
16501650
* The returned component is a snapshot of its current state and does not
16511651
* reflect a live view of what is on an item. After changing any value on
16521652
* this component, it must be set with
@@ -1655,7 +1655,7 @@ index 1181d62f13ad53a47bf3280f00f7ed45c826908f..93cce20187ae7142977233f5520e672c
16551655
* to apply the changes.
16561656
*
16571657
* @return component
1658-
@@ -808,7 +803,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1658+
@@ -811,7 +806,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
16591659
JukeboxPlayableComponent getJukeboxPlayable();
16601660

16611661
/**
@@ -1664,7 +1664,7 @@ index 1181d62f13ad53a47bf3280f00f7ed45c826908f..93cce20187ae7142977233f5520e672c
16641664
*
16651665
* @param jukeboxPlayable new component
16661666
*/
1667-
@@ -835,7 +830,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1667+
@@ -838,7 +833,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
16681668
/**
16691669
* Return an immutable copy of all {@link Attribute}s and their
16701670
* {@link AttributeModifier}s for a given {@link EquipmentSlot}.<br>

patches/api/0166-Fix-Spigot-annotation-mistakes.patch

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1748,34 +1748,34 @@ index 597a18a767b68b47e81454b7d44613c7178c1366..bc3440eb72127824b3961fbdae583bb6
17481748
public ItemStack getInput() {
17491749
return this.ingredient.getItemStack();
17501750
diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
1751-
index 93cce20187ae7142977233f5520e672cb554e369..e05b63c1394c5e0a34b469a8ae589480b741d548 100644
1751+
index c083ac4344dd1b2b56cbe103ce80daac945defd5..4012a1b4e9acdfafb38c78a54c4b422ffa07cf04 100644
17521752
--- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
17531753
+++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
1754-
@@ -184,6 +184,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1754+
@@ -187,6 +187,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
17551755
/**
17561756
* Checks for existence of a localized name.
17571757
*
17581758
+ * @deprecated Use {@link ItemMeta#displayName()} and check if it is instanceof a {@link net.kyori.adventure.text.TranslatableComponent}.
17591759
* @return true if this has a localized name
17601760
* @deprecated meta no longer exists
17611761
*/
1762-
@@ -196,6 +197,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1762+
@@ -199,6 +200,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
17631763
* Plugins should check that hasLocalizedName() returns <code>true</code>
17641764
* before calling this method.
17651765
*
17661766
+ * @deprecated Use {@link ItemMeta#displayName()} and cast it to a {@link net.kyori.adventure.text.TranslatableComponent}. No longer used by the client.
17671767
* @return the localized name that is set
17681768
* @deprecated meta no longer exists
17691769
*/
1770-
@@ -206,6 +208,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1770+
@@ -209,6 +211,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
17711771
/**
17721772
* Sets the localized name.
17731773
*
17741774
+ * @deprecated Use {@link ItemMeta#displayName(Component)} with a {@link net.kyori.adventure.text.TranslatableComponent}. No longer used by the client.
17751775
* @param name the name to set
17761776
* @deprecated meta no longer exists
17771777
*/
1778-
@@ -799,7 +802,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
1778+
@@ -802,7 +805,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
17791779
*
17801780
* @return component
17811781
*/

patches/api/0193-Support-components-in-ItemMeta.patch

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Subject: [PATCH] Support components in ItemMeta
55

66

77
diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
8-
index e05b63c1394c5e0a34b469a8ae589480b741d548..261978893988ed5fba1889ba8ce5ae84897a0653 100644
8+
index 4012a1b4e9acdfafb38c78a54c4b422ffa07cf04..cca91212e702a73e9fc37ec46d575967fedf68c9 100644
99
--- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
1010
+++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
1111
@@ -5,6 +5,7 @@ import java.util.Collection;
@@ -16,7 +16,7 @@ index e05b63c1394c5e0a34b469a8ae589480b741d548..261978893988ed5fba1889ba8ce5ae84
1616
import org.bukkit.NamespacedKey;
1717
import org.bukkit.Tag;
1818
import org.bukkit.attribute.Attribute;
19-
@@ -108,6 +109,20 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
19+
@@ -111,6 +112,20 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
2020
@NotNull
2121
String getDisplayName();
2222

@@ -37,7 +37,7 @@ index e05b63c1394c5e0a34b469a8ae589480b741d548..261978893988ed5fba1889ba8ce5ae84
3737
/**
3838
* Sets the display name.
3939
*
40-
@@ -117,6 +132,16 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
40+
@@ -120,6 +135,16 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
4141
@Deprecated // Paper
4242
void setDisplayName(@Nullable String name);
4343

@@ -54,7 +54,7 @@ index e05b63c1394c5e0a34b469a8ae589480b741d548..261978893988ed5fba1889ba8ce5ae84
5454
/**
5555
* Checks for existence of an item name.
5656
* <br>
57-
@@ -253,6 +278,19 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
57+
@@ -256,6 +281,19 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
5858
@Nullable
5959
List<String> getLore();
6060

@@ -74,7 +74,7 @@ index e05b63c1394c5e0a34b469a8ae589480b741d548..261978893988ed5fba1889ba8ce5ae84
7474
/**
7575
* Sets the lore for this item.
7676
* Removes lore when given null.
77-
@@ -263,6 +301,16 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
77+
@@ -266,6 +304,16 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
7878
@Deprecated // Paper
7979
void setLore(@Nullable List<String> lore);
8080

patches/api/0468-General-ItemMeta-fixes.patch

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,10 @@ index ff6818b6d9e0207eafdd749928f33aeac3f27191..992f39da07bafe9769effaa7dc6adc01
112112
* Checks to see if this item has a maximum amount of damage.
113113
*
114114
diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
115-
index 261978893988ed5fba1889ba8ce5ae84897a0653..16a0c8215c9cd0940fb3fbb2617569279d371a13 100644
115+
index cca91212e702a73e9fc37ec46d575967fedf68c9..2035d54de7e446930f8fdd2a572240e70a21c656 100644
116116
--- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
117117
+++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
118-
@@ -383,7 +383,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
118+
@@ -386,7 +386,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
119119
/**
120120
* Sets the enchantable. Higher values allow higher enchantments.
121121
*
@@ -124,7 +124,7 @@ index 261978893988ed5fba1889ba8ce5ae84897a0653..16a0c8215c9cd0940fb3fbb261756927
124124
*/
125125
void setEnchantable(@Nullable Integer enchantable);
126126

127-
@@ -927,8 +927,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
127+
@@ -930,8 +930,9 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
128128

129129
/**
130130
* Set all {@link Attribute}s and their {@link AttributeModifier}s.

patches/api/0478-Add-an-API-for-CanPlaceOn-and-CanDestroy-NBT-values.patch

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,10 +228,10 @@ index 6d266c111bfa2bd51338e03ed740f6ac81ed07c7..d71531c384c57ea44d1e1fbe394214c1
228228
return key;
229229
}
230230
diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
231-
index 16a0c8215c9cd0940fb3fbb2617569279d371a13..115c1d9fd1961499065a7fcd9aadc69095ec6778 100644
231+
index 2035d54de7e446930f8fdd2a572240e70a21c656..e8c0b8848abce2c9e8b2be880de3897292f0b23e 100644
232232
--- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
233233
+++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
234-
@@ -1060,4 +1060,98 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
234+
@@ -1063,4 +1063,98 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste
235235
@SuppressWarnings("javadoc")
236236
@NotNull
237237
ItemMeta clone();

0 commit comments

Comments
 (0)