Package org.infinispan.functional.impl

Class WriteOnlyMapImpl<K,V>

java.lang.Object

org.infinispan.functional.impl.WriteOnlyMapImpl<K,V>

All Implemented Interfaces:

AutoCloseable, FunctionalMap<K,V>, FunctionalMap.WriteOnlyMap<K,V>

@Experimental
public final class WriteOnlyMapImpl<K,V>
extends Object
implements FunctionalMap.WriteOnlyMap<K,V>

Write-only map implementation.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.functional.FunctionalMap

FunctionalMap.ReadOnlyMap<K,V>, FunctionalMap.ReadWriteMap<K,V>, FunctionalMap.WriteOnlyMap<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final FunctionalMapImpl<K,V>	fmap
protected final DataConversion	keyDataConversion
protected final Params	params
protected final DataConversion	valueDataConversion

Method Summary

Modifier and Type	Method	Description
Cache<K,V>	cache()
void	close()
static <K, V> FunctionalMap.WriteOnlyMap<K,V>	create(FunctionalMapImpl<K,V> functionalMap)
protected Map<?,?>	encodeEntries(Map<? extends K,?> entries)
protected Set<?>	encodeKeys(Set<? extends K> keys)
CompletableFuture<Void>	eval(K key, Consumer<EntryView.WriteEntryView<K,V>> f)	Evaluate a write-only Consumer operation with a EntryView.WriteEntryView of the value associated with the key, and return a CompletableFuture which will be completed with the object returned by the operation.
<T> CompletableFuture<Void>	eval(K key, T argument, BiConsumer<T,EntryView.WriteEntryView<K,V>> f)	Evaluate a write-only BiConsumer operation, with an argument passed in and a EntryView.WriteEntryView of the value associated with the key, and return a CompletableFuture which will be completed when the operation completes.
CompletableFuture<Void>	evalAll(Consumer<EntryView.WriteEntryView<K,V>> f)	Evaluate a write-only Consumer operation with the EntryView.WriteEntryView of the value associated with the key, for all existing keys in functional map, and returns a CompletableFuture that will be completed when the write-only operation has been executed against all the entries.
<T> CompletableFuture<Void>	evalMany(Map<? extends K,? extends T> arguments, BiConsumer<T,EntryView.WriteEntryView<K,V>> f)	Evaluate a write-only BiConsumer operation, with an argument passed in and a EntryView.WriteEntryView of the value associated with the key, for each of the keys in the set passed in, and returns a CompletableFuture that will be completed when the write-only operation has been executed against all the entries.
CompletableFuture<Void>	evalMany(Set<? extends K> keys, Consumer<EntryView.WriteEntryView<K,V>> f)	Evaluate a write-only Consumer operation with the EntryView.WriteEntryView of the value associated with the key, for each of the keys in the set passed in, and returns a CompletableFuture that will be completed when the write-only operation has been executed against all the entries.
protected InvocationContext	getInvocationContext(boolean isWrite, int keyCount)
String	getName()	Functional map's name.
ComponentStatus	getStatus()	Functional map's status.
protected <T> CompletableFuture<T>	invokeAsync(InvocationContext ctx, VisitableCommand cmd)
Listeners.WriteListeners<K,V>	listeners()	Allows to write-only listeners to be registered.
CompletableFuture<Void>	truncate()	Truncate the contents of the cache, returning a CompletableFuture that will be completed when the truncate process completes.
FunctionalMap.WriteOnlyMap<K,V>	withParams(Param<?>... ps)	Tweak write-only functional map executions providing Param instances.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.infinispan.functional.FunctionalMap

cache, getName, getStatus, isEncoded

Methods inherited from interface org.infinispan.functional.FunctionalMap.WriteOnlyMap

eval, eval, evalAll, evalMany, evalMany

Field Details

fmap

protected final FunctionalMapImpl<K,V> fmap

params

protected final Params params

keyDataConversion

protected final DataConversion keyDataConversion

valueDataConversion

protected final DataConversion valueDataConversion

Method Details

create

public static <K,
V> FunctionalMap.WriteOnlyMap<K,V> create(FunctionalMapImpl<K,V> functionalMap)

eval

public CompletableFuture<Void> eval(K key,
 Consumer<EntryView.WriteEntryView<K,V>> f)

Description copied from interface: FunctionalMap.WriteOnlyMap

Evaluate a write-only Consumer operation with a EntryView.WriteEntryView of the value associated with the key, and return a CompletableFuture which will be completed with the object returned by the operation.

Since this is a write-only operation, no entry attributes can be queried, hence the only reasonable thing can be returned is Void.

This operation can be used to either remove a cached entry, or to write a constant value along with optional metadata parameters.

Specified by:

eval in interface FunctionalMap.WriteOnlyMap<K,V>

Parameters:

key - the key associated with the EntryView.WriteEntryView to be passed to the operation

f - operation that takes a EntryView.WriteEntryView associated with the key and writes to the it without returning anything

Returns:

a CompletableFuture which will be completed when the operation completes

eval

public <T> CompletableFuture<Void> eval(K key,
 T argument,
 BiConsumer<T,EntryView.WriteEntryView<K,V>> f)

Description copied from interface: FunctionalMap.WriteOnlyMap

Evaluate a write-only BiConsumer operation, with an argument passed in and a EntryView.WriteEntryView of the value associated with the key, and return a CompletableFuture which will be completed when the operation completes.

Since this is a write-only operation, no entry attributes can be queried, hence the only reasonable thing can be returned is Void.

This method can be used to implement single-key write-only operations which do not need to query previous value, such as javax.cache.Cache#put(Object, Object)

This operation is very similar to FunctionalMap.WriteOnlyMap.eval(Object, Consumer) and in fact, the functionality provided by this function could indeed be implemented with FunctionalMap.WriteOnlyMap.eval(Object, Consumer), but there's a crucial difference. If you want to store a value and reference the value to be stored from the passed in operation, FunctionalMap.WriteOnlyMap.eval(Object, Consumer) needs to capture that value. Capturing means that each time the operation is called, a new lambda needs to be instantiated. By offering a BiConsumer that takes user provided value as first parameter, the operation does not capture any external objects when implementing simple operations such as javax.cache.Cache#put(Object, Object), and hence, the BiConsumer could be cached and reused each time it's invoked.

Note that when encoders are in place despite the argument type and value type don't have to match the argument will use value encoding.

Specified by:

eval in interface FunctionalMap.WriteOnlyMap<K,V>

Parameters:

key - the key associated with the EntryView.WriteEntryView to be passed to the operation

argument - argument passed in as first parameter to the BiConsumer operation.

f - operation that takes a user defined value, and a EntryView.WriteEntryView associated with the key, and writes to the EntryView.WriteEntryView passed in without returning anything

Returns:

a CompletableFuture which will be completed when the operation completes

evalMany

public <T> CompletableFuture<Void> evalMany(Map<? extends K,? extends T> arguments,
 BiConsumer<T,EntryView.WriteEntryView<K,V>> f)

Description copied from interface: FunctionalMap.WriteOnlyMap

Evaluate a write-only BiConsumer operation, with an argument passed in and a EntryView.WriteEntryView of the value associated with the key, for each of the keys in the set passed in, and returns a CompletableFuture that will be completed when the write-only operation has been executed against all the entries. This method can be used to implement operations such as:

• Map.putAll(Map)
• javax.cache.Cache#putAll(Map)

These kind of operations are preferred to traditional end user iterations because the internal logic can often iterate more efficiently since it knows more about the system.

Since this is a write-only operation, no entry attributes can be queried, hence the only reasonable thing can be returned is Void.

Note that when encoders are in place despite the argument type and value type don't have to match the argument will use value encoding.

Specified by:

evalMany in interface FunctionalMap.WriteOnlyMap<K,V>

Parameters:

arguments - the key/value pairs associated with each of the EntryView.WriteEntryView passed in the function callbacks

f - operation that consumes a value associated with a key in the entries collection and the EntryView.WriteEntryView associated with that key in the cache

Returns:

a CompletableFuture which will be completed when the BiConsumer operation has been executed against all entries

evalMany

public CompletableFuture<Void> evalMany(Set<? extends K> keys,
 Consumer<EntryView.WriteEntryView<K,V>> f)

Description copied from interface: FunctionalMap.WriteOnlyMap

Evaluate a write-only Consumer operation with the EntryView.WriteEntryView of the value associated with the key, for each of the keys in the set passed in, and returns a CompletableFuture that will be completed when the write-only operation has been executed against all the entries.

This method can be used to implement operations such as javax.cache.Cache#removeAll(Set).

These kind of operations are preferred to traditional end user iterations because the internal logic can often iterate more efficiently since it knows more about the system.

Since this is a write-only operation, no entry attributes can be queried, hence the only reasonable thing can be returned is Void.

Specified by:

evalMany in interface FunctionalMap.WriteOnlyMap<K,V>

Parameters:

keys - the keys associated with each of the EntryView.WriteEntryView passed in the function callbacks

f - operation that the EntryView.WriteEntryView associated with one of the keys passed in

Returns:

a CompletableFuture which will be completed when the Consumer operation has been executed against all entries

evalAll

public CompletableFuture<Void> evalAll(Consumer<EntryView.WriteEntryView<K,V>> f)

Description copied from interface: FunctionalMap.WriteOnlyMap

Evaluate a write-only Consumer operation with the EntryView.WriteEntryView of the value associated with the key, for all existing keys in functional map, and returns a CompletableFuture that will be completed when the write-only operation has been executed against all the entries.

This method can be used to implement operations such as javax.cache.Cache#removeAll().

Specified by:

evalAll in interface FunctionalMap.WriteOnlyMap<K,V>

Parameters:

f - operation that the EntryView.WriteEntryView associated with one of the keys passed in

Returns:

a CompletableFuture which will be completed when the Consumer operation has been executed against all entries

truncate

public CompletableFuture<Void> truncate()

Description copied from interface: FunctionalMap.WriteOnlyMap

Truncate the contents of the cache, returning a CompletableFuture that will be completed when the truncate process completes. This method can be used to implement:

• Map.clear()
• javax.cache.Cache#clear()

Specified by:

truncate in interface FunctionalMap.WriteOnlyMap<K,V>

Returns:

a CompletableFuture that completes when the truncat has finished

withParams

public FunctionalMap.WriteOnlyMap<K,V> withParams(Param<?>... ps)

Description copied from interface: FunctionalMap.WriteOnlyMap

Tweak write-only functional map executions providing Param instances.

Specified by:

withParams in interface FunctionalMap<K,V>

Specified by:

withParams in interface FunctionalMap.WriteOnlyMap<K,V>

listeners

public Listeners.WriteListeners<K,V> listeners()

Description copied from interface: FunctionalMap.WriteOnlyMap

Allows to write-only listeners to be registered.

Specified by:

listeners in interface FunctionalMap.WriteOnlyMap<K,V>

getName

public String getName()

Description copied from interface: FunctionalMap

Functional map's name.

Specified by:

getName in interface FunctionalMap<K,V>

getStatus

public ComponentStatus getStatus()

Description copied from interface: FunctionalMap

Functional map's status.

Specified by:

getStatus in interface FunctionalMap<K,V>

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

cache

public Cache<K,V> cache()

Specified by:

cache in interface FunctionalMap<K,V>

getInvocationContext

protected InvocationContext getInvocationContext(boolean isWrite,
 int keyCount)

invokeAsync

protected <T> CompletableFuture<T> invokeAsync(InvocationContext ctx,
 VisitableCommand cmd)

encodeKeys

protected Set<?> encodeKeys(Set<? extends K> keys)

encodeEntries

protected Map<?,?> encodeEntries(Map<? extends K,?> entries)