VMware Tanzu GemFire .NET Client API Reference
|
VMware Tanzu GemFire .NET Client
|
|
Provides a collection of properties, each of which is a key/value pair. Each key is a string, and the value may be a string or an integer. More...
Public Member Functions | |
| TPropValue | Find (TPropKey key) |
| Return the value for the given key, or NULL if not found. More... | |
| void | Insert (TPropKey key, TPropValue value) |
| Add or update the string value for key. More... | |
| void | Remove (TPropKey key) |
| Remove the key from the collection. More... | |
| void | ForEach (PropertyVisitorGeneric< TPropKey, TPropValue > visitor) |
| Execute the Visitor delegate for each entry in the collection. More... | |
| void | AddAll (IProperties< TPropKey, TPropValue > other) |
Adds the contents of other to this instance, replacing any existing values with those from other. More... | |
| void | Load (string fileName) |
| Reads values from a file, overriding what is currently in the properties object. More... | |
| void | ToData (IDataOutput output) |
| Serializes this Properties object. More... | |
| void | FromData (IDataInput input) |
| Deserializes this Properties object. More... | |
Properties | |
| uint | Size [get] |
| Return the number of entries in the collection. More... | |
| int | ObjectSize [get] |
| return the size of this object in bytes More... | |
| byte | DsCode [get] |
| Getter method for DsCode of this object More... | |
Detailed Description
Provides a collection of properties, each of which is a key/value pair. Each key is a string, and the value may be a string or an integer.
Member Function Documentation
◆ AddAll()
| void IProperties< TPropKey, TPropValue >.AddAll | ( | IProperties< TPropKey, TPropValue > | other | ) |
Adds the contents of other to this instance, replacing any existing values with those from other.
- Parameters
-
other new set of properties
◆ Find()
| TPropValue IProperties< TPropKey, TPropValue >.Find | ( | TPropKey | key | ) |
Return the value for the given key, or NULL if not found.
- Parameters
-
key the key to find
- Returns
- the value for the key
- Exceptions
-
System.Collections.Generic.KeyNotFoundException if the key is not present
◆ ForEach()
| void IProperties< TPropKey, TPropValue >.ForEach | ( | PropertyVisitorGeneric< TPropKey, TPropValue > | visitor | ) |
Execute the Visitor delegate for each entry in the collection.
- Parameters
-
visitor visitor delegate
◆ FromData()
| void IProperties< TPropKey, TPropValue >.FromData | ( | IDataInput | input | ) |
Deserializes this Properties object.
- Parameters
-
input the DataInput stream to use for reading data
- Returns
- the deserialized Properties object
◆ Insert()
| void IProperties< TPropKey, TPropValue >.Insert | ( | TPropKey | key, |
| TPropValue | value | ||
| ) |
Add or update the string value for key.
- Parameters
-
key the key to insert value the string value to insert
◆ Load()
| void IProperties< TPropKey, TPropValue >.Load | ( | string | fileName | ) |
Reads values from a file, overriding what is currently in the properties object.
- Parameters
-
fileName the name of the file
- Exceptions
-
System.ArgumentNullException filename is null System.IO.FileNotFoundException filename is does not exist
◆ Remove()
| void IProperties< TPropKey, TPropValue >.Remove | ( | TPropKey | key | ) |
Remove the key from the collection.
- Parameters
-
key the key to remove
◆ ToData()
| void IProperties< TPropKey, TPropValue >.ToData | ( | IDataOutput | output | ) |
Serializes this Properties object.
- Parameters
-
output the DataOutput stream to use for serialization
Property Documentation
◆ DsCode
|
get |
Getter method for DsCode of this object
◆ ObjectSize
|
get |
return the size of this object in bytes
◆ Size
|
get |
Return the number of entries in the collection.
- Returns
- the number of entries
The documentation for this interface was generated from the following file:
- gemfire.client/Interfaces/IProperties.cs
- Generated by
1.8.17