Package org.springframework.data.couchbase.cache

Class DefaultCouchbaseCacheWriter

java.lang.Object

org.springframework.data.couchbase.cache.DefaultCouchbaseCacheWriter

All Implemented Interfaces:

CouchbaseCacheWriter

public class DefaultCouchbaseCacheWriter
extends Object
implements CouchbaseCacheWriter

Constructor Summary

Constructors

Constructor	Description
DefaultCouchbaseCacheWriter(CouchbaseClientFactory clientFactory)

Method Summary

Modifier and Type	Method	Description
long	clear(String collectionName, String pattern)	Clears the cache with the given key pattern prefix.
Object	get(String collectionName, String key, com.couchbase.client.java.codec.Transcoder transcoder)	Get the binary value representation from Couchbase stored for the given key.
Object	get(String collectionName, String key, com.couchbase.client.java.codec.Transcoder transcoder, Class<?> clazz)	Get the binary value representation from Couchbase stored for the given key.
void	put(String collectionName, String key, Object value, Duration expiry, com.couchbase.client.java.codec.Transcoder transcoder)	Write the given key/value pair to Couchbase an set the expiration time if defined.
Object	putIfAbsent(String collectionName, String key, Object value, Duration expiry, com.couchbase.client.java.codec.Transcoder transcoder)	Write the given value to Couchbase if the key does not already exist.
Object	putIfAbsent(String collectionName, String key, Object value, Duration expiry, com.couchbase.client.java.codec.Transcoder transcoder, Class<?> clazz)	same as above, plus clazz
boolean	remove(String collectionName, String key)	Remove the given key from Couchbase.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCouchbaseCacheWriter

public DefaultCouchbaseCacheWriter(CouchbaseClientFactory clientFactory)

Method Details

put

public void put(String collectionName,
 String key,
 Object value,
 Duration expiry,
 com.couchbase.client.java.codec.Transcoder transcoder)

Description copied from interface: CouchbaseCacheWriter

Write the given key/value pair to Couchbase an set the expiration time if defined.

Specified by:

put in interface CouchbaseCacheWriter

Parameters:

collectionName - The cache name must not be null.

key - The key for the cache entry. Must not be null.

value - The value stored for the key. Must not be null.

expiry - Optional expiration time. Can be null.

transcoder - Optional transcoder to use. Can be null.

putIfAbsent

public Object putIfAbsent(String collectionName,
 String key,
 Object value,
 Duration expiry,
 com.couchbase.client.java.codec.Transcoder transcoder)

Description copied from interface: CouchbaseCacheWriter

Write the given value to Couchbase if the key does not already exist.

Specified by:

putIfAbsent in interface CouchbaseCacheWriter

Parameters:

collectionName - The cache name must not be null.

key - The key for the cache entry. Must not be null.

value - The value stored for the key. Must not be null.

expiry - Optional expiration time. Can be null.

transcoder - Optional transcoder to use. Can be null.

putIfAbsent

public Object putIfAbsent(String collectionName,
 String key,
 Object value,
 Duration expiry,
 com.couchbase.client.java.codec.Transcoder transcoder,
 @Nullable
 Class<?> clazz)

same as above, plus clazz

Specified by:

putIfAbsent in interface CouchbaseCacheWriter

Parameters:

collectionName -

key -

value -

expiry -

transcoder -

clazz -

get

public Object get(String collectionName,
 String key,
 com.couchbase.client.java.codec.Transcoder transcoder)

Description copied from interface: CouchbaseCacheWriter

Get the binary value representation from Couchbase stored for the given key.

Specified by:

get in interface CouchbaseCacheWriter

Parameters:

collectionName - must not be null.

key - must not be null.

transcoder - Optional transcoder to use. Can be null.

Returns:

null if key does not exist.

get

public Object get(String collectionName,
 String key,
 com.couchbase.client.java.codec.Transcoder transcoder,
 Class<?> clazz)

Description copied from interface: CouchbaseCacheWriter

Get the binary value representation from Couchbase stored for the given key.

Specified by:

get in interface CouchbaseCacheWriter

Parameters:

collectionName - must not be null.

key - must not be null.

transcoder - Optional transcoder to use. Can be null.

clazz - Optional class for contentAs(clazz)

Returns:

null if key does not exist.

remove

public boolean remove(String collectionName,
 String key)

Description copied from interface: CouchbaseCacheWriter

Remove the given key from Couchbase.

Specified by:

remove in interface CouchbaseCacheWriter

Parameters:

collectionName - The cache name must not be null.

key - The key for the cache entry. Must not be null.

Returns:

true if the document existed on removal, false otherwise.

clear

public long clear(String collectionName,
 String pattern)

Description copied from interface: CouchbaseCacheWriter

Clears the cache with the given key pattern prefix.

Specified by:

clear in interface CouchbaseCacheWriter

pattern - the pattern to clear.

Returns:

the number of cleared items.