Used to manage objects cache in Jobs/Steps. The execution context contains information on the current Job/Step being executed. More...
Public Member Functions | |
| void | PutInContext (object key, object record) |
| Store an object inside the cache More... | |
| bool | ContainsKey (object key) |
| Check if the given key is used in the cache More... | |
| object | GetFromContext (object key) |
| Retrieves an object from the cache More... | |
| void | Empty () |
| CLear the cache. More... | |
| string | Dump () |
| Duimps the cache content More... | |
| void | SetCounter (string counter, long value) |
| Sets the value of the given counter More... | |
| long | GetCounter (string counter) |
| Returns the value of the given counter (0 if not found) More... | |
| void | IncrementCounter (string counter) |
| Increment the value of the given counter More... | |
| void | DecrementCounter (string counter) |
| Decrement the valeu of the given counter More... | |
Properties | |
| ExecutionContext | Context [get, set] |
| cache More... | |
 Properties inherited from Summer.Batch.Extra.IContextManager | |
| ExecutionContext | Context [get, set] |
| Accessors for the context More... | |
Detailed Description
Used to manage objects cache in Jobs/Steps. The execution context contains information on the current Job/Step being executed.
Member Function Documentation
| bool Summer.Batch.Extra.ContextManager.ContainsKey | ( | object | key | ) |
Check if the given key is used in the cache
- Parameters
-
key key of the object to retrieve
- Returns
- whether the key is used in the cache or not
Implements Summer.Batch.Extra.IContextManager.
| void Summer.Batch.Extra.ContextManager.DecrementCounter | ( | string | counter | ) |
Decrement the valeu of the given counter
- Parameters
-
counter
Implements Summer.Batch.Extra.IContextManager.
| string Summer.Batch.Extra.ContextManager.Dump | ( | ) |
| void Summer.Batch.Extra.ContextManager.Empty | ( | ) |
CLear the cache.
Implements Summer.Batch.Extra.IContextManager.
| long Summer.Batch.Extra.ContextManager.GetCounter | ( | string | counter | ) |
Returns the value of the given counter (0 if not found)
- Parameters
-
counter
- Returns
Implements Summer.Batch.Extra.IContextManager.
| object Summer.Batch.Extra.ContextManager.GetFromContext | ( | object | key | ) |
Retrieves an object from the cache
- Parameters
-
key key of the object to retrieve
- Returns
- the object
Implements Summer.Batch.Extra.IContextManager.
| void Summer.Batch.Extra.ContextManager.IncrementCounter | ( | string | counter | ) |
Increment the value of the given counter
- Parameters
-
counter
Implements Summer.Batch.Extra.IContextManager.
| void Summer.Batch.Extra.ContextManager.PutInContext | ( | object | key, |
| object | record | ||
| ) |
Store an object inside the cache
- Parameters
-
key object key to store (should normally be a string) record object to store
Implements Summer.Batch.Extra.IContextManager.
| void Summer.Batch.Extra.ContextManager.SetCounter | ( | string | counter, |
| long | value | ||
| ) |
Sets the value of the given counter
- Parameters
-
counter value
Implements Summer.Batch.Extra.IContextManager.
Property Documentation
|
getset |
cache
The documentation for this class was generated from the following file:
- Summer.Batch.Extra/ContextManager.cs