Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConditionalRemove<K, V>

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

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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.

    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

Properties

@class

@class: string

Protected Readonly filter

filter: Filter

The underlying filter.

Protected return

return: boolean = true

Specifies whether or not a return value is required.

Methods

andThen

returnCurrent

  • returnCurrent(returnCurrent?: boolean): this

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

    Parameters

    • Default value returnCurrent: boolean = true

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

    Returns this

when

  • 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>