## Uses of Interface
com.hazelcast.core.ICompletableFuture

- Packages that use ICompletableFuture
  Package | Description
  --- | ---
  com.hazelcast.cache | This package contains the public API extension for Hazelcast JCache, the Hazelcast implementation of the JSR-107 commonly referred to as JCache.
  com.hazelcast.cardinality | This package contains Cardinality Estimator functionality for Hazelcast.
  com.hazelcast.client.proxy | This package contains client side proxy implementations of the different Hazelcast data structures and operation types
  com.hazelcast.client.util | This package contains some utility classes and the base implementations of the loadbalancer implementations
  com.hazelcast.core | Provides core API interfaces/classes.
  com.hazelcast.durableexecutor | This package contains DurableExecutorService functionality for Hazelcast. The DurableExecutorService extends the `ExecutorService` and provides additional methods like executing tasks on a member who is owner of a specific key.
  com.hazelcast.mapreduce | This package contains the MapReduce API definition for Hazelcast. All map reduce operations running in a distributed manner inside the active Hazelcast cluster.
  com.hazelcast.ringbuffer | Contains the API for the `Ringbuffer`.
  com.hazelcast.spi | Provides interfaces/classes for the Hazelcast SPI for building distributed data structures and services.
  com.hazelcast.spi.impl |
  com.hazelcast.util.executor | This package contains classes related to Util.Executor

- - ### Uses of ICompletableFuture in com.hazelcast.cache

    Methods in com.hazelcast.cache that return ICompletableFuture
    Modifier and Type | Method and Description
    --- | ---
    `ICompletableFuture<V>` | ICache.`getAndPutAsync(K key, V value)` Asynchronously associates the specified value with the specified key in this cache, returning an existing value if one existed.
    `ICompletableFuture<V>` | ICache.`getAndPutAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously associates the specified value with the specified key in this cache, returning an existing value if one existed using a custom `ExpiryPolicy`.
    `ICompletableFuture<V>` | ICache.`getAndRemoveAsync(K key)` Asynchronously removes the entry for a key and returns the previously assigned value or null if no value was assigned.
    `ICompletableFuture<V>` | ICache.`getAndReplaceAsync(K key, V value)` Asynchronously replaces the assigned value of the given key by the specified value and returns the previously assigned value.
    `ICompletableFuture<V>` | ICache.`getAndReplaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously replaces the assigned value of the given key by the specified value using a custom `ExpiryPolicy` and returns the previously assigned value.
    `ICompletableFuture<V>` | ICache.`getAsync(K key)` Asynchronously retrieves the mapped value of the given key using a custom `ExpiryPolicy`.
    `ICompletableFuture<V>` | ICache.`getAsync(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously gets an entry from cache using a custom `ExpiryPolicy`.
    `ICompletableFuture<Void>` | ICache.`putAsync(K key, V value)` Asynchronously associates the specified value with the specified key in the cache.
    `ICompletableFuture<Void>` | ICache.`putAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously associates the specified value with the specified key in the cache using a custom `ExpiryPolicy`.
    `ICompletableFuture<Boolean>` | ICache.`putIfAbsentAsync(K key, V value)` Asynchronously associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key.
    `ICompletableFuture<Boolean>` | ICache.`putIfAbsentAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key.
    `ICompletableFuture<Boolean>` | ICache.`removeAsync(K key)` Asynchronously removes the mapping for a key from this cache if it is present.
    `ICompletableFuture<Boolean>` | ICache.`removeAsync(K key, V oldValue)` Asynchronously removes the mapping for the given key if and only if the currently mapped value equals to the value of `oldValue`.
    `ICompletableFuture<Boolean>` | ICache.`replaceAsync(K key, V value)` Asynchronously replaces the assigned value of the given key by the specified value.
    `ICompletableFuture<Boolean>` | ICache.`replaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously replaces the assigned value of the given key by the specified value using a custom `ExpiryPolicy`.
    `ICompletableFuture<Boolean>` | ICache.`replaceAsync(K key, V oldValue, V newValue)` Asynchronously replaces the currently assigned value for the given key with the specified `newValue` if and only if the currently assigned value equals the value of `oldValue`.
    `ICompletableFuture<Boolean>` | ICache.`replaceAsync(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously replaces the currently assigned value for the given key with the specified `newValue` if and only if the currently assigned value equals the value of `oldValue` using a custom `ExpiryPolicy`.

  - ### Uses of ICompletableFuture in com.hazelcast.cardinality

    Methods in com.hazelcast.cardinality that return ICompletableFuture
    Modifier and Type | Method and Description
    --- | ---
    `ICompletableFuture<Void>` | CardinalityEstimator.`addAsync(Object obj)` Add a new object in the estimation set.
    `ICompletableFuture<Long>` | CardinalityEstimator.`estimateAsync()` Estimates the cardinality of the aggregation so far.

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

    Classes in com.hazelcast.client.proxy that implement ICompletableFuture
    Modifier and Type | Class and Description
    --- | ---
    `class` | `IExecutorDelegatingFuture<V>` An Abstract DelegatingFuture that can cancel a Runnable/Callable that is executed by an `IExecutorService`.

    Methods in com.hazelcast.client.proxy that return ICompletableFuture
    Modifier and Type | Method and Description
    --- | ---
    `ICompletableFuture<Long>` | ClientRingbufferProxy.`addAllAsync(Collection<? extends E> collection, OverflowPolicy overflowPolicy)`
    `ICompletableFuture<Long>` | ClientRingbufferProxy.`addAsync(E item, OverflowPolicy overflowPolicy)`
    `ICompletableFuture<V>` | ClientMapProxy.`getAsync(K key)`
    `ICompletableFuture<V>` | NearCachedClientMapProxy.`getAsyncInternal(Object keyParameter)`
    `protected ICompletableFuture<V>` | ClientMapProxy.`getAsyncInternal(Object key)`
    `ICompletableFuture<V>` | ClientMapProxy.`putAsync(K key, V value)`
    `ICompletableFuture<V>` | ClientMapProxy.`putAsync(K key, V value, long ttl, TimeUnit timeunit)`
    `protected ICompletableFuture<V>` | NearCachedClientMapProxy.`putAsyncInternal(long ttl, TimeUnit timeunit, Object key, Object value)`
    `protected ICompletableFuture<V>` | ClientMapProxy.`putAsyncInternal(long ttl, TimeUnit timeunit, Object key, Object value)`
    `<T> ICompletableFuture<ReadResultSet<T>>` | ClientMapProxy.`readFromEventJournal(long startSequence, int minSize, int maxSize, int partitionId, Predicate<? super EventJournalMapEvent<K,V>> predicate, Projection<? super EventJournalMapEvent<K,V>,? extends T> projection)`
    `ICompletableFuture<ReadResultSet<E>>` | ClientRingbufferProxy.`readManyAsync(long startSequence, int minCount, int maxCount, IFunction<E,Boolean> filter)`
    `ICompletableFuture<V>` | ClientMapProxy.`removeAsync(K key)`
    `protected ICompletableFuture<V>` | NearCachedClientMapProxy.`removeAsyncInternal(Object key)`
    `protected ICompletableFuture<V>` | ClientMapProxy.`removeAsyncInternal(Object key)`
    `ICompletableFuture<Void>` | ClientMapProxy.`setAsync(K key, V value)`
    `ICompletableFuture<Void>` | ClientMapProxy.`setAsync(K key, V value, long ttl, TimeUnit timeunit)`
    `protected ICompletableFuture<Void>` | NearCachedClientMapProxy.`setAsyncInternal(long ttl, TimeUnit timeunit, Object key, Object value)`
    `protected ICompletableFuture<Void>` | ClientMapProxy.`setAsyncInternal(long ttl, TimeUnit timeunit, Object key, Object value)`
    `ICompletableFuture` | ClientMapProxy.`submitToKey(K key, EntryProcessor entryProcessor)`
    `ICompletableFuture` | NearCachedClientMapProxy.`submitToKeyInternal(Object key, EntryProcessor entryProcessor)`
    `ICompletableFuture` | ClientMapProxy.`submitToKeyInternal(Object key, EntryProcessor entryProcessor)`
    `ICompletableFuture<com.hazelcast.internal.journal.EventJournalInitialSubscriberState>` | ClientMapProxy.`subscribeToEventJournal(int partitionId)`

  - ### Uses of ICompletableFuture in com.hazelcast.client.util

    Classes in com.hazelcast.client.util that implement ICompletableFuture
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ClientDelegatingFuture<V>` The Client Delegating Future is used to delegate `ClientInvocationFuture` to a user type to be used with `andThen()` or `get()`.

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

    Methods in com.hazelcast.core that return ICompletableFuture
    Modifier and Type | Method and Description
    --- | ---
    `ICompletableFuture<Long>` | IAtomicLong.`addAndGetAsync(long delta)` Atomically adds the given value to the current value.
    `ICompletableFuture<E>` | IAtomicReference.`alterAndGetAsync(IFunction<E,E> function)` Alters the currently stored reference by applying a function on it and gets the result.
    `ICompletableFuture<Long>` | IAtomicLong.`alterAndGetAsync(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it and gets the result.
    `ICompletableFuture<Void>` | IAtomicReference.`alterAsync(IFunction<E,E> function)` Alters the currently stored reference by applying a function on it.
    `ICompletableFuture<Void>` | IAtomicLong.`alterAsync(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it.
    `<R> ICompletableFuture<R>` | IAtomicReference.`applyAsync(IFunction<E,R> function)` Applies a function on the value, the actual stored value will not change.
    `<R> ICompletableFuture<R>` | IAtomicLong.`applyAsync(IFunction<Long,R> function)` Applies a function on the value, the actual stored value will not change.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncAddAndGet(long delta)` Deprecated. Atomically adds the given value to the current value.
    `ICompletableFuture<Void>` | AsyncAtomicReference.`asyncAlter(IFunction<E,E> function)` Deprecated. Alters the currently stored reference by applying a function on it.
    `ICompletableFuture<Void>` | AsyncAtomicLong.`asyncAlter(IFunction<Long,Long> function)` Deprecated. Alters the currently stored value by applying a function on it.
    `ICompletableFuture<E>` | AsyncAtomicReference.`asyncAlterAndGet(IFunction<E,E> function)` Deprecated. Alters the currently stored reference by applying a function on it and gets the result.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncAlterAndGet(IFunction<Long,Long> function)` Deprecated. Alters the currently stored value by applying a function on it and gets the result.
    `<R> ICompletableFuture<R>` | AsyncAtomicReference.`asyncApply(IFunction<E,R> function)` Deprecated. Applies a function on the value, the actual stored value will not change.
    `<R> ICompletableFuture<R>` | AsyncAtomicLong.`asyncApply(IFunction<Long,R> function)` Deprecated. Applies a function on the value, the actual stored value will not change.
    `ICompletableFuture<Void>` | AsyncAtomicReference.`asyncClear()` Deprecated. Clears the current stored reference.
    `ICompletableFuture<Boolean>` | AsyncAtomicReference.`asyncCompareAndSet(E expect, E update)` Deprecated. Atomically sets the value to the given updated value only if the current value `==` the expected value.
    `ICompletableFuture<Boolean>` | AsyncAtomicLong.`asyncCompareAndSet(long expect, long update)` Deprecated. Atomically sets the value to the given updated value only if the current value `==` the expected value.
    `ICompletableFuture<Boolean>` | AsyncAtomicReference.`asyncContains(E value)` Deprecated. Checks if the reference contains the value.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncDecrementAndGet()` Deprecated. Atomically decrements the current value by one.
    `ICompletableFuture<E>` | AsyncAtomicReference.`asyncGet()` Deprecated. Gets the current value.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncGet()` Deprecated. Gets the current value.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncGetAndAdd(long delta)` Deprecated. Atomically adds the given value to the current value.
    `ICompletableFuture<E>` | AsyncAtomicReference.`asyncGetAndAlter(IFunction<E,E> function)` Deprecated. Alters the currently stored reference by applying a function on it on and gets the old value.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncGetAndAlter(IFunction<Long,Long> function)` Deprecated. Alters the currently stored value by applying a function on it on and gets the old value.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncGetAndIncrement()` Deprecated. Atomically increments the current value by one.
    `ICompletableFuture<E>` | AsyncAtomicReference.`asyncGetAndSet(E newValue)` Deprecated. Gets the value and sets the new value.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncGetAndSet(long newValue)` Deprecated. Atomically sets the given value and returns the old value.
    `ICompletableFuture<Long>` | AsyncAtomicLong.`asyncIncrementAndGet()` Deprecated. Atomically increments the current value by one.
    `ICompletableFuture<Boolean>` | AsyncAtomicReference.`asyncIsNull()` Deprecated. Checks if the stored reference is null.
    `ICompletableFuture<Void>` | AsyncAtomicReference.`asyncSet(E newValue)` Deprecated. Atomically sets the given value.
    `ICompletableFuture<Void>` | AsyncAtomicLong.`asyncSet(long newValue)` Deprecated. Atomically sets the given value.
    `ICompletableFuture<E>` | AsyncAtomicReference.`asyncSetAndGet(E update)` Deprecated. will be removed from Hazelcast 3.4 since it doesn't really serve a purpose.
    `ICompletableFuture<Void>` | IAtomicReference.`clearAsync()` Clears the current stored reference.
    `ICompletableFuture<Boolean>` | IAtomicReference.`compareAndSetAsync(E expect, E update)` Atomically sets the value to the given updated value only if the current value `==` the expected value.
    `ICompletableFuture<Boolean>` | IAtomicLong.`compareAndSetAsync(long expect, long update)` Atomically sets the value to the given updated value only if the current value `==` the expected value.
    `ICompletableFuture<Boolean>` | IAtomicReference.`containsAsync(E expected)` Checks if the reference contains the value.
    `ICompletableFuture<Long>` | IAtomicLong.`decrementAndGetAsync()` Atomically decrements the current value by one.
    `ICompletableFuture<Long>` | IAtomicLong.`getAndAddAsync(long delta)` Atomically adds the given value to the current value.
    `ICompletableFuture<E>` | IAtomicReference.`getAndAlterAsync(IFunction<E,E> function)` Alters the currently stored reference by applying a function on it on and gets the old value.
    `ICompletableFuture<Long>` | IAtomicLong.`getAndAlterAsync(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it on and gets the old value.
    `ICompletableFuture<Long>` | IAtomicLong.`getAndIncrementAsync()` Atomically increments the current value by one.
    `ICompletableFuture<E>` | IAtomicReference.`getAndSetAsync(E newValue)` Gets the value and sets the new value.
    `ICompletableFuture<Long>` | IAtomicLong.`getAndSetAsync(long newValue)` Atomically sets the given value and returns the old value.
    `ICompletableFuture<E>` | IAtomicReference.`getAsync()` Gets the current value.
    `ICompletableFuture<Long>` | IAtomicLong.`getAsync()` Gets the current value.
    `ICompletableFuture<V>` | IMap.`getAsync(K key)` Asynchronously gets the given key.
    `ICompletableFuture<Long>` | IAtomicLong.`incrementAndGetAsync()` Atomically increments the current value by one.
    `ICompletableFuture<Boolean>` | IAtomicReference.`isNullAsync()` Checks if the stored reference is null.
    `ICompletableFuture<V>` | IMap.`putAsync(K key, V value)` Asynchronously puts the given key and value.
    `ICompletableFuture<V>` | IMap.`putAsync(K key, V value, long ttl, TimeUnit timeunit)` Asynchronously puts the given key and value into this map with a given TTL (time to live) value.
    `ICompletableFuture<V>` | IMap.`removeAsync(K key)` Asynchronously removes the given key, returning an `ICompletableFuture` on which the caller can provide an `ExecutionCallback` to be invoked upon remove operation completion or block waiting for the operation to complete with `Future.get()`.
    `ICompletableFuture<Void>` | IAtomicReference.`setAsync(E newValue)` Atomically sets the given value.
    `ICompletableFuture<Void>` | IMap.`setAsync(K key, V value)` Asynchronously puts the given key and value.
    `ICompletableFuture<Void>` | IMap.`setAsync(K key, V value, long ttl, TimeUnit timeunit)` Asynchronously puts an entry into this map with a given TTL (time to live) value, without returning the old value (which is more efficient than `put()`).
    `ICompletableFuture<Void>` | IAtomicLong.`setAsync(long newValue)` Atomically sets the given value.
    `ICompletableFuture` | IMap.`submitToKey(K key, EntryProcessor entryProcessor)` Applies the user defined `EntryProcessor` to the entry mapped by the `key`.

  - ### Uses of ICompletableFuture in com.hazelcast.durableexecutor

    Subinterfaces of ICompletableFuture in com.hazelcast.durableexecutor
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `DurableExecutorServiceFuture<V>` A Future where one can obtain the task ID for tracking the response.

  - ### Uses of ICompletableFuture in com.hazelcast.mapreduce

    Subinterfaces of ICompletableFuture in com.hazelcast.mapreduce
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `JobCompletableFuture<V>` Deprecated. MapReduce is deprecated and will be removed in 4.0. For map aggregations, you can use `Aggregator` on IMap. For general data processing, it is superseded by Hazelcast Jet.

    Methods in com.hazelcast.mapreduce that return ICompletableFuture
    Modifier and Type | Method and Description
    --- | ---
    `ICompletableFuture<V>` | TrackableJob.`getCompletableFuture()` Deprecated. Returns the `ICompletableFuture` to add callbacks or wait for the resulting value of the tracked job.

  - ### Uses of ICompletableFuture in com.hazelcast.ringbuffer

    Methods in com.hazelcast.ringbuffer that return ICompletableFuture
    Modifier and Type | Method and Description
    --- | ---
    `ICompletableFuture<Long>` | Ringbuffer.`addAllAsync(Collection<? extends E> collection, OverflowPolicy overflowPolicy)` Adds all the items of a collection to the tail of the Ringbuffer.
    `ICompletableFuture<Long>` | Ringbuffer.`addAsync(E item, OverflowPolicy overflowPolicy)` Asynchronously writes an item with a configurable `OverflowPolicy`.
    `ICompletableFuture<ReadResultSet<E>>` | Ringbuffer.`readManyAsync(long startSequence, int minCount, int maxCount, IFunction<E,Boolean> filter)` Reads a batch of items from the Ringbuffer.

  - ### Uses of ICompletableFuture in com.hazelcast.spi

    Subinterfaces of ICompletableFuture in com.hazelcast.spi
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `InternalCompletableFuture<E>` A `ICompletableFuture` with more functionality like getting the result without needing to deal with checked exceptions.

    Methods in com.hazelcast.spi that return ICompletableFuture
    Modifier and Type | Method and Description
    --- | ---
    `<V> ICompletableFuture<V>` | ExecutionService.`asCompletableFuture(Future<V> future)`

  - ### Uses of ICompletableFuture in com.hazelcast.spi.impl

    Classes in com.hazelcast.spi.impl with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw ICompletableFuture
    Modifier and Type | Class and Description
    --- | ---
    `class` | `com.hazelcast.spi.impl.AbstractCompletableFuture<V>` A base `ICompletableFuture` implementation that may be explicitly completed by setting its value through setResult.

  - ### Uses of ICompletableFuture in com.hazelcast.util.executor

    Classes in com.hazelcast.util.executor that implement ICompletableFuture
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CompletableFutureTask<V>`
    `class` | `CompletedFuture<V>`
    `class` | `DelegatingFuture<V>` A `InternalCompletableFuture` implementation that delegates the real logic to an underlying `InternalCompletableFuture` and decorates it with additional behavior: change the returned value by setting the result always deserializing the content caching the deserialized content so that a deserialization only happens once.

    Methods in com.hazelcast.util.executor that return ICompletableFuture
    Modifier and Type | Method and Description
    --- | ---
    `protected ICompletableFuture` | DelegatingFuture.`getFuture()`

Copyright © 2018. All rights reserved.