Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.metadata.Metadatable Interface Reference
Inheritance diagram for org.bukkit.metadata.Metadatable:
org.bukkit.block.Block org.bukkit.block.BlockState org.bukkit.entity.Entity org.bukkit.World org.bukkit.block.Beacon org.bukkit.block.BrewingStand org.bukkit.block.Chest org.bukkit.block.CommandBlock org.bukkit.block.CreatureSpawner org.bukkit.block.Dispenser org.bukkit.block.Dropper org.bukkit.block.Furnace org.bukkit.block.Hopper org.bukkit.block.Jukebox org.bukkit.block.NoteBlock org.bukkit.block.Sign org.bukkit.block.Skull org.bukkit.entity.ComplexEntityPart org.bukkit.entity.Damageable org.bukkit.entity.EnderCrystal org.bukkit.entity.EnderSignal org.bukkit.entity.ExperienceOrb org.bukkit.entity.Explosive org.bukkit.entity.FallingBlock org.bukkit.entity.Firework org.bukkit.entity.Hanging org.bukkit.entity.Item org.bukkit.entity.LivingEntity org.bukkit.entity.Projectile org.bukkit.entity.Vehicle org.bukkit.entity.Weather

Public Member Functions

void setMetadata (String metadataKey, MetadataValue newMetadataValue)
 
List< MetadataValuegetMetadata (String metadataKey)
 
boolean hasMetadata (String metadataKey)
 
void removeMetadata (String metadataKey, Plugin owningPlugin)
 

Detailed Description

This interface is implemented by all objects that can provide metadata about themselves.

Definition at line 11 of file Metadatable.java.

Member Function Documentation

List<MetadataValue> org.bukkit.metadata.Metadatable.getMetadata ( String  metadataKey)

Returns a list of previously set metadata values from the implementing object's metadata store.

Parameters
metadataKeythe unique metadata key being sought.
Returns
A list of values, one for each plugin that has set the requested value.
boolean org.bukkit.metadata.Metadatable.hasMetadata ( String  metadataKey)

Tests to see whether the implementing object contains the given metadata value in its metadata store.

Parameters
metadataKeythe unique metadata key being queried.
Returns
the existence of the metadataKey within subject.
void org.bukkit.metadata.Metadatable.removeMetadata ( String  metadataKey,
Plugin  owningPlugin 
)

Removes the given metadata value from the implementing object's metadata store.

Parameters
metadataKeythe unique metadata key identifying the metadata to remove.
owningPluginThis plugin's metadata value will be removed. All other values will be left untouched.
Exceptions
IllegalArgumentExceptionIf plugin is null
void org.bukkit.metadata.Metadatable.setMetadata ( String  metadataKey,
MetadataValue  newMetadataValue 
)

Sets a metadata value in the implementing object's metadata store.

Parameters
metadataKeyA unique key to identify this metadata.
newMetadataValueThe metadata value to apply.
Exceptions
IllegalArgumentExceptionIf value is null, or the owning plugin is null

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