com.commercetools.sync.commons.utils

Interface ReferenceIdToKeyCache

All Known Implementing Classes:

CaffeineReferenceIdToKeyCacheImpl

public interface ReferenceIdToKeyCache

A Interface used to manage cache to store reference id to key pairs.

The cache can be implemented by any caching library and override the methods to perform caching operations. Default cache implementation is provided in the library class CaffeineReferenceIdToKeyCacheImplCaffeineReferenceIdToKeyCacheImpl.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String key, java.lang.String value)
void	addAll(java.util.Map<java.lang.String,java.lang.String> idToKeyValues)
void	clearCache() Discards all entries in the cache.
boolean	containsKey(java.lang.String key)
java.lang.String	get(java.lang.String key)
void	remove(java.lang.String key)

Method Detail

add

void add(@Nonnull
         java.lang.String key,
         @Nonnull
         java.lang.String value)

Parameters:

key - key with which the specified value is to be associated.

value - value to be associated with the specified key.

remove

void remove(@Nonnull
            java.lang.String key)

Parameters:

key - key whose mapping is to be removed from the map

addAll

void addAll(@Nonnull
            java.util.Map<java.lang.String,java.lang.String> idToKeyValues)

Parameters:

idToKeyValues - mappings to be stored in this cache.

containsKey

boolean containsKey(@Nonnull
                    java.lang.String key)

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key in the cache.

get

java.lang.String get(@Nonnull
                     java.lang.String key)

Parameters:

key - the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped, or null if the cache contains no mapping for the key.

clearCache

void clearCache()

Discards all entries in the cache.