blob: 76d43266dd474b9b017d19dd7f9b7c57d4afb8d4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
package org.bukkit.inventory.meta;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.bukkit.configuration.serialization.ConfigurationSerializable;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.inventory.ItemFlag;
/**
* This type represents the storage mechanism for auxiliary item data.
* <p>
* An implementation will handle the creation and application for ItemMeta.
* This class should not be implemented by a plugin in a live environment.
*/
public interface ItemMeta extends Cloneable, ConfigurationSerializable {
/**
* Checks for existence of a display name.
*
* @return true if this has a display name
*/
boolean hasDisplayName();
/**
* Gets the display name that is set.
* <p>
* Plugins should check that hasDisplayName() returns <code>true</code>
* before calling this method.
*
* @return the display name that is set
*/
String getDisplayName();
/**
* Sets the display name.
*
* @param name the name to set
*/
void setDisplayName(String name);
/**
* Checks for existence of a localized name.
*
* @return true if this has a localized name
*/
boolean hasLocalizedName();
/**
* Gets the localized display name that is set.
* <p>
* Plugins should check that hasLocalizedName() returns <code>true</code>
* before calling this method.
*
* @return the localized name that is set
*/
String getLocalizedName();
/**
* Sets the localized name.
*
* @param name the name to set
*/
void setLocalizedName(String name);
/**
* Checks for existence of lore.
*
* @return true if this has lore
*/
boolean hasLore();
/**
* Gets the lore that is set.
* <p>
* Plugins should check if hasLore() returns <code>true</code> before
* calling this method.
*
* @return a list of lore that is set
*/
List<String> getLore();
/**
* Sets the lore for this item.
* Removes lore when given null.
*
* @param lore the lore that will be set
*/
void setLore(List<String> lore);
/**
* Checks for the existence of any enchantments.
*
* @return true if an enchantment exists on this meta
*/
boolean hasEnchants();
/**
* Checks for existence of the specified enchantment.
*
* @param ench enchantment to check
* @return true if this enchantment exists for this meta
*/
boolean hasEnchant(Enchantment ench);
/**
* Checks for the level of the specified enchantment.
*
* @param ench enchantment to check
* @return The level that the specified enchantment has, or 0 if none
*/
int getEnchantLevel(Enchantment ench);
/**
* Returns a copy the enchantments in this ItemMeta. <br>
* Returns an empty map if none.
*
* @return An immutable copy of the enchantments
*/
Map<Enchantment, Integer> getEnchants();
/**
* Adds the specified enchantment to this item meta.
*
* @param ench Enchantment to add
* @param level Level for the enchantment
* @param ignoreLevelRestriction this indicates the enchantment should be
* applied, ignoring the level limit
* @return true if the item meta changed as a result of this call, false
* otherwise
*/
boolean addEnchant(Enchantment ench, int level, boolean ignoreLevelRestriction);
/**
* Removes the specified enchantment from this item meta.
*
* @param ench Enchantment to remove
* @return true if the item meta changed as a result of this call, false
* otherwise
*/
boolean removeEnchant(Enchantment ench);
/**
* Checks if the specified enchantment conflicts with any enchantments in
* this ItemMeta.
*
* @param ench enchantment to test
* @return true if the enchantment conflicts, false otherwise
*/
boolean hasConflictingEnchant(Enchantment ench);
/**
* Set itemflags which should be ignored when rendering a ItemStack in the Client. This Method does silently ignore double set itemFlags.
*
* @param itemFlags The hideflags which shouldn't be rendered
*/
void addItemFlags(ItemFlag... itemFlags);
/**
* Remove specific set of itemFlags. This tells the Client it should render it again. This Method does silently ignore double removed itemFlags.
*
* @param itemFlags Hideflags which should be removed
*/
void removeItemFlags(ItemFlag... itemFlags);
/**
* Get current set itemFlags. The collection returned is unmodifiable.
*
* @return A set of all itemFlags set
*/
Set<ItemFlag> getItemFlags();
/**
* Check if the specified flag is present on this item.
*
* @param flag the flag to check
* @return if it is present
*/
boolean hasItemFlag(ItemFlag flag);
/**
* Return if the unbreakable tag is true. An unbreakable item will not lose
* durability.
*
* @return true if the unbreakable tag is true
*/
boolean isUnbreakable();
/**
* Sets the unbreakable tag. An unbreakable item will not lose durability.
*
* @param unbreakable true if set unbreakable
*/
void setUnbreakable(boolean unbreakable);
@SuppressWarnings("javadoc")
ItemMeta clone();
}
|
