Package com.tangosol.net

Class ViewBuilder<K,V>

java.lang.Object

com.tangosol.net.MapViewBuilder<K,V>

com.tangosol.net.ViewBuilder<K,V>

Type Parameters:

K - the type of the cache entry keys

V - the type of the entry values in the back cache that is used as the source for this view

public class ViewBuilder<K,V>
extends MapViewBuilder<K,V>

The ViewBuilder provides a means to build() a view (ContinuousQueryCache) using a fluent pattern / style.

Since:

12.2.1.4

Author:

rl 5.22.19

See Also:

• ContinuousQueryCache

Field Summary

Fields inherited from class com.tangosol.net.MapViewBuilder

f_supplierNamedCache, m_comparator, m_fCacheValues, m_filter, m_listener, m_loader, m_mapper

Constructor Summary

Constructors

Constructor	Description
ViewBuilder(NamedCache<K,V> cache)	Construct a new ViewBuilder for the provided NamedCache.
ViewBuilder(Supplier<NamedCache<K,V>> supplierNamedCache)	Construct a new ViewBuilder for the provided NamedCache.

Method Summary

Modifier and Type	Method	Description
NamedCache<K,V>	build()	Construct a view of the NamedCache provided to this builder.
ViewBuilder<K,V>	filter(Filter<?> filter)	The Filter that will be used to define the entries maintained in this view.
ViewBuilder<K,V>	keys()	The resulting view will only cache keys.
ViewBuilder<K,V>	listener(MapListener<? super K,? super V> listener)	The MapListener that will receive all events, including those that result from the initial population of the view.
<U> ViewBuilder<K,U>	map(ValueExtractor<? super V,? extends U> mapper)	The ValueExtractor that this view will use to transform the results from the underlying cache prior to storing them locally.
ViewBuilder<K,V>	sorted()	Ensure that the view is sorted based on the natural order of the values, which must implement Comparable interface.
ViewBuilder<K,V>	sorted(Comparator<? super V> comparator)	Ensure that the view is sorted using specified Comparator.
ViewBuilder<K,V>	values()	The resulting view with cache both keys and values.
ViewBuilder<K,V>	withClassLoader(ClassLoader loader)	The optional ClassLoader to use when performing serialization/de-serialization operations.

Methods inherited from class java.lang.Object

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

Constructor Details

ViewBuilder

public ViewBuilder(NamedCache<K,V> cache)

Construct a new ViewBuilder for the provided NamedCache.

Parameters:

cache - the NamedCache from which the view will be created

ViewBuilder

public ViewBuilder(Supplier<NamedCache<K,V>> supplierNamedCache)

Construct a new ViewBuilder for the provided NamedCache. The Supplier should return a new NamedCache instance upon each invocation.

Parameters:

supplierNamedCache - the Supplier returning a NamedCache from which the view will be created

Method Details

filter

public ViewBuilder<K,V> filter(Filter<?> filter)

The Filter that will be used to define the entries maintained in this view. If no Filter is specified, AlwaysFilter.INSTANCE will be used.

Overrides:

filter in class MapViewBuilder<K,V>

Parameters:

filter - the Filter that will be used to query the underlying NamedCache

Returns:

this ViewBuilder

listener

public ViewBuilder<K,V> listener(MapListener<? super K,? super V> listener)

The MapListener that will receive all events, including those that result from the initial population of the view.

Overrides:

listener in class MapViewBuilder<K,V>

Parameters:

listener - the MapListener that will receive all the events from the view, including those corresponding to its initial population.

Returns:

this ViewBuilder

map

public <U> ViewBuilder<K,U> map(ValueExtractor<? super V,? extends U> mapper)

The ValueExtractor that this view will use to transform the results from the underlying cache prior to storing them locally.

Overrides:

map in class MapViewBuilder<K,V>

Type Parameters:

U - the type of the extracted value

Parameters:

mapper - the ValueExtractor that will be used to transform values retrieved from the underlying cache before storing them locally; if specified, this view will become read-only

Returns:

this ViewBuilder

sorted

public ViewBuilder<K,V> sorted()

Ensure that the view is sorted based on the natural order of the values, which must implement Comparable interface.

Overrides:

sorted in class MapViewBuilder<K,V>

Returns:

this MapViewBuilder

sorted

public ViewBuilder<K,V> sorted(Comparator<? super V> comparator)

Ensure that the view is sorted using specified Comparator.

Overrides:

sorted in class MapViewBuilder<K,V>

Parameters:

comparator - the Comparator that will be used to sort the entries in this view; if null, the entries will be sorted based on the natural order of the values, which must implement Comparable interface

Returns:

this MapViewBuilder

keys

public ViewBuilder<K,V> keys()

The resulting view will only cache keys.

NOTE: this is mutually exclusive with values().

Overrides:

keys in class MapViewBuilder<K,V>

Returns:

this ViewBuilder

values

public ViewBuilder<K,V> values()

The resulting view with cache both keys and values.

NOTE: this is mutually exclusive with keys().

Overrides:

values in class MapViewBuilder<K,V>

Returns:

this ViewBuilder

withClassLoader

public ViewBuilder<K,V> withClassLoader(ClassLoader loader)

The optional ClassLoader to use when performing serialization/de-serialization operations.

Overrides:

withClassLoader in class MapViewBuilder<K,V>

Parameters:

loader - the ClassLoader

Returns:

this ViewBuilder

build

public NamedCache<K,V> build()

Construct a view of the NamedCache provided to this builder.

Overrides:

build in class MapViewBuilder<K,V>

Returns:

the view of the NamedCache provided to this builder