me.lucko.helper.metadata.type

Interface PlayerMetadataRegistry

All Superinterfaces:

MetadataRegistry<UUID>

public interface PlayerMetadataRegistry
extends MetadataRegistry<UUID>

A registry which provides and stores MetadataMaps for Players.

Method Summary

Modifier and Type	Method and Description
Optional<MetadataMap>	get(org.bukkit.entity.Player player) Gets a MetadataMap for the given player, if one already exists and has been cached in this registry.
<K> Map<org.bukkit.entity.Player,K>	getAllWithKey(MetadataKey<K> key) Gets a map of the players with a given metadata key
MetadataMap	provide(org.bukkit.entity.Player player) Produces a MetadataMap for the given player.

Methods inherited from interface me.lucko.helper.metadata.MetadataRegistry

cleanup, get, provide, remove

Method Detail

provide

@Nonnull
MetadataMap provide(@Nonnull
                             org.bukkit.entity.Player player)

Produces a MetadataMap for the given player.

Parameters:

player - the player

Returns:

a metadata map

get

@Nonnull
Optional<MetadataMap> get(@Nonnull
                                   org.bukkit.entity.Player player)

Gets a MetadataMap for the given player, if one already exists and has been cached in this registry.

Parameters:

player - the player

Returns:

a metadata map, if present

getAllWithKey

@Nonnull
<K> Map<org.bukkit.entity.Player,K> getAllWithKey(@Nonnull
                                                           MetadataKey<K> key)

Gets a map of the players with a given metadata key

Type Parameters:

K - the key type

Parameters:

key - the key

Returns:

an immutable map of players to key value