org.infinispan.filter

Interface KeyValueFilter<K,V>

All Known Subinterfaces:

KeyValueFilterConverter<K,V,C>

All Known Implementing Classes:

AbstractKeyValueFilterConverter, AcceptAllKeyValueFilter, CacheEventFilterAsKeyValueFilter, CacheEventFilterConverterAsKeyValueFilterConverter, CompositeKeyValueFilter, KeyFilterAsKeyValueFilter

@ThreadSafe
public interface KeyValueFilter<K,V>

A filter for keys with their values. This class is complemented by the KeyFilter class. This filter should be used in most cases over KeyFilter since it allows for more control of the filtering since it provides the ability to filter on the value and metadata in addition to the key.

Since:

7.0

Author:

William Burns

Method Summary

Modifier and Type	Method and Description
boolean	accept(K key, V value, Metadata metadata)
default MediaType	format()

Method Detail

accept

boolean accept(K key,
               V value,
               Metadata metadata)

Parameters:

key - key to test

value - value to use (could be null for the case of removal)

metadata - metadata

Returns:

true if the given key is accepted by this filter.

format

default MediaType format()

Returns:

The desired data format to be used in the accept(Object, Object, Metadata) operation. If null, the filter will receive data as it's stored.