Interface for context manager More...
Public Member Functions | |
| void | PutInContext (object key, object record) |
| Stores an object inside the cache More... | |
| bool | ContainsKey (object key) |
| Check if the key is in the cache More... | |
| object | GetFromContext (object key) |
| Retrieves an object from the cache More... | |
| void | Empty () |
| Clears the cache More... | |
| string | Dump () |
| Dumps the cache content More... | |
| void | SetCounter (string counter, long value) |
| Sets the value of a named counter More... | |
| long | GetCounter (string counter) |
| Returns the value of a named counter More... | |
| void | IncrementCounter (string counter) |
| Increments the value of a counter by one. If this counter does not yet exist, it is first created with a value of 0 (thus, the new value is 1). More... | |
| void | DecrementCounter (string counter) |
| Decrements the value of a counter by one. If this counter does not yet exist, it is first created with a value of 0 (thus, the new value is -1). More... | |
Properties | |
| ExecutionContext | Context [get, set] |
| Accessors for the context More... | |
Detailed Description
Interface for context manager
Member Function Documentation
| bool Summer.Batch.Extra.IContextManager.ContainsKey | ( | object | key | ) |
Check if the key is in the cache
- Parameters
-
key key of the object to retrieve
- Returns
- whether it is in the cache
Implemented in Summer.Batch.Extra.ContextManager.
| void Summer.Batch.Extra.IContextManager.DecrementCounter | ( | string | counter | ) |
Decrements the value of a counter by one. If this counter does not yet exist, it is first created with a value of 0 (thus, the new value is -1).
- Parameters
-
counter the name of the counter
Implemented in Summer.Batch.Extra.ContextManager.
| string Summer.Batch.Extra.IContextManager.Dump | ( | ) |
Dumps the cache content
- Returns
- the content of the cache as a string
Implemented in Summer.Batch.Extra.ContextManager.
| void Summer.Batch.Extra.IContextManager.Empty | ( | ) |
Clears the cache
Implemented in Summer.Batch.Extra.ContextManager.
| long Summer.Batch.Extra.IContextManager.GetCounter | ( | string | counter | ) |
Returns the value of a named counter
- Parameters
-
counter the name of the counter
returns>the value of the the named counter
Implemented in Summer.Batch.Extra.ContextManager.
| object Summer.Batch.Extra.IContextManager.GetFromContext | ( | object | key | ) |
Retrieves an object from the cache
- Parameters
-
key key of the object to retrieve
- Returns
- retrieved object
Implemented in Summer.Batch.Extra.ContextManager.
| void Summer.Batch.Extra.IContextManager.IncrementCounter | ( | string | counter | ) |
Increments the value of a counter by one. If this counter does not yet exist, it is first created with a value of 0 (thus, the new value is 1).
- Parameters
-
counter the name of the counter
Implemented in Summer.Batch.Extra.ContextManager.
| void Summer.Batch.Extra.IContextManager.PutInContext | ( | object | key, |
| object | record | ||
| ) |
Stores an object inside the cache
- Parameters
-
key object key to store record object to store
Implemented in Summer.Batch.Extra.ContextManager.
| void Summer.Batch.Extra.IContextManager.SetCounter | ( | string | counter, |
| long | value | ||
| ) |
Sets the value of a named counter
- Parameters
-
counter the name of the counter value the new value of the the named counter
Implemented in Summer.Batch.Extra.ContextManager.
Property Documentation
|
getset |
Accessors for the context
The documentation for this interface was generated from the following file:
- Summer.Batch.Extra/IContextManager.cs