me.lucko.helper.metadata

Interface MetadataRegistry<T>

Type Parameters:

T - the type

All Known Subinterfaces:

BlockMetadataRegistry, EntityMetadataRegistry, PlayerMetadataRegistry, WorldMetadataRegistry

All Known Implementing Classes:

AbstractMetadataRegistry

public interface MetadataRegistry<T>

A registry which provides and stores MetadataMaps for a given type.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Performs cache maintenance to remove empty map instances and expired transient values.
Optional<MetadataMap>	get(T id) Gets a MetadataMap for the given object, if one already exists and has been cached in this registry.
MetadataMap	provide(T id) Produces a MetadataMap for the given object.
void	remove(T id) Deletes the MetadataMap and all contained MetadataKeys for the given object.

Method Detail

provide

@Nonnull
MetadataMap provide(@Nonnull
                             T id)

Produces a MetadataMap for the given object.

Parameters:

id - the object

Returns:

a metadata map

get

@Nonnull
Optional<MetadataMap> get(@Nonnull
                                   T id)

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

Parameters:

id - the object

Returns:

a metadata map, if present

remove

void remove(@Nonnull
            T id)

Deletes the MetadataMap and all contained MetadataKeys for the given object.

Parameters:

id - the object

cleanup

void cleanup()

Performs cache maintenance to remove empty map instances and expired transient values.