RemoveFunction (Infinispan Multimap 13.0.15.Final API)

java.lang.Object
- org.infinispan.multimap.impl.function.RemoveFunction<K,V>

All Implemented Interfaces:

Serializable, Function<org.infinispan.functional.EntryView.ReadWriteEntryView<K,Bucket<V>>,Boolean>, BaseFunction<K,V,Boolean>, org.infinispan.util.function.SerializableFunction<org.infinispan.functional.EntryView.ReadWriteEntryView<K,Bucket<V>>,Boolean>
```
public final class RemoveFunction<K,V>
extends Object
implements BaseFunction<K,V,Boolean>
```
Serializable function used by EmbeddedMultimapCache.remove(Object) and EmbeddedMultimapCache.remove(Object, Object) to remove a key or a key/value pair from the Multimap Cache, if such exists.
apply(EntryView.ReadWriteEntryView) will return Boolean.TRUE when the operation removed a key or a key/value pair and will return Boolean.FALSE if the key or key/value pair does not exist

Since:

9.2

Author:

Katia Aresti - karesti@redhat.com

See Also:

Marshalling of Functions, Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static org.infinispan.commons.marshall.AdvancedExternalizer<RemoveFunction> EXTERNALIZER

Constructor Summary

Constructors
Constructor	Description
`RemoveFunction()`	Call this constructor to create a function that removed a key
`RemoveFunction(V value)`	Call this constructor to create a function that removed a key/value pair

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

Boolean apply(org.infinispan.functional.EntryView.ReadWriteEntryView<K,Bucket<V>> entryView)
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface java.util.function.Function
  andThen, compose

- Field Detail
  - EXTERNALIZER
```
public static final org.infinispan.commons.marshall.AdvancedExternalizer<RemoveFunction> EXTERNALIZER
```
- Constructor Detail
  - RemoveFunction
```
public RemoveFunction()
```
    Call this constructor to create a function that removed a key
  - RemoveFunction
```
public RemoveFunction(V value)
```
    Call this constructor to create a function that removed a key/value pair
    
    Parameters:
    
    value - value to be removed
- Method Detail
  - apply
```
public Boolean apply(org.infinispan.functional.EntryView.ReadWriteEntryView<K,Bucket<V>> entryView)
```
    Specified by:
    
    apply in interface Function<K,V>