org.bukkit.metadata

インタフェース MetadataStore<T>

public interface MetadataStore<T>

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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.

メソッドの詳細

setMetadata

void setMetadata(T subject,
                 String metadataKey,
                 MetadataValue newMetadataValue)

Adds a metadata value to an object.

パラメータ:

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 null

getMetadata

List<MetadataValue> getMetadata(T subject,
                                String metadataKey)

Returns all metadata values attached to an object. If multiple plugins have attached metadata, each will value will be included.

パラメータ:

subject - the object being interrogated.

metadataKey - the unique metadata key being sought.

戻り値:

A list of values, one for each plugin that has set the requested value.

hasMetadata

boolean hasMetadata(T subject,
                    String metadataKey)

Tests to see if a metadata attribute has been set on an object.

パラメータ:

subject - the object upon which the has-metadata test is performed.

metadataKey - the unique metadata key being queried.

戻り値:

the existence of the metadataKey within subject.

removeMetadata

void removeMetadata(T subject,
                    String metadataKey,
                    Plugin owningPlugin)

Removes a metadata item owned by a plugin from a subject.

パラメータ:

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 null

invalidateAll

void invalidateAll(Plugin owningPlugin)

Invalidates all metadata in the metadata store that originates from the given plugin. Doing this will force each invalidated metadata item to be recalculated the next time it is accessed.

パラメータ:

owningPlugin - the plugin requesting the invalidation.

例外:

IllegalArgumentException - If plugin is null