ConditionalRemove is an EntryProcessor that performs an remove operation if the specified condition is satisfied.

While the ConditionalRemove processing could be implemented via direct key-based NamedMap operations, it is more efficient and enforces concurrency control without explicit locking.

Type Parameters

  • K = any

  • V = any

Hierarchy

Constructors

Properties

Methods

Constructors

  • Construct a ConditionalRemove processor that removes an NamedMap entry if and only if the filter applied to the entry evaluates to true. The result of the invocation does not return any result.

    Type Parameters

    • K = any

    • V = any

    Parameters

    • filter: Filter

      the filter to evaluate an entry

    • Optional returnValue: boolean

      specifies whether or not the processor should return the current value if it has not been removed

    Returns ConditionalRemove<K, V>

Properties

@class: string
filter: Filter

The underlying filter.

return: boolean = true

Specifies whether or not a return value is required.

Methods

  • If called, it will cause the processor to return the current value in case it has not been updated.

    Parameters

    • returnCurrent: boolean = true

      specifies whether or not the processor should return the current value in case it has not been updated

    Returns ConditionalRemove<K, V>

  • Returns a ConditionalProcessor comprised of this processor and the provided filter.

    The specified entry processor gets invoked if and only if the filter applied to the entry evaluates to true; otherwise the result of the invocation will return null.

    Parameters

    Returns EntryProcessor<K, V, V>