SAP ABAP Class CL_CLB_DICTIONARY (SAIL: Dictionary helper)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-STW (Application Component) Social Media ABAP Integration Library
⤷
S_CLB_PROCESS (Package) Process Layer of the Collaboration Platform Library
⤷
⤷
Properties
| Class | CL_CLB_DICTIONARY | |
| Short Description | SAIL: Dictionary helper | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_CLB_PROCESS | Process Layer of the Collaboration Platform Library |
| Created | 20110811 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_CLB_DICTIONARY has no forward declaration.
Interfaces
Class CL_CLB_DICTIONARY has no interface implemented.
Friends
Class CL_CLB_DICTIONARY has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Protected | See coding | 20110811 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add an entry to the dictionary | 20110811 | |
| 2 | Instance method | Public | Method | Clear the dictionary | 20110811 | |
| 3 | Instance method | Public | Method | Get the number of entries | 20110811 | |
| 4 | Instance method | Public | Method | Find an entry in the dictionary | 20110811 | |
| 5 | Instance method | Protected | Method | Determine how to add an anonymous value | 20110811 | |
| 6 | Instance method | Public | Method | Look for a key | 20110811 | |
| 7 | Instance method | Public | Method | Remove an entry from the dictionary | 20110811 | |
| 8 | Instance method | Protected | Method | Add an elementary data to the internal table | 20110811 | |
| 9 | Instance method | Protected | Method | Add a ref to data to the internal table | 20110811 | |
| 10 | Instance method | Protected | Method | Add a ref to object to the internal table | 20110811 |
Events
Class CL_CLB_DICTIONARY has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_INSTANCE_CACHE | Protected | See coding | 20110811 | BEGIN OF ty_instance_cache.
TYPES _key TYPE string.
TYPES kind TYPE abap_typekind.
TYPES _object TYPE REF TO object.
TYPES _data TYPE REF TO data.
TYPES _elem TYPE REF TO data.
TYPES END OF ty_instance_cache
|
Method Signatures
Method ADD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_KEY | Call by reference | Type reference (TYPE) | STRING | 20110811 | ||||
| 2 | I_VALUE | Call by reference | Type reference (TYPE) | ANY | 20110811 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | SAIL: Runtime exception | 20110914 |
Method CLEAR Signature
Method CLEAR on class CL_CLB_DICTIONARY has no parameter.
Method CLEAR on class CL_CLB_DICTIONARY has no exception.
Method COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_VALUE | Value transfer | Type reference (TYPE) | INT4 | Natural number | 20110811 |
Method COUNT on class CL_CLB_DICTIONARY has no exception.
Method FIND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_NOT_FOUND | Call by reference | Type reference (TYPE) | ABAP_BOOL | True if key not found | 20110815 | |||
| 2 | E_VALUE | Value transfer | Type reference (TYPE) | ANY | 20110811 | ||||
| 3 | I_KEY | Call by reference | Type reference (TYPE) | STRING | 20110811 |
Method FIND on class CL_CLB_DICTIONARY has no exception.
Method GET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_VALUE | Call by reference | Type reference (TYPE) | ANY | 20110811 | ||||
| 2 | R_METHOD | Value transfer | Type reference (TYPE) | STRING | 20110811 |
Method GET_TYPE on class CL_CLB_DICTIONARY has no exception.
Method HAS_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_KEY | Call by reference | Type reference (TYPE) | STRING | 20110811 | ||||
| 2 | R_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | Boolean Variable (X=True, -=False, Space=Unknown) | 20110811 |
Method HAS_KEY on class CL_CLB_DICTIONARY has no exception.
Method REMOVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_KEY | Call by reference | Type reference (TYPE) | STRING | 20110906 |
Method REMOVE on class CL_CLB_DICTIONARY has no exception.
Method _ADD_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_KEY | Call by reference | Type reference (TYPE) | STRING | 20110811 | ||||
| 2 | I_VALUE | Call by reference | Type reference (TYPE) | ANY | 20110811 |
Method _ADD_DATA on class CL_CLB_DICTIONARY has no exception.
Method _ADD_REFDATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_KEY | Call by reference | Type reference (TYPE) | STRING | 20110811 | ||||
| 2 | I_VALUE | Call by reference | Object reference (TYPE REF TO) | DATA | 20110811 |
Method _ADD_REFDATA on class CL_CLB_DICTIONARY has no exception.
Method _ADD_REFOBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_KEY | Call by reference | Type reference (TYPE) | STRING | 20110811 | ||||
| 2 | I_VALUE | Call by reference | Object reference (TYPE REF TO) | OBJECT | 20110811 |
Method _ADD_REFOBJECT on class CL_CLB_DICTIONARY has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 732 |