org.opendaylight.yangtools.objcache.spi

Class AbstractObjectCache

java.lang.Object

org.opendaylight.yangtools.objcache.spi.AbstractObjectCache

All Implemented Interfaces:

ObjectCache

public abstract class AbstractObjectCache
extends Object
implements ObjectCache

Abstract object cache implementation. This implementation takes care of interacting with the user and manages interaction with the Garbage Collector (via soft references). Subclasses are expected to provide a backing Cache instance and provide the

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractObjectCache.SoftKey<T> Key used in the underlying map.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractObjectCache(com.google.common.cache.Cache<AbstractObjectCache.SoftKey<?>,Object> cache, com.google.common.base.FinalizableReferenceQueue queue)

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> AbstractObjectCache.SoftKey<T>	createSoftKey(T object)
<B extends ProductAwareBuilder<P>,P> P	getProduct(B builder) Get a reference to an object equal to the product of a builder.
<T> T	getReference(T object) Get a reference for an object which is equal to specified object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractObjectCache

protected AbstractObjectCache(com.google.common.cache.Cache<AbstractObjectCache.SoftKey<?>,Object> cache,
                   com.google.common.base.FinalizableReferenceQueue queue)

Method Detail

createSoftKey

protected <T> AbstractObjectCache.SoftKey<T> createSoftKey(T object)

getProduct

public final <B extends ProductAwareBuilder<P>,P> P getProduct(B builder)

Description copied from interface: ObjectCache

Get a reference to an object equal to the product of a builder. The builder is expected to remain constant while this method executes. Unlike ObjectCache.getReference(Object), this method has the potential of completely eliding the product instantiation.

Specified by:

getProduct in interface ObjectCache

Type Parameters:

B - builder type

P - produced object type

Parameters:

builder - Builder instance, may not be null

Returns:

Result of builder's toInstance() product, or an equal object.

getReference

public final <T> T getReference(T object)

Description copied from interface: ObjectCache

Get a reference for an object which is equal to specified object. The cache is free return either a cached instance, or retain the object and return it back.

Specified by:

getReference in interface ObjectCache

Type Parameters:

T - object type

Parameters:

object - Requested object, may be null

Returns:

Reference to an object which is equal to the one passed in. If @object was @null, this method returns @null.