me.lucko.helper.metadata

Class Metadata

java.lang.Object

me.lucko.helper.metadata.Metadata

public final class Metadata
extends Object

Provides access to MetadataRegistry instances bound to players, entities, blocks and worlds.

Method Summary

Modifier and Type	Method and Description
static BlockMetadataRegistry	blocks() Gets the MetadataRegistry for Blocks.
static EntityMetadataRegistry	entities() Gets the MetadataRegistry for Entitys.
static Optional<MetadataMap>	get(Object obj) Gets a MetadataMap for the given object, if one already exists and has been cached in this registry.
static Optional<MetadataMap>	getForBlock(org.bukkit.block.Block block)
static Optional<MetadataMap>	getForBlock(BlockPosition block)
static Optional<MetadataMap>	getForEntity(org.bukkit.entity.Entity entity)
static Optional<MetadataMap>	getForEntity(UUID uuid)
static Optional<MetadataMap>	getForPlayer(org.bukkit.entity.Player player)
static Optional<MetadataMap>	getForPlayer(UUID uuid)
static Optional<MetadataMap>	getForWorld(UUID uid)
static Optional<MetadataMap>	getForWorld(org.bukkit.World world)
static <T> Map<BlockPosition,T>	lookupBlocksWithKey(MetadataKey<T> key)
static <T> Map<org.bukkit.entity.Entity,T>	lookupEntitiesWithKey(MetadataKey<T> key)
static <T> Map<org.bukkit.entity.Player,T>	lookupPlayersWithKey(MetadataKey<T> key)
static <T> Map<org.bukkit.World,T>	lookupWorldsWithKey(MetadataKey<T> key)
static PlayerMetadataRegistry	players() Gets the MetadataRegistry for Players.
static MetadataMap	provide(Object obj) Produces a MetadataMap for the given object.
static MetadataMap	provideForBlock(org.bukkit.block.Block block)
static MetadataMap	provideForBlock(BlockPosition block)
static MetadataMap	provideForEntity(org.bukkit.entity.Entity entity)
static MetadataMap	provideForEntity(UUID uuid)
static MetadataMap	provideForPlayer(org.bukkit.entity.Player player)
static MetadataMap	provideForPlayer(UUID uuid)
static MetadataMap	provideForWorld(UUID uid)
static MetadataMap	provideForWorld(org.bukkit.World world)
static WorldMetadataRegistry	worlds() Gets the MetadataRegistry for Worlds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

players

public static PlayerMetadataRegistry players()

Gets the MetadataRegistry for Players.

Returns:

the PlayerMetadataRegistry

entities

public static EntityMetadataRegistry entities()

Gets the MetadataRegistry for Entitys.

Returns:

the EntityMetadataRegistry

blocks

public static BlockMetadataRegistry blocks()

Gets the MetadataRegistry for Blocks.

Returns:

the BlockMetadataRegistry

worlds

public static WorldMetadataRegistry worlds()

Gets the MetadataRegistry for Worlds.

Returns:

the WorldMetadataRegistry

provide

@Nonnull
public static MetadataMap provide(@Nonnull
                                           Object obj)

Produces a MetadataMap for the given object. A map will only be returned if the object is an instance of Player, UUID, Entity, Block or World.

Parameters:

obj - the object

Returns:

a metadata map

get

@Nonnull
public static Optional<MetadataMap> get(@Nonnull
                                                 Object obj)

Gets a MetadataMap for the given object, if one already exists and has been cached in this registry. A map will only be returned if the object is an instance of Player, UUID, Entity, Block or World.

Parameters:

obj - the object

Returns:

a metadata map

provideForPlayer

@Nonnull
public static MetadataMap provideForPlayer(@Nonnull
                                                    UUID uuid)

provideForPlayer

@Nonnull
public static MetadataMap provideForPlayer(@Nonnull
                                                    org.bukkit.entity.Player player)

getForPlayer

@Nonnull
public static Optional<MetadataMap> getForPlayer(@Nonnull
                                                          UUID uuid)

getForPlayer

@Nonnull
public static Optional<MetadataMap> getForPlayer(@Nonnull
                                                          org.bukkit.entity.Player player)

lookupPlayersWithKey

@Nonnull
public static <T> Map<org.bukkit.entity.Player,T> lookupPlayersWithKey(@Nonnull
                                                                                MetadataKey<T> key)

provideForEntity

@Nonnull
public static MetadataMap provideForEntity(@Nonnull
                                                    UUID uuid)

provideForEntity

@Nonnull
public static MetadataMap provideForEntity(@Nonnull
                                                    org.bukkit.entity.Entity entity)

getForEntity

@Nonnull
public static Optional<MetadataMap> getForEntity(@Nonnull
                                                          UUID uuid)

getForEntity

@Nonnull
public static Optional<MetadataMap> getForEntity(@Nonnull
                                                          org.bukkit.entity.Entity entity)

lookupEntitiesWithKey

@Nonnull
public static <T> Map<org.bukkit.entity.Entity,T> lookupEntitiesWithKey(@Nonnull
                                                                                 MetadataKey<T> key)

provideForBlock

@Nonnull
public static MetadataMap provideForBlock(@Nonnull
                                                   BlockPosition block)

provideForBlock

@Nonnull
public static MetadataMap provideForBlock(@Nonnull
                                                   org.bukkit.block.Block block)

getForBlock

@Nonnull
public static Optional<MetadataMap> getForBlock(@Nonnull
                                                         BlockPosition block)

getForBlock

@Nonnull
public static Optional<MetadataMap> getForBlock(@Nonnull
                                                         org.bukkit.block.Block block)

lookupBlocksWithKey

@Nonnull
public static <T> Map<BlockPosition,T> lookupBlocksWithKey(@Nonnull
                                                                    MetadataKey<T> key)

provideForWorld

@Nonnull
public static MetadataMap provideForWorld(@Nonnull
                                                   UUID uid)

provideForWorld

@Nonnull
public static MetadataMap provideForWorld(@Nonnull
                                                   org.bukkit.World world)

getForWorld

@Nonnull
public static Optional<MetadataMap> getForWorld(@Nonnull
                                                         UUID uid)

getForWorld

@Nonnull
public static Optional<MetadataMap> getForWorld(@Nonnull
                                                         org.bukkit.World world)

lookupWorldsWithKey

@Nonnull
public static <T> Map<org.bukkit.World,T> lookupWorldsWithKey(@Nonnull
                                                                       MetadataKey<T> key)