VMware Tanzu GemFire .NET Client API Reference
A IPdxWriter will be passed to IPdxSerializable.toData when it is serializing the domain class. The domain class needs to serialize member fields using this interface. More...
Inherited by PdxTypeCollector.
Public Member Functions | |
| IPdxWriter | WriteByte (string fieldName, byte value) |
Write a byte to the IPdxWriter. More... | |
| IPdxWriter | WriteBoolean (string fieldName, bool value) |
Write a bool value to the IPdxWriter. More... | |
| IPdxWriter | WriteChar (string fieldName, char value) |
Write a char value to the IPdxWriter. More... | |
| IPdxWriter | WriteShort (string fieldName, short value) |
Write a 16-bit integer to the IPdxWriter. More... | |
| IPdxWriter | WriteInt (string fieldName, int value) |
Write a 32-bit integer to the IPdxWriter. More... | |
| IPdxWriter | WriteLong (string fieldName, long value) |
Write a 64-bit integer to the IPdxWriter. More... | |
| IPdxWriter | WriteFloat (string fieldName, float value) |
Write a float to the IPdxWriter. More... | |
| IPdxWriter | WriteDouble (string fieldName, double value) |
Write a double precision real number to the IPdxWriter. More... | |
| IPdxWriter | WriteString (string fieldName, string value) |
Write a string using java-modified UTF-8 encoding to IPdxWriter. More... | |
| IPdxWriter | WriteObject (string fieldName, object obj) |
Write an object object to the IPdxWriter. More... | |
| IPdxWriter | WriteDate (string fieldName, DateTime date) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteBooleanArray (string fieldName, bool[] boolArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteCharArray (string fieldName, char[] charArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteByteArray (string fieldName, byte[] byteArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteShortArray (string fieldName, short[] shortArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteIntArray (string fieldName, int[] intArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteLongArray (string fieldName, long[] longArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteFloatArray (string fieldName, float[] floatArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteDoubleArray (string fieldName, double[] doubleArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteStringArray (string fieldName, string[] stringArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteObjectArray (string fieldName, object[] objectArray) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | WriteArrayOfByteArrays (string fieldName, byte[][] byteArrays) |
Write an collection to the IPdxWriter. More... | |
| IPdxWriter | MarkIdentityField (string fieldName) |
| Indicate that the given field name should be included in hashCode and equals checks of this object on a server that is using CacheFactory#setPdxReadSerialized(bool) or when a client executes a query on a server. More... | |
| IPdxWriter | WriteUnreadFields (IPdxUnreadFields unread) |
| To append unread data with updated data. More... | |
Detailed Description
A IPdxWriter will be passed to IPdxSerializable.toData when it is serializing the domain class. The domain class needs to serialize member fields using this interface.
Member Function Documentation
◆ MarkIdentityField()
| IPdxWriter IPdxWriter.MarkIdentityField | ( | string | fieldName | ) |
Indicate that the given field name should be included in hashCode and equals checks of this object on a server that is using CacheFactory#setPdxReadSerialized(bool) or when a client executes a query on a server.
The fields that are marked as identity fields are used to generate the hashCode and equals methods of PdxInstance. Because of this, the identity fields should themselves either be Primitives, or implement hashCode and equals.
If no fields are set as identity fields, then all fields will be used in hashCode and equals checks.
The identity fields should make marked after they are written using a write* method.
- Parameters
-
fieldName the name of the field that should be used in the as part of the identity.
- Returns
- this PdxWriter
◆ WriteArrayOfByteArrays()
| IPdxWriter IPdxWriter.WriteArrayOfByteArrays | ( | string | fieldName, |
| byte | byteArrays[][] | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. byteArrays The byteArrays to write.
◆ WriteBoolean()
| IPdxWriter IPdxWriter.WriteBoolean | ( | string | fieldName, |
| bool | value | ||
| ) |
Write a bool value to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The bool value to write.
◆ WriteBooleanArray()
| IPdxWriter IPdxWriter.WriteBooleanArray | ( | string | fieldName, |
| bool[] | boolArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. boolArray The boolArray to write.
◆ WriteByte()
| IPdxWriter IPdxWriter.WriteByte | ( | string | fieldName, |
| byte | value | ||
| ) |
Write a byte to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The byte to write.
◆ WriteByteArray()
| IPdxWriter IPdxWriter.WriteByteArray | ( | string | fieldName, |
| byte[] | byteArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. byteArray The byteArray to write.
◆ WriteChar()
| IPdxWriter IPdxWriter.WriteChar | ( | string | fieldName, |
| char | value | ||
| ) |
Write a char value to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The char value to write.
◆ WriteCharArray()
| IPdxWriter IPdxWriter.WriteCharArray | ( | string | fieldName, |
| char[] | charArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. charArray The charArray to write.
◆ WriteDate()
| IPdxWriter IPdxWriter.WriteDate | ( | string | fieldName, |
| DateTime | date | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. date The date to write.
◆ WriteDouble()
| IPdxWriter IPdxWriter.WriteDouble | ( | string | fieldName, |
| double | value | ||
| ) |
Write a double precision real number to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The double precision real number to write.
◆ WriteDoubleArray()
| IPdxWriter IPdxWriter.WriteDoubleArray | ( | string | fieldName, |
| double[] | doubleArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. doubleArray The doubleArray to write.
◆ WriteFloat()
| IPdxWriter IPdxWriter.WriteFloat | ( | string | fieldName, |
| float | value | ||
| ) |
Write a float to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The float value to write.
◆ WriteFloatArray()
| IPdxWriter IPdxWriter.WriteFloatArray | ( | string | fieldName, |
| float[] | floatArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. floatArray The floatArray to write.
◆ WriteInt()
| IPdxWriter IPdxWriter.WriteInt | ( | string | fieldName, |
| int | value | ||
| ) |
Write a 32-bit integer to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The 32-bit integer to write.
◆ WriteIntArray()
| IPdxWriter IPdxWriter.WriteIntArray | ( | string | fieldName, |
| int[] | intArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. intArray The intArray to write.
◆ WriteLong()
| IPdxWriter IPdxWriter.WriteLong | ( | string | fieldName, |
| long | value | ||
| ) |
Write a 64-bit integer to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The 64-bit integer to write.
◆ WriteLongArray()
| IPdxWriter IPdxWriter.WriteLongArray | ( | string | fieldName, |
| long[] | longArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. longArray The longArray to write.
◆ WriteObject()
| IPdxWriter IPdxWriter.WriteObject | ( | string | fieldName, |
| object | obj | ||
| ) |
Write an object object to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. obj The object to write.
◆ WriteObjectArray()
| IPdxWriter IPdxWriter.WriteObjectArray | ( | string | fieldName, |
| object[] | objectArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. objectArray The objectArray to write.
◆ WriteShort()
| IPdxWriter IPdxWriter.WriteShort | ( | string | fieldName, |
| short | value | ||
| ) |
Write a 16-bit integer to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The 16-bit integer to write.
◆ WriteShortArray()
| IPdxWriter IPdxWriter.WriteShortArray | ( | string | fieldName, |
| short[] | shortArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. shortArray The shortArray to write.
◆ WriteString()
| IPdxWriter IPdxWriter.WriteString | ( | string | fieldName, |
| string | value | ||
| ) |
Write a string using java-modified UTF-8 encoding to IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. value The UTF encoded string to write.
◆ WriteStringArray()
| IPdxWriter IPdxWriter.WriteStringArray | ( | string | fieldName, |
| string[] | stringArray | ||
| ) |
Write an collection to the IPdxWriter.
- Parameters
-
fieldName The name of the field associated with the value. stringArray The stringArray to write.
◆ WriteUnreadFields()
| IPdxWriter IPdxWriter.WriteUnreadFields | ( | IPdxUnreadFields | unread | ) |
To append unread data with updated data.
- Returns
- this PdxWriter
The documentation for this interface was generated from the following file:
- gemfire.client/Interfaces/IPdxWriter.cs

