Apache::Geode::Client::IPdxWriter Interface Reference

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

#include <IPdxWriter.hpp>

Public Member Functions
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.
IPdxWriter ^	WriteArrayOfByteArrays (String^ fieldName, array< array< Byte >^>^ byteArrays)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteBoolean (String^ fieldName, Boolean value)
	Write a boolean value to the IPdxWriter.
IPdxWriter ^	WriteBooleanArray (String^ fieldName, array< bool >^ boolArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteByte (String^ fieldName, SByte value)
	Write a byte to the IPdxWriter.
IPdxWriter ^	WriteByteArray (String^ fieldName, array< Byte >^ byteArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteChar (String^ fieldName, Char value)
	Write a char value to the IPdxWriter.
IPdxWriter ^	WriteCharArray (String^ fieldName, array< Char >^ charArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteDate (String^ fieldName, System::DateTime date)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteDouble (String^ fieldName, double value)
	Write a double precision real number to the IPdxWriter.
IPdxWriter ^	WriteDoubleArray (String^ fieldName, array< double >^ doubleArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteField (String^ fieldName, Object^ fieldValue, Type^ type)
	Writes the named field with the given value and type to the serialized form.
IPdxWriter ^	WriteFloat (String^ fieldName, float value)
	Write a float to the IPdxWriter.
IPdxWriter ^	WriteFloatArray (String^ fieldName, array< float >^ floatArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteInt (String^ fieldName, Int32 value)
	Write a 32-bit integer to the IPdxWriter.
IPdxWriter ^	WriteIntArray (String^ fieldName, array< System::Int32 >^ intArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteLong (String^ fieldName, Int64 value)
	Write a 64-bit integer to the IPdxWriter.
IPdxWriter ^	WriteLongArray (String^ fieldName, array< Int64 >^ longArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteObject (String^ fieldName, Object^ obj)
	Write an Object object to the IPdxWriter.
IPdxWriter ^	WriteObjectArray (String^ fieldName, List< Object^>^ objectArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteShort (String^ fieldName, Int16 value)
	Write a 16-bit integer to the IPdxWriter.
IPdxWriter ^	WriteShortArray (String^ fieldName, array< System::Int16 >^ shortArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteString (String^ fieldName, String^ value)
	Write a string using java-modified UTF-8 encoding to IPdxWriter.
IPdxWriter ^	WriteStringArray (String^ fieldName, array< String^>^ stringArray)
	Write an collection to the IPdxWriter.
IPdxWriter ^	WriteUnreadFields (IPdxUnreadFields^ unread)
	To append unread data with updated data.

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

fieldName

the 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

fieldName	The name of the field associated with the value.
byteArrays	The byteArrays to write.

WriteBoolean()

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

Write a boolean value to the IPdxWriter.

Parameters

fieldName	The name of the field associated with the value.
value	The boolean value to write.

WriteBooleanArray()

IPdxWriter ^ Apache::Geode::Client::IPdxWriter::WriteBooleanArray	(	String^	fieldName,
		array< 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 ^ Apache::Geode::Client::IPdxWriter::WriteByte	(	String^	fieldName,
		SByte	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 ^ Apache::Geode::Client::IPdxWriter::WriteByteArray	(	String^	fieldName,
		array< 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 ^ Apache::Geode::Client::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 ^ Apache::Geode::Client::IPdxWriter::WriteCharArray	(	String^	fieldName,
		array< 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 ^ Apache::Geode::Client::IPdxWriter::WriteDate	(	String^	fieldName,
		System::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 ^ Apache::Geode::Client::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 ^ Apache::Geode::Client::IPdxWriter::WriteDoubleArray	(	String^	fieldName,
		array< double >^	doubleArray
	)

Write an collection to the IPdxWriter.

Parameters

fieldName	The name of the field associated with the value.
doubleArray	The 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 . this PdxWriter

WriteFloat()

IPdxWriter ^ Apache::Geode::Client::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 ^ Apache::Geode::Client::IPdxWriter::WriteFloatArray	(	String^	fieldName,
		array< 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 ^ Apache::Geode::Client::IPdxWriter::WriteInt	(	String^	fieldName,
		Int32	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 ^ Apache::Geode::Client::IPdxWriter::WriteIntArray	(	String^	fieldName,
		array< System::Int32 >^	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 ^ Apache::Geode::Client::IPdxWriter::WriteLong	(	String^	fieldName,
		Int64	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 ^ Apache::Geode::Client::IPdxWriter::WriteLongArray	(	String^	fieldName,
		array< Int64 >^	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 ^ Apache::Geode::Client::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 ^ Apache::Geode::Client::IPdxWriter::WriteObjectArray	(	String^	fieldName,
		List< 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 ^ Apache::Geode::Client::IPdxWriter::WriteShort	(	String^	fieldName,
		Int16	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 ^ Apache::Geode::Client::IPdxWriter::WriteShortArray	(	String^	fieldName,
		array< System::Int16 >^	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 ^ Apache::Geode::Client::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 ^ Apache::Geode::Client::IPdxWriter::WriteStringArray	(	String^	fieldName,
		array< 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 ^ Apache::Geode::Client::IPdxWriter::WriteUnreadFields

(

IPdxUnreadFields^

unread

)

To append unread data with updated data.

Returns

this PdxWriter