Apache Geode Native .NET Reference  1.14.0
Apache::Geode::Client::IPdxWriter Interface Reference

A IPdxWriter will be passed to IPdxSerializable.toData when it is serializing the domain class. More...

Public Member Functions

IPdxWriterMarkIdentityField (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(boolean) or when a client executes a query on a server. More...
 
IPdxWriterWriteArrayOfByteArrays (String^ fieldName, array< array< Byte >^>^ byteArrays)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteBoolean (String^ fieldName, Boolean value)
 Write a boolean value to the IPdxWriter. More...
 
IPdxWriterWriteBooleanArray (String^ fieldName, array< bool >^ boolArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteByte (String^ fieldName, SByte value)
 Write a byte to the IPdxWriter. More...
 
IPdxWriterWriteByteArray (String^ fieldName, array< Byte >^ byteArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteChar (String^ fieldName, Char value)
 Write a char value to the IPdxWriter. More...
 
IPdxWriterWriteCharArray (String^ fieldName, array< Char >^ charArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteDate (String^ fieldName, System::DateTime date)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteDouble (String^ fieldName, double value)
 Write a double precision real number to the IPdxWriter. More...
 
IPdxWriterWriteDoubleArray (String^ fieldName, array< double >^ doubleArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteField (String^ fieldName, Object^ fieldValue, Type^ type)
 
IPdxWriterWriteFloat (String^ fieldName, float value)
 Write a float to the IPdxWriter. More...
 
IPdxWriterWriteFloatArray (String^ fieldName, array< float >^ floatArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteInt (String^ fieldName, Int32 value)
 Write a 32-bit integer to the IPdxWriter. More...
 
IPdxWriterWriteIntArray (String^ fieldName, array< System::Int32 >^ intArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteLong (String^ fieldName, Int64 value)
 Write a 64-bit integer to the IPdxWriter. More...
 
IPdxWriterWriteLongArray (String^ fieldName, array< Int64 >^ longArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteObject (String^ fieldName, Object^ obj)
 Write an Object object to the IPdxWriter. More...
 
IPdxWriterWriteObjectArray (String^ fieldName, List< Object^>^ objectArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteShort (String^ fieldName, Int16 value)
 Write a 16-bit integer to the IPdxWriter. More...
 
IPdxWriterWriteShortArray (String^ fieldName, array< System::Int16 >^ shortArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteString (String^ fieldName, String^ value)
 Write a string using java-modified UTF-8 encoding to IPdxWriter. More...
 
IPdxWriterWriteStringArray (String^ fieldName, array< String^>^ stringArray)
 Write an collection to the IPdxWriter. More...
 
IPdxWriterWriteUnreadFields (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. This interface is implemented by Native Client.

Member Function Documentation

◆ MarkIdentityField()

IPdxWriter ^ Apache::Geode::Client::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(boolean) 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 primatives, 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
fieldNamethe name of the field that should be used in the as part of the identity.
Returns
this PdxWriter

◆ WriteArrayOfByteArrays()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteArrayOfByteArrays ( String^  fieldName,
array< array< Byte >^>^  byteArrays 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
byteArraysThe byteArrays to write.

◆ WriteBoolean()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteBoolean ( String^  fieldName,
Boolean  value 
)

Write a boolean value to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe boolean value to write.

◆ WriteBooleanArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteBooleanArray ( String^  fieldName,
array< bool >^  boolArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
boolArrayThe boolArray to write.

◆ WriteByte()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteByte ( String^  fieldName,
SByte  value 
)

Write a byte to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe byte to write.

◆ WriteByteArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteByteArray ( String^  fieldName,
array< Byte >^  byteArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
byteArrayThe byteArray to write.

◆ WriteChar()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteChar ( String^  fieldName,
Char  value 
)

Write a char value to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe char value to write.

◆ WriteCharArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteCharArray ( String^  fieldName,
array< Char >^  charArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
charArrayThe charArray to write.

◆ WriteDate()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteDate ( String^  fieldName,
System::DateTime  date 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
dateThe date to write.

◆ WriteDouble()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteDouble ( String^  fieldName,
double  value 
)

Write a double precision real number to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe double precision real number to write.

◆ WriteDoubleArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteDoubleArray ( String^  fieldName,
array< double >^  doubleArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
doubleArrayThe doubleArray to write.

◆ WriteField()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteField ( String^  fieldName,
Object^  fieldValue,
Type^  type 
)

Writes the named field with the given value and type to the serialized form. This method uses the fieldType to determine which WriteXXX method it should call. If it can not find a specific match to a writeXXX method it will call .

Returns
this PdxWriter

◆ WriteFloat()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteFloat ( String^  fieldName,
float  value 
)

Write a float to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe float value to write.

◆ WriteFloatArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteFloatArray ( String^  fieldName,
array< float >^  floatArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
floatArrayThe floatArray to write.

◆ WriteInt()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteInt ( String^  fieldName,
Int32  value 
)

Write a 32-bit integer to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe 32-bit integer to write.

◆ WriteIntArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteIntArray ( String^  fieldName,
array< System::Int32 >^  intArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
intArrayThe intArray to write.

◆ WriteLong()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteLong ( String^  fieldName,
Int64  value 
)

Write a 64-bit integer to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe 64-bit integer to write.

◆ WriteLongArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteLongArray ( String^  fieldName,
array< Int64 >^  longArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
longArrayThe longArray to write.

◆ WriteObject()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteObject ( String^  fieldName,
Object^  obj 
)

Write an Object object to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
objThe object to write.

◆ WriteObjectArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteObjectArray ( String^  fieldName,
List< Object^>^  objectArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
objectArrayThe objectArray to write.

◆ WriteShort()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteShort ( String^  fieldName,
Int16  value 
)

Write a 16-bit integer to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe 16-bit integer to write.

◆ WriteShortArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteShortArray ( String^  fieldName,
array< System::Int16 >^  shortArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
shortArrayThe shortArray to write.

◆ WriteString()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteString ( String^  fieldName,
String^  value 
)

Write a string using java-modified UTF-8 encoding to IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
valueThe UTF encoded string to write.

◆ WriteStringArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteStringArray ( String^  fieldName,
array< String^>^  stringArray 
)

Write an collection to the IPdxWriter.

Parameters
fieldNameThe name of the field associated with the value.
stringArrayThe stringArray to write.

◆ WriteUnreadFields()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteUnreadFields ( IPdxUnreadFields unread)

To append unread data with updated data.

Returns
this PdxWriter

Apache Geode C++ Cache .NET API Documentation