Class Processors

Hierarchy

Processors

Index

Constructors

Methods

conditionalPut conditionalPutAll conditionalRemove extract increment invokeAccessor invokeMutator multiply nop preload script touch update versionedPut versionedPutAll

Constructors

constructor

new Processors(): Processors
Returns Processors

Methods

`Static` conditionalPut

conditionalPut<K, V>(filter: Filter, value: V, returnValue?: boolean): ConditionalPut<K, V>
Construct a ConditionalPut that updates an entry with a new value if and only if the filter applied to the entry evaluates to true. This processor optionally returns the current value as a result of the invocation if it has not been updated (the filter evaluated to false).

Returns
a put processor that updates an entry with a new value if and only if the filter applied to the entry evaluates to true.
Type Parameters
- K = any
- V = any
  
  the type of the Map entry value
Parameters
- filter: Filter
  
  the filter to evaluate an entry
- value: V
  
  a value to update an entry with
- Optional returnValue: boolean
  
  specifies whether the processor should return the current value in case it has not been updated
Returns ConditionalPut<K, V>

`Static` conditionalPutAll

conditionalPutAll<K, V>(filter: Filter, map: Map<K, V>): ConditionalPutAll<K, V>
Construct a ConditionalPutAll that updates an entry with a new value if and only if the filter applied to the entry evaluates to true. The new value is extracted from the specified map based on the entry's key.

Returns
a ConditionalPutAll processor that updates an entry with a new value if and only if the filter applied to the entry evaluates to true.
Type Parameters
- K = any
  
  the type of the Map entry key
- V = any
  
  the type of the Map entry value
Parameters
- filter: Filter
  
  the filter to evaluate all supplied entries
- map: Map<K, V>
  
  a map of values to update entries with
Returns ConditionalPutAll<K, V>

`Static` conditionalRemove

conditionalRemove<K, V>(filter: Filter, returnValue?: boolean): ConditionalRemove<K, V>
Construct a ConditionalRemove processor that removes an InvocableMap entry if and only if the filter applied to the entry evaluates to true. This processor may optionally return the current value as a result of the invocation if it has not been removed (the filter evaluated to false).

Returns
a remove processor that removes an InvocableMap entry if and only if the filter applied to the entry evaluates to true.
Type Parameters
- K = any
- V = any
Parameters
- filter: Filter
  
  the filter to evaluate an entry
- Optional returnValue: boolean
  
  specifies whether the processor should return the current value if it has not been removed
Returns ConditionalRemove<K, V>

`Static` extract

extract<K, V, R>(extractorOrFieldName?: string): EntryProcessor<K, V, R>
Construct an extract processor based on the specified ValueExtractor.

Returns
an extract processor based on the specified extractor.

See
extractor.ExtractorProcessor
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
- R = any
  
  the type of the extracted value
Parameters
- Optional extractorOrFieldName: string
  
  a Extractor object; passing null is equivalent to using the IdentityExtractor or the property or method name to invoke to provide a value
Returns EntryProcessor<K, V, R>

`Static` increment

increment<K, V>(propertyOrManipulator: string | ValueManipulator, value: number, returnOldValue?: boolean): NumberIncrementor<K, V>
Construct an increment processor that will increment a property value by a specified amount, returning either the old or the new value as specified.

Returns
an increment processor
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
Parameters
- propertyOrManipulator: string | ValueManipulator
  
  the Manipulator or property to manipulate
- value: number
  
  the Number representing the magnitude and sign of the increment
- returnOldValue: boolean = false
  
  pass true to return the value as it was before it was incremented, or pass false to return the value as it is after it is incremented
Returns NumberIncrementor<K, V>

`Static` invokeAccessor

invokeAccessor<K, V, R>(methodName: string, ...args: any[]): EntryProcessor<K, V, R>
Construct MethodInvocationProcessor appropriate for invoking an accessor.
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
- R = any
  
  the type of the extracted value
Parameters
- methodName: string
  
  the name of the method to invoke
- Rest ...args: any[]
  
  the method arguments
Returns EntryProcessor<K, V, R>

`Static` invokeMutator

invokeMutator<K, V, R>(methodName: string, ...args: any[]): EntryProcessor<K, V, R>
Construct MethodInvocationProcessor appropriate for invoking a mutating method.
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
- R = any
  
  the type of the extracted value
Parameters
- methodName: string
  
  the name of the method to invoke
- Rest ...args: any[]
  
  the method arguments
Returns EntryProcessor<K, V, R>

`Static` multiply

multiply<K, V>(propertyOrManipulator: string, numFactor: number, returnOldValue?: boolean): NumberMultiplier<K, V>
Construct a NumberMultiplier processor that will multiply a property value by a specified factor, returning either the old or the new value as specified.

Returns
a multiply processor that will multiply a property value by a specified factor, returning either the old or the new value as specified
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
Parameters
- propertyOrManipulator: string
  
  the Manipulator or property to manipulate
- numFactor: number
  
  the Number representing the magnitude and sign of the multiplier
- returnOldValue: boolean = false
  
  pass true to return the value as it was before it was multiplied, or pass false to return the value as it is after it is multiplied
Returns NumberMultiplier<K, V>

`Static` nop

nop<K, V>(): EntryProcessor<K, V, any>
Return an EntryProcessor that does nothing and returns true as a result of execution.

Returns
an EntryProcessor that does nothing and returns true as a result of execution
Type Parameters
- K = any
  
  the type of the Map entry keys
- V = any
  
  the type of the Map entry values
Returns EntryProcessor<K, V, any>

`Static` preload

preload<K, V>(): PreloadRequest<K, V>
Construct the preload request processor.

Returns
a preload request processor
Type Parameters
- K = any
  
  the type of the Map entry key
- V = any
  
  the type of the Map entry value
Returns PreloadRequest<K, V>

`Static` script

script<K, V, R>(language: string, name: string, ...args: any[]): ScriptProcessor<K, V, R>
Return a new ScriptProcessor.

Returns
a new ScriptProcessor
Type Parameters
- K = any
  
  the type of the Map entry key
- V = any
  
  the type of the Map entry value
- R = any
Parameters
- language: string
  
  the language the script is written. Currently, only js (for JavaScript) is supported
- name: string
  
  the name of the EntryProcessor that needs to be executed
- Rest ...args: any[]
  
  the arguments to be passed to the EntryProcessor
Returns ScriptProcessor<K, V, R>

`Static` touch

touch(): TouchProcessor<any, any>
Constructs a TouchProcessor that touches an entry (if present) in order to trigger interceptor re-evaluation and possibly increment expiry time.

Returns
a new TouchProcessor

Returns TouchProcessor<any, any>

`Static` update

update<K, V, T>(propertyOrUpdater: string | ValueUpdater, value: T): UpdaterProcessor<K, V, T>
Construct an update processor for a given method name. The method must have a single parameter of a Java type compatible with the specified value type.

Returns
an update processor for a given method name
Type Parameters
- K = any
  
  the type of the Map entry key
- V = any
  
  the type of the Map entry value
- T = any
  
  the return type of the ValueUpdater
Parameters
- propertyOrUpdater: string | ValueUpdater
  
  a ValueUpdater object the property or method name to invoke to provide a value
- value: T
  
  the value to update the target entry with
Returns UpdaterProcessor<K, V, T>

`Static` versionedPut

versionedPut<K, V>(value: V, allowInsert?: boolean, returnCurrent?: boolean): VersionedPut<K, V>
Construct a VersionedPut processor that updates an entry with a new value if and only if the version of the new value matches to the version of the current entry's value. This processor optionally returns the current value as a result of the invocation if it has not been updated (the versions did not match).
Type Parameters
- K = any
  
  the type of the Map entry key
- V = any
  
  the type of the Map entry value
Parameters
- value: V
  
  a value to update an entry with
- allowInsert: boolean = false
  
  specifies whether or not an insert should be allowed (no currently existing value)
- returnCurrent: boolean = false
  
  specifies whether or not the processor should return the current value in case it has not been updated
Returns VersionedPut<K, V>

`Static` versionedPutAll

versionedPutAll<K, V>(map: Map<K, V>, allowInsert?: boolean, returnCurrent?: boolean): VersionedPutAll<K, V>
Construct a VersionedPutAll processor that updates an entry with a new value if and only if the version of the new value matches to the version of the current entry's value (which must exist). This processor optionally returns a map of entries that have not been updated (the versions did not match).

Returns
a VersionedPutAll processor
Type Parameters
- K = any
  
  the type of the Map entry key
- V = any
  
  the type of the Map entry value
Parameters
- map: Map<K, V>
  
  a map of values to update entries with
- allowInsert: boolean = false
  
  specifies whether an insert should be allowed (no currently existing value)
- returnCurrent: boolean = false
  
  specifies whether the processor should return the entries that have not been updated
Returns VersionedPutAll<K, V>

Class Processors

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Processors

Methods

Static conditionalPut

Returns

Type Parameters

K = any

V = any

Parameters

filter: Filter

value: V

Optional returnValue: boolean

Returns ConditionalPut<K, V>

Static conditionalPutAll

Returns

Type Parameters

K = any

V = any

Parameters

filter: Filter

map: Map<K, V>

Returns ConditionalPutAll<K, V>

Static conditionalRemove

Returns

Type Parameters

K = any

V = any

Parameters

filter: Filter

Optional returnValue: boolean

Returns ConditionalRemove<K, V>

Static extract

Returns

See

Type Parameters

K = any

V = any

R = any

Parameters

Optional extractorOrFieldName: string

Returns EntryProcessor<K, V, R>

Static increment

Returns

Type Parameters

K = any

V = any

Parameters

propertyOrManipulator: string | ValueManipulator

value: number

returnOldValue: boolean = false

Returns NumberIncrementor<K, V>

Static invokeAccessor

Type Parameters

K = any

V = any

R = any

Parameters

methodName: string

Rest ...args: any[]

Returns EntryProcessor<K, V, R>

Static invokeMutator

Type Parameters

K = any

V = any

R = any

Parameters

methodName: string

Rest ...args: any[]

Returns EntryProcessor<K, V, R>

Static multiply

Returns

Type Parameters

K = any

V = any

`Static` conditionalPut

`Optional` returnValue: boolean

`Static` conditionalPutAll

`Static` conditionalRemove

`Optional` returnValue: boolean

`Static` extract

`Optional` extractorOrFieldName: string

`Static` increment

`Static` invokeAccessor

`Rest` ...args: any[]

`Static` invokeMutator

`Rest` ...args: any[]

`Static` multiply

`Static` nop

`Static` preload

`Static` script

`Rest` ...args: any[]

`Static` touch

`Static` update

`Static` versionedPut

`Static` versionedPutAll