|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.bukkit.metadata.MetadataStoreBase<T>
public abstract class MetadataStoreBase<T>
Constructor Summary | |
---|---|
MetadataStoreBase()
|
Method Summary | |
---|---|
protected abstract String |
disambiguate(T subject,
String metadataKey)
Creates a unique name for the object receiving metadata by combining unique data from the subject with a metadataKey. |
List<MetadataValue> |
getMetadata(T subject,
String metadataKey)
Returns all metadata values attached to an object. |
boolean |
hasMetadata(T subject,
String metadataKey)
Tests to see if a metadata attribute has been set on an object. |
void |
invalidateAll(Plugin owningPlugin)
Invalidates all metadata in the metadata store that originates from the given plugin. |
void |
removeMetadata(T subject,
String metadataKey,
Plugin owningPlugin)
Removes a metadata item owned by a plugin from a subject. |
void |
setMetadata(T subject,
String metadataKey,
MetadataValue newMetadataValue)
Adds a metadata value to an object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MetadataStoreBase()
Method Detail |
---|
public void setMetadata(T subject, String metadataKey, MetadataValue newMetadataValue)
Plugin
.
If a plugin has already added a metadata value to an object, that value
will be replaced with the value of newMetadataValue
. Multiple plugins can set independent values for
the same metadataKey
without conflict.
Implementation note: I considered using a ReadWriteLock
for controlling
access to metadataMap
, but decided that the added overhead wasn't worth the finer grained access control.
Bukkit is almost entirely single threaded so locking overhead shouldn't pose a problem.
subject
- The object receiving the metadata.metadataKey
- A unique key to identify this metadata.newMetadataValue
- The metadata value to apply.
IllegalArgumentException
- If value is null, or the owning plugin is nullMetadataStore.setMetadata(Object, String, MetadataValue)
public List<MetadataValue> getMetadata(T subject, String metadataKey)
subject
- the object being interrogated.metadataKey
- the unique metadata key being sought.
MetadataStore.getMetadata(Object, String)
public boolean hasMetadata(T subject, String metadataKey)
subject
- the object upon which the has-metadata test is performed.metadataKey
- the unique metadata key being queried.
public void removeMetadata(T subject, String metadataKey, Plugin owningPlugin)
subject
- the object to remove the metadata from.metadataKey
- the unique metadata key identifying the metadata to remove.owningPlugin
- the plugin attempting to remove a metadata item.
IllegalArgumentException
- If plugin is nullMetadataStore.removeMetadata(Object, String, org.bukkit.plugin.Plugin)
public void invalidateAll(Plugin owningPlugin)
owningPlugin
- the plugin requesting the invalidation.
IllegalArgumentException
- If plugin is nullMetadataStore.invalidateAll(org.bukkit.plugin.Plugin)
protected abstract String disambiguate(T subject, String metadataKey)
subject
- The object for which this key is being generated.metadataKey
- The name identifying the metadata value.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |