Class NumberMultiplier<K, V>

NumberMultiplier entry processor.

Type Parameters

K = any

the type of the Map entry key
V = any

the type of the Map entry value

Hierarchy

PropertyProcessor<K, V, number>
- NumberMultiplier

Index

Constructors

Properties

@class manipulator multiplier postMultiplication

Methods

andThen returnNewValue returnOldValue when

Constructors

constructor

new NumberMultiplier<K, V>(nameOrManipulator: string | ValueManipulator, multiplier: number, postMultiplication?: boolean): NumberMultiplier<K, V>
Construct an NumberMultiplier 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
- V = any
Parameters
- nameOrManipulator: string | ValueManipulator
  
  the ValueManipulator or the property name
- multiplier: number
  
  the Number representing the magnitude and sign of the multiplier
- postMultiplication: 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>

Overrides PropertyProcessor<K, V, number>.constructor

Properties

@class

@class: string

`Protected` `Readonly` manipulator

manipulator: ValueManipulator

The property value manipulator.

`Protected` multiplier

multiplier: number

The number to multiply by.

`Protected` postMultiplication

postMultiplication: boolean

Whether to return the value before it was multiplied (post-factor) or after it is multiplied (pre-factor).

Methods

andThen

andThen(processor: EntryProcessor<K, V, any>): CompositeProcessor<K, V>
Returns a CompositeProcessor comprised of this and the provided processor.

Returns
a CompositeProcessor comprised of this and the provided processor
Parameters
- processor: EntryProcessor<K, V, any>
  
  the next processor
Returns CompositeProcessor<K, V>

Inherited from PropertyProcessor.andThen

returnNewValue

returnNewValue(): NumberMultiplier<K, V>
Configure the processor to return the value of the property after being incremented.

Returns NumberMultiplier<K, V>

returnOldValue

returnOldValue(): NumberMultiplier<K, V>
Configure the processor to return the value of the property before being multiplied.

Returns NumberMultiplier<K, V>

when

when(filter: Filter): EntryProcessor<K, V, number>
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
- filter: Filter
  
  the filter
Returns EntryProcessor<K, V, number>

Inherited from PropertyProcessor.when