com.hazelcast.map.impl.querycache.subscriber

Interface QueryCacheRequest

public interface QueryCacheRequest

Represents a user request for creating a QueryCache.

Method Summary

Modifier and Type	Method and Description
QueryCacheRequest	forMap(IMap map) Setter for underlying IMap for this QueryCache.
String	getCacheName() Returns name of the QueryCache to be created.
QueryCacheContext	getContext() Returns the QueryCacheContext on this node/client.
MapListener	getListener() Returns the listener for the QueryCache to be created.
IMap	getMap() Returns underlying IMap.
String	getMapName() Returns name of underlying IMap.
Predicate	getPredicate() Returns predicate which is set.
String	getUserGivenCacheName() Returns the name which is given by the user.
Boolean	isIncludeValue() Returns true if values will be cached otherwise false.
QueryCacheRequest	withCacheName(String cacheName) Setter for name of the QueryCache.
QueryCacheRequest	withContext(QueryCacheContext context) The QueryCacheContext on this node/client.
QueryCacheRequest	withIncludeValue(Boolean includeValue) Setter for the QueryCache for deciding whether the implementation should cache values of entries.
QueryCacheRequest	withListener(MapListener listener) Setter for the listener which will be used to listen the QueryCache.
QueryCacheRequest	withPredicate(Predicate predicate) Setter for the predicate which will be used to filter underlying IMap of this QueryCache.
QueryCacheRequest	withUserGivenCacheName(String userGivenCacheName) Sets the user given name for the QueryCache.

Method Detail

forMap

QueryCacheRequest forMap(IMap map)

Setter for underlying IMap for this QueryCache.

Parameters:

map - underlying IMap

Returns:

this request object.

withCacheName

QueryCacheRequest withCacheName(String cacheName)

Setter for name of the QueryCache.

Parameters:

cacheName - name of QueryCache

Returns:

this request object.

withUserGivenCacheName

QueryCacheRequest withUserGivenCacheName(String userGivenCacheName)

Sets the user given name for the QueryCache.

Parameters:

userGivenCacheName - name of QueryCache

Returns:

this request object.

withPredicate

QueryCacheRequest withPredicate(Predicate predicate)

Setter for the predicate which will be used to filter underlying IMap of this QueryCache.

Parameters:

predicate - the predicate

Returns:

this request object.

withListener

QueryCacheRequest withListener(MapListener listener)

Setter for the listener which will be used to listen the QueryCache.

Parameters:

listener - the listener

Returns:

this request object.

withIncludeValue

QueryCacheRequest withIncludeValue(Boolean includeValue)

Setter for the QueryCache for deciding whether the implementation should cache values of entries.

Parameters:

includeValue - true for caching values in the QueryCache otherwise false to cache only keys.

Returns:

this request object.

withContext

QueryCacheRequest withContext(QueryCacheContext context)

The QueryCacheContext on this node/client.

Parameters:

context - the QueryCacheContext

Returns:

this request object.

getMap

IMap getMap()

Returns underlying IMap.

Returns:

underlying IMap

getMapName

String getMapName()

Returns name of underlying IMap.

Returns:

name of underlying IMap

getCacheName

String getCacheName()

Returns name of the QueryCache to be created.

Returns:

name of the QueryCache to be created.

getUserGivenCacheName

String getUserGivenCacheName()

Returns the name which is given by the user.

Returns:

user given name of the QueryCache to be created.

getPredicate

Predicate getPredicate()

Returns predicate which is set.

Returns:

the predicate.

getListener

MapListener getListener()

Returns the listener for the QueryCache to be created.

Returns:

the listener.

isIncludeValue

Boolean isIncludeValue()

Returns true if values will be cached otherwise false.

Returns:

true if values will be cached otherwise false

getContext

QueryCacheContext getContext()

Returns the QueryCacheContext on this node/client.

Returns:

the QueryCacheContext on this node/client.