Public Member Functions
void	setMetadata (T subject, String metadataKey, MetadataValue newMetadataValue)
	Adds a metadata value to an object.

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	removeMetadata (T subject, String metadataKey, Plugin owningPlugin)
	Removes a metadata item owned by a plugin from a subject.

void	invalidateAll (Plugin owningPlugin)
	Invalidates all metadata in the metadata store that originates from the given plugin.

Detailed Description

Definition at line 7 of file MetadataStore.java.

Member Function Documentation

List<MetadataValue> org.bukkit.metadata.MetadataStore< T >.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.

Parameters

subject	the object being interrogated.
metadataKey	the unique metadata key being sought.

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

boolean org.bukkit.metadata.MetadataStore< T >.hasMetadata	(	T	subject,
		String	metadataKey
	)

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

Parameters

subject	the object upon which the has-metadata test is performed.
metadataKey	the unique metadata key being queried.

void org.bukkit.metadata.MetadataStore< T >.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.

Parameters

owningPlugin the plugin requesting the invalidation.

Exceptions

IllegalArgumentException If plugin is null

void org.bukkit.metadata.MetadataStore< T >.removeMetadata	(	T	subject,
		String	metadataKey,
		Plugin	owningPlugin
	)

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

Parameters

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.

Exceptions

IllegalArgumentException If plugin is null

void org.bukkit.metadata.MetadataStore< T >.setMetadata	(	T	subject,
		String	metadataKey,
		MetadataValue	newMetadataValue
	)

Adds a metadata value to an object.

Parameters

subject	The object receiving the metadata.
metadataKey	A unique key to identify this metadata.
newMetadataValue	The metadata value to apply.

Exceptions

IllegalArgumentException If value is null, or the owning plugin is null

The documentation for this interface was generated from the following file: