## Uses of Interface
com.hazelcast.query.Predicate

- Packages that use Predicate
  Package | Description
  --- | ---
  com.hazelcast.client.proxy | This package contains client side proxy implementations of the different Hazelcast data structures and operation types
  com.hazelcast.client.proxy.txn | Contains classes related to proxy for client transactions
  com.hazelcast.config | Provides classes for configuring HazelcastInstance.
  com.hazelcast.core | Provides core API interfaces/classes.
  com.hazelcast.jet.core.processor | Contains static utility classes with factories of Jet processors.
  com.hazelcast.jet.pipeline | The Pipeline API is Jet's high-level API to build and execute distributed computation jobs.
  com.hazelcast.map | Contains Hazelcast map module classes.
  com.hazelcast.mapreduce.aggregation | This package contains the aggregation API and the convenience helper classes to retrieve predefined aggregation implementations.
  com.hazelcast.query | Contains interfaces/classes related to Hazelcast query and indexing support.

- - ### Uses of Predicate in com.hazelcast.client.proxy

    Methods in com.hazelcast.client.proxy with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `String` | ClientReplicatedMapProxy.`addEntryListener(EntryListener<K,V> listener, Predicate<K,V> predicate)`
    `String` | ClientReplicatedMapProxy.`addEntryListener(EntryListener<K,V> listener, Predicate<K,V> predicate, K key)`
    `String` | ClientMapProxy.`addEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)`
    `String` | ClientMapProxy.`addEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)`
    `String` | ClientMapProxy.`addEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)`
    `String` | ClientMapProxy.`addEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)`
    `String` | ClientMapProxy.`addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)`
    `String` | ClientMapProxy.`addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)`
    `String` | ClientMapProxy.`addLocalEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)`
    `String` | ClientMapProxy.`addLocalEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)`
    `<R> R` | ClientMapProxy.`aggregate(Aggregator<Map.Entry<K,V>,R> aggregator, Predicate<K,V> predicate)`
    `Set<Map.Entry<K,V>>` | ClientMapProxy.`entrySet(Predicate predicate)`
    `Map<K,Object>` | ClientMapProxy.`executeOnEntries(EntryProcessor entryProcessor, Predicate predicate)`
    `QueryCache<K,V>` | ClientMapProxy.`getQueryCache(String name, MapListener listener, Predicate<K,V> predicate, boolean includeValue)`
    `QueryCache<K,V>` | ClientMapProxy.`getQueryCache(String name, Predicate<K,V> predicate, boolean includeValue)`
    `<R> Iterator<R>` | ClientMapProxy.`iterator(int fetchSize, int partitionId, Projection<Map.Entry<K,V>,R> projection, Predicate<K,V> predicate)` Returns an iterator for iterating the result of the projection on entries in the `partitionId` which satisfy the `predicate`.
    `Set<K>` | ClientMapProxy.`keySet(Predicate predicate)`
    `Set<K>` | ClientMapProxy.`localKeySet(Predicate predicate)`
    `<R> Collection<R>` | ClientMapProxy.`project(Projection<Map.Entry<K,V>,R> projection, Predicate<K,V> predicate)`
    `void` | ClientMapProxy.`removeAll(Predicate<K,V> predicate)`
    `protected void` | NearCachedClientMapProxy.`removeAllInternal(Predicate predicate)`
    `protected void` | ClientMapProxy.`removeAllInternal(Predicate predicate)`
    `Collection<V>` | ClientMapProxy.`values(Predicate predicate)`

  - ### Uses of Predicate in com.hazelcast.client.proxy.txn

    Methods in com.hazelcast.client.proxy.txn with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `Set<K>` | ClientTxnMapProxy.`keySet(Predicate predicate)`
    `Collection<V>` | ClientTxnMapProxy.`values(Predicate predicate)`

  - ### Uses of Predicate in com.hazelcast.config

    Fields in com.hazelcast.config declared as Predicate
    Modifier and Type | Field and Description
    --- | ---
    `protected Predicate` | PredicateConfig.`implementation`

    Methods in com.hazelcast.config that return Predicate
    Modifier and Type | Method and Description
    --- | ---
    `Predicate` | PredicateConfig.`getImplementation()` Returns the Predicate implementation.

    Methods in com.hazelcast.config with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `PredicateConfig` | PredicateConfig.`setImplementation(Predicate implementation)` Sets the Predicate implementation.

    Constructors in com.hazelcast.config with parameters of type Predicate
    Constructor and Description
    `PredicateConfig(Predicate implementation)` Creates a PredicateConfig with the given implementation.

  - ### Uses of Predicate in com.hazelcast.core

    Methods in com.hazelcast.core with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `String` | ReplicatedMap.`addEntryListener(EntryListener<K,V> listener, Predicate<K,V> predicate)` Adds an continuous entry listener for this map.
    `String` | ReplicatedMap.`addEntryListener(EntryListener<K,V> listener, Predicate<K,V> predicate, K key)` Adds an continuous entry listener for this map.
    `String` | IMap.`addEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)` Deprecated. please use `IMap.addEntryListener(MapListener, com.hazelcast.query.Predicate, boolean)` instead
    `String` | IMap.`addEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Deprecated. please use `IMap.addEntryListener(MapListener, com.hazelcast.query.Predicate, Object, boolean)` instead
    `String` | IMap.`addEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)` Adds a `MapListener` for this map.
    `String` | IMap.`addEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Adds a `MapListener` for this map.
    `String` | IMap.`addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)` Deprecated. please use `IMap.addLocalEntryListener(MapListener, com.hazelcast.query.Predicate, boolean)` instead
    `String` | IMap.`addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Deprecated. please use `IMap.addLocalEntryListener(MapListener, com.hazelcast.query.Predicate, Object, boolean)` instead
    `String` | IMap.`addLocalEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)` Adds a `MapListener` for this map.
    `String` | IMap.`addLocalEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Adds a local entry listener for this map.
    `<R> R` | IMap.`aggregate(Aggregator<Map.Entry<K,V>,R> aggregator, Predicate<K,V> predicate)` Applies the aggregation logic on map entries filtered with the Predicated and returns the result
    `Set<Map.Entry<K,V>>` | IMap.`entrySet(Predicate predicate)` Queries the map based on the specified predicate and returns the matching entries.
    `Map<K,Object>` | IMap.`executeOnEntries(EntryProcessor entryProcessor, Predicate predicate)` Applies the user defined `EntryProcessor` to the entries in the map which satisfy provided predicate.
    `QueryCache<K,V>` | IMap.`getQueryCache(String name, MapListener listener, Predicate<K,V> predicate, boolean includeValue)` Creates an always up to date snapshot of this `IMap` according to the supplied parameters.
    `QueryCache<K,V>` | IMap.`getQueryCache(String name, Predicate<K,V> predicate, boolean includeValue)` Creates an always up to date snapshot of this `IMap` according to the supplied parameters.
    `Set<K>` | TransactionalMap.`keySet(Predicate predicate)` Transactional implementation of `IMap.keySet(com.hazelcast.query.Predicate)`.
    `Set<K>` | IMap.`keySet(Predicate predicate)` Queries the map based on the specified predicate and returns the keys of matching entries.
    `Set<K>` | BaseMap.`keySet(Predicate predicate)` Queries the map based on the specified predicate and returns the keys of matching entries.
    `Set<K>` | IMap.`localKeySet(Predicate predicate)` Returns the keys of matching locally owned entries.
    `<R> Collection<R>` | IMap.`project(Projection<Map.Entry<K,V>,R> projection, Predicate<K,V> predicate)` Applies the projection logic on map entries filtered with the Predicated and returns the result
    `void` | IMap.`removeAll(Predicate<K,V> predicate)` Removes all entries which match with the supplied predicate.
    `Collection<V>` | TransactionalMap.`values(Predicate predicate)` Transactional implementation of `IMap.values(com.hazelcast.query.Predicate)`.
    `Collection<V>` | IMap.`values(Predicate predicate)` Queries the map based on the specified predicate and returns the values of matching entries.
    `Collection<V>` | BaseMap.`values(Predicate predicate)` Queries the map based on the specified predicate and returns the values of matching entries.

  - ### Uses of Predicate in com.hazelcast.jet.core.processor

    Methods in com.hazelcast.jet.core.processor with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `static <T,K,V> ProcessorMetaSupplier` | SourceProcessors.`readMapP(String mapName, Predicate<? super K,? super V> predicate, FunctionEx<? super Map.Entry<K,V>,? extends T> projection)` Returns a supplier of processors for `Sources.map(String, Predicate, FunctionEx)`.
    `static <T,K,V> ProcessorMetaSupplier` | SourceProcessors.`readMapP(String mapName, Predicate<? super K,? super V> predicate, Projection<? super Map.Entry<K,V>,? extends T> projection)` Returns a supplier of processors for `Sources.map(String, Predicate, Projection)`.
    `static <T,K,V> ProcessorSupplier` | SourceProcessors.`readRemoteMapP(String mapName, ClientConfig clientConfig, Predicate<? super K,? super V> predicate, FunctionEx<? super Map.Entry<K,V>,? extends T> projectionFn)` Returns a supplier of processors for `Sources.remoteMap(String, ClientConfig, Predicate, FunctionEx)`.
    `static <T,K,V> ProcessorSupplier` | SourceProcessors.`readRemoteMapP(String mapName, ClientConfig clientConfig, Predicate<? super K,? super V> predicate, Projection<? super Map.Entry<K,V>,? extends T> projection)` Returns a supplier of processors for `Sources.remoteMap(String, ClientConfig, Predicate, Projection)`.

  - ### Uses of Predicate in com.hazelcast.jet.pipeline

    Methods in com.hazelcast.jet.pipeline that return Predicate
    Modifier and Type | Method and Description
    --- | ---
    `static <K,V> Predicate<K,V>` | GenericPredicates.`alwaysFalse()` See `Predicates.alwaysFalse()`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`alwaysTrue()` See `Predicates.alwaysTrue()`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`and(Predicate<K,V>... predicates)` See `Predicates.and(Predicate[])`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`between(String attribute, Comparable from, Comparable to)` See `Predicates.between(String, Comparable, Comparable)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`equal(String attribute, Comparable value)` See `Predicates.equal(String, Comparable)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`greaterEqual(String attribute, Comparable value)` See `Predicates.greaterEqual(String, Comparable)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`greaterThan(String attribute, Comparable value)` See `Predicates.greaterThan(String, Comparable)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`ilike(String attribute, String pattern)` See `Predicates.ilike(String, String)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`in(String attribute, Comparable... values)` See `Predicates.in(String, Comparable[])`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`instanceOf(Class<? extends V> klass)` See `Predicates.instanceOf(Class)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`lessEqual(String attribute, Comparable value)` See `Predicates.lessEqual(String, Comparable)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`lessThan(String attribute, Comparable value)` See `Predicates.lessThan(String, Comparable)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`like(String attribute, String pattern)` See `Predicates.like(String, String)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`not(Predicate<K,V> predicate)` See `Predicates.not(Predicate)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`notEqual(String attribute, Comparable value)` See `Predicates.notEqual(String, Comparable)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`or(Predicate<K,V>... predicates)` See `Predicates.or(Predicate[])`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`regex(String attribute, String pattern)` See `Predicates.regex(String, String)`.

    Methods in com.hazelcast.jet.pipeline with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `static <K,V> Predicate<K,V>` | GenericPredicates.`and(Predicate<K,V>... predicates)` See `Predicates.and(Predicate[])`.
    `static <T,K,V> BatchSource<T>` | Sources.`map(IMap<? extends K,? extends V> map, Predicate<? super K,? super V> predicate, FunctionEx<? super Map.Entry<K,V>,? extends T> projection)` Convenience for `Sources.map(IMap, Predicate, Projection)` which uses a `FunctionEx` as the projection function.
    `static <T,K,V> BatchSource<T>` | Sources.`map(IMap<? extends K,? extends V> map, Predicate<? super K,? super V> predicate, Projection<? super Map.Entry<K,V>,? extends T> projection)` Returns a source that fetches entries from the given Hazelcast `IMap`.
    `static <T,K,V> BatchSource<T>` | Sources.`map(String mapName, Predicate<? super K,? super V> predicate, FunctionEx<? super Map.Entry<K,V>,? extends T> projection)` Convenience for `Sources.map(String, Predicate, Projection)` which uses a `FunctionEx` as the projection function.
    `static <T,K,V> BatchSource<T>` | Sources.`map(String mapName, Predicate<? super K,? super V> predicate, Projection<? super Map.Entry<K,V>,? extends T> projection)` Returns a source that fetches entries from a local Hazelcast `IMap` with the specified name.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`not(Predicate<K,V> predicate)` See `Predicates.not(Predicate)`.
    `static <K,V> Predicate<K,V>` | GenericPredicates.`or(Predicate<K,V>... predicates)` See `Predicates.or(Predicate[])`.
    `static <T,K,V> BatchSource<T>` | Sources.`remoteMap(String mapName, ClientConfig clientConfig, Predicate<? super K,? super V> predicate, FunctionEx<? super Map.Entry<K,V>,? extends T> projection)` Convenience for `Sources.remoteMap(String, ClientConfig, Predicate, Projection)` which use a `FunctionEx` as the projection function.
    `static <T,K,V> BatchSource<T>` | Sources.`remoteMap(String mapName, ClientConfig clientConfig, Predicate<? super K,? super V> predicate, Projection<? super Map.Entry<K,V>,? extends T> projection)` Returns a source that fetches entries from a remote Hazelcast `IMap` with the specified name in a remote cluster identified by the supplied `ClientConfig`.

  - ### Uses of Predicate in com.hazelcast.map

    Methods in com.hazelcast.map with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `String` | QueryCache.`addEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)`
    `String` | QueryCache.`addEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)`
    `Set<Map.Entry<K,V>>` | QueryCache.`entrySet(Predicate predicate)`
    `Set<K>` | QueryCache.`keySet(Predicate predicate)`
    `Collection<V>` | QueryCache.`values(Predicate predicate)`

  - ### Uses of Predicate in com.hazelcast.mapreduce.aggregation

    Methods in com.hazelcast.mapreduce.aggregation with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `static <KeyIn,ValueIn,ValueOut> Supplier<KeyIn,ValueIn,ValueOut>` | Supplier.`fromPredicate(Predicate<KeyIn,ValueIn> predicate)` Deprecated. The predefined Supplier selects values using the given `Predicate` and does not perform any kind of data transformation.
    `static <KeyIn,ValueIn,ValueOut> Supplier<KeyIn,ValueIn,ValueOut>` | Supplier.`fromPredicate(Predicate<KeyIn,ValueIn> predicate, Supplier<KeyIn,ValueIn,ValueOut> chainedSupplier)` Deprecated. The predefined Supplier selects values using the given `Predicate` and chains the filtered value to the given Supplier which might perform data transformation.

  - ### Uses of Predicate in com.hazelcast.query

    Subinterfaces of Predicate in com.hazelcast.query
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IndexAwarePredicate<K,V>` Extends the `Predicate` interface with the ability to support indexes.

    Classes in com.hazelcast.query that implement Predicate
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PagingPredicate<K,V>` This class is a special Predicate which helps to get a page-by-page result of a query.
    `class` | `PartitionPredicate<K,V>` A `Predicate` that restricts the execution of a Predicate to a single Partition.
    `class` | `PredicateBuilder` This class provides functionality to build predicate.
    `class` | `SqlPredicate` This class contains methods related to conversion of sql query to predicate.
    `class` | `TruePredicate<K,V>` A `Predicate` which always returns true.

    Methods in com.hazelcast.query that return Predicate
    Modifier and Type | Method and Description
    --- | ---
    `Predicate` | VisitablePredicate.`accept(com.hazelcast.query.impl.predicates.Visitor visitor, com.hazelcast.query.impl.Indexes indexes)` Accept visitor.
    `Predicate` | SqlPredicate.`accept(com.hazelcast.query.impl.predicates.Visitor visitor, com.hazelcast.query.impl.Indexes indexes)`
    `Predicate` | PagingPredicate.`accept(com.hazelcast.query.impl.predicates.Visitor visitor, com.hazelcast.query.impl.Indexes indexes)`
    `static <K,V> Predicate<K,V>` | Predicates.`alwaysFalse()` Creates an always false predicate that will filter out all items.
    `static <K,V> Predicate<K,V>` | Predicates.`alwaysTrue()` Creates an always true predicate that will pass all items.
    `static Predicate` | Predicates.`and(Predicate... predicates)` Creates an and predicate that will perform the logical and operation on the given `predicates`.
    `static Predicate` | Predicates.`between(String attribute, Comparable from, Comparable to)` Creates a between predicate that will pass items if the value stored under the given item `attribute` is contained inside the given range.
    `static Predicate` | Predicates.`equal(String attribute, Comparable value)` Creates an equal predicate that will pass items if the given `value` and the value stored under the given item `attribute` are equal.
    `Predicate` | SqlPredicate.`getPredicate()`
    `Predicate<K,V>` | PagingPredicate.`getPredicate()`
    `Predicate<K,V>` | PartitionPredicate.`getTarget()` Returns the target `Predicate`.
    `static Predicate` | Predicates.`greaterEqual(String attribute, Comparable value)` Creates a greater than or equal to predicate that will pass items if the value stored under the given item `attribute` is greater than or equal to the given `value`.
    `static Predicate` | Predicates.`greaterThan(String attribute, Comparable value)` Creates a greater than predicate that will pass items if the value stored under the given item `attribute` is greater than the given `value`.
    `static Predicate` | Predicates.`ilike(String attribute, String pattern)` Creates a case-insensitive like predicate that will pass items if the given `pattern` matches the value stored under the given item `attribute` in a case-insensitive manner.
    `static Predicate` | Predicates.`in(String attribute, Comparable... values)` Creates a in predicate that will pass items if the value stored under the given item `attribute` is a member of the given `values` set.
    `static Predicate` | Predicates.`instanceOf(Class klass)` Creates an instance of predicate that will pass entries for which the value class is an `instanceof` the given `klass`.
    `static Predicate` | Predicates.`lessEqual(String attribute, Comparable value)` Creates a less than or equal to predicate that will pass items if the value stored under the given item `attribute` is less than or equal to the given `value`.
    `static Predicate` | Predicates.`lessThan(String attribute, Comparable value)` Creates a less than predicate that will pass items if the value stored under the given item `attribute` is less than the given `value`.
    `static Predicate` | Predicates.`like(String attribute, String pattern)` Creates a like predicate that will pass items if the given `pattern` matches the value stored under the given item `attribute`.
    `static Predicate` | Predicates.`not(Predicate predicate)` Creates a not predicate that will negate the result of the given `predicate`.
    `static Predicate` | Predicates.`notEqual(String attribute, Comparable value)` Creates a not equal predicate that will pass items if the given `value` and the value stored under the given item `attribute` are not equal.
    `static Predicate` | Predicates.`or(Predicate... predicates)` Creates an or predicate that will perform the logical or operation on the given `predicates`.
    `static Predicate` | Predicates.`regex(String attribute, String pattern)` Creates a regex predicate that will pass items if the given `pattern` matches the value stored under the given item `attribute`.

    Methods in com.hazelcast.query with parameters of type Predicate
    Modifier and Type | Method and Description
    --- | ---
    `static Predicate` | Predicates.`and(Predicate... predicates)` Creates an and predicate that will perform the logical and operation on the given `predicates`.
    `PredicateBuilder` | PredicateBuilder.`and(Predicate predicate)`
    `static Predicate` | Predicates.`not(Predicate predicate)` Creates a not predicate that will negate the result of the given `predicate`.
    `static Predicate` | Predicates.`or(Predicate... predicates)` Creates an or predicate that will perform the logical or operation on the given `predicates`.
    `PredicateBuilder` | PredicateBuilder.`or(Predicate predicate)`

    Constructors in com.hazelcast.query with parameters of type Predicate
    Constructor and Description
    `PagingPredicate(Predicate<K,V> predicate, Comparator<Map.Entry<K,V>> comparator, int pageSize)` Construct with an inner predicate, comparator and pageSize results will be filtered via inner predicate results will be ordered via comparator throws `IllegalArgumentException` if pageSize is not greater than 0 throws `IllegalArgumentException` if inner predicate is also `PagingPredicate`
    `PagingPredicate(Predicate predicate, int pageSize)` Construct with an inner predicate and pageSize results will be filtered via inner predicate results will be natural ordered throws `IllegalArgumentException` if pageSize is not greater than 0 throws `IllegalArgumentException` if inner predicate is also `PagingPredicate`
    `PartitionPredicate(Object partitionKey, Predicate<K,V> target)` Creates a new PartitionPredicate.

Copyright © 2019. All rights reserved.