me.lucko.helper.metadata

Class AbstractMetadataRegistry<T>

java.lang.Object

me.lucko.helper.metadata.AbstractMetadataRegistry<T>

Type Parameters:

T - the type

All Implemented Interfaces:

MetadataRegistry<T>

public class AbstractMetadataRegistry<T>
extends Object
implements MetadataRegistry<T>

A basic implementation of MetadataRegistry using a LoadingCache.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.cache.LoadingCache<T,MetadataMap>	cache

Constructor Summary

Constructors

Constructor and Description
AbstractMetadataRegistry()

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.

Methods inherited from class java.lang.Object

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

Field Detail

cache

@Nonnull
protected final com.google.common.cache.LoadingCache<T,MetadataMap> cache

Constructor Detail

AbstractMetadataRegistry

public AbstractMetadataRegistry()

Method Detail

provide

@Nonnull
public MetadataMap provide(@Nonnull
                                    T id)

Description copied from interface: MetadataRegistry

Produces a MetadataMap for the given object.

Specified by:

provide in interface MetadataRegistry<T>

Parameters:

id - the object

Returns:

a metadata map

get

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

Description copied from interface: MetadataRegistry

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

Specified by:

get in interface MetadataRegistry<T>

Parameters:

id - the object

Returns:

a metadata map, if present

remove

public void remove(@Nonnull
                   T id)

Description copied from interface: MetadataRegistry

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

Specified by:

remove in interface MetadataRegistry<T>

Parameters:

id - the object

cleanup

public void cleanup()

Description copied from interface: MetadataRegistry

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

Specified by:

cleanup in interface MetadataRegistry<T>