Apache::Geode::Client::IPdxReader Interface Reference

A IPdxReader will be passed to IPdxSerializable.fromData or during deserialization of a PDX. More...

#include <IPdxReader.hpp>

Public Member Functions
bool	HasField (String^ fieldName)
	Whether field is available or not.
bool	IsIdentityField (String^ fieldName)
	Whether field is used as identity field or not.
array< array< Byte >^> ^	ReadArrayOfByteArrays (String^ fieldName)
	Read a two-dimenesional signed byte array from the data.
Boolean	ReadBoolean (String^ fieldName)
	Read a boolean value from the stream.
array< Boolean > ^	ReadBooleanArray (String^ fieldName)
	Read a boolean array from the data.
SByte	ReadByte (String^ fieldName)
	Read a signed byte from the stream.
array< Byte > ^	ReadByteArray (String^ fieldName)
	Read a signed byte array from the data.
Char	ReadChar (String^ fieldName)
	Read a char value from the stream.
array< Char > ^	ReadCharArray (String^ fieldName)
	Read a char array from the data.
System::DateTime	ReadDate (String^ fieldName)
	Read a Date from the data.
double	ReadDouble (String^ fieldName)
	Read a double precision number from the stream.
array< double > ^	ReadDoubleArray (String^ fieldName)
	Read a double array from the data.
Object ^	ReadField (String^ fieldName, Type^ type)
	Reads the named field of Type "type" and returns its value.
float	ReadFloat (String^ fieldName)
	Read a floating point number from the stream.
array< float > ^	ReadFloatArray (String^ fieldName)
	Read a float from the data.
Int32	ReadInt (String^ fieldName)
	Read a 32-bit integer from the stream.
array< System::Int32 > ^	ReadIntArray (String^ fieldName)
	Read a int array from the data.
Int64	ReadLong (String^ fieldName)
	Read a 64-bit integer from the stream.
array< Int64 > ^	ReadLongArray (String^ fieldName)
	Read a long array from the data.
Object ^	ReadObject (String^ fieldName)
	Read a serializable object from the data.
List< Object^> ^	ReadObjectArray (String^ fieldName)
	Read a object array from the data.
short	ReadShort (String^ fieldName)
	Read a 16-bit integer from the stream.
array< short > ^	ReadShortArray (String^ fieldName)
	Read a short from the data.
String ^	ReadString (String^ fieldName)
	Read a string after java-modified UTF-8 decoding from the stream.
array< String^> ^	ReadStringArray (String^ fieldName)
	Read a string array from the data.
IPdxUnreadFields ^	ReadUnreadFields ()
	To preserve unread data, which get added in new version of type.

Detailed Description

A IPdxReader will be passed to IPdxSerializable.fromData or during deserialization of a PDX.

The domain class needs to deserialize field members using this interface. This interface is implemented by Native Client. Each readXXX call will return the field's value. If the serialized PDX does not contain the named field then a default value will be returned. Standard Java defaults are used. For Objects this is null and for primitives it is 0 or 0.0.

Member Function Documentation

HasField()

bool Apache::Geode::Client::IPdxReader::HasField

(

String^

fieldName

)

Whether field is available or not.

Parameters

fieldName

The name of a member field.

IsIdentityField()

bool Apache::Geode::Client::IPdxReader::IsIdentityField

(

String^

fieldName

)

Whether field is used as identity field or not.

Parameters

fieldName

The name of a member field.

ReadArrayOfByteArrays()

array< array< Byte >^> ^ Apache::Geode::Client::IPdxReader::ReadArrayOfByteArrays

(

String^

fieldName

)

Read a two-dimenesional signed byte array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadBoolean()

Boolean Apache::Geode::Client::IPdxReader::ReadBoolean

(

String^

fieldName

)

Read a boolean value from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadBooleanArray()

array< Boolean > ^ Apache::Geode::Client::IPdxReader::ReadBooleanArray

(

String^

fieldName

)

Read a boolean array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadByte()

SByte Apache::Geode::Client::IPdxReader::ReadByte

(

String^

fieldName

)

Read a signed byte from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadByteArray()

array< Byte > ^ Apache::Geode::Client::IPdxReader::ReadByteArray

(

String^

fieldName

)

Read a signed byte array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadChar()

Char Apache::Geode::Client::IPdxReader::ReadChar

(

String^

fieldName

)

Read a char value from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadCharArray()

array< Char > ^ Apache::Geode::Client::IPdxReader::ReadCharArray

(

String^

fieldName

)

Read a char array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadDate()

System::DateTime Apache::Geode::Client::IPdxReader::ReadDate

(

String^

fieldName

)

Read a Date from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadDouble()

double Apache::Geode::Client::IPdxReader::ReadDouble

(

String^

fieldName

)

Read a double precision number from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadDoubleArray()

array< double > ^ Apache::Geode::Client::IPdxReader::ReadDoubleArray

(

String^

fieldName

)

Read a double array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadField()

Object ^ Apache::Geode::Client::IPdxReader::ReadField	(	String^	fieldName,
		Type^	type
	)

Reads the named field of Type "type" and returns its value.

Parameters

fieldName	The name of a member field.
type	The type of a member field, which value needs to read.

ReadFloat()

float Apache::Geode::Client::IPdxReader::ReadFloat

(

String^

fieldName

)

Read a floating point number from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadFloatArray()

array< float > ^ Apache::Geode::Client::IPdxReader::ReadFloatArray

(

String^

fieldName

)

Read a float from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadInt()

Int32 Apache::Geode::Client::IPdxReader::ReadInt

(

String^

fieldName

)

Read a 32-bit integer from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadIntArray()

array< System::Int32 > ^ Apache::Geode::Client::IPdxReader::ReadIntArray

(

String^

fieldName

)

Read a int array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadLong()

Int64 Apache::Geode::Client::IPdxReader::ReadLong

(

String^

fieldName

)

Read a 64-bit integer from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadLongArray()

array< Int64 > ^ Apache::Geode::Client::IPdxReader::ReadLongArray

(

String^

fieldName

)

Read a long array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadObject()

Object ^ Apache::Geode::Client::IPdxReader::ReadObject

(

String^

fieldName

)

Read a serializable object from the data.

Null objects are handled.

Parameters

fieldName

The name of a member field whose value to read.

ReadObjectArray()

List< Object^> ^ Apache::Geode::Client::IPdxReader::ReadObjectArray

(

String^

fieldName

)

Read a object array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadShort()

short Apache::Geode::Client::IPdxReader::ReadShort

(

String^

fieldName

)

Read a 16-bit integer from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadShortArray()

array< short > ^ Apache::Geode::Client::IPdxReader::ReadShortArray

(

String^

fieldName

)

Read a short from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadString()

String ^ Apache::Geode::Client::IPdxReader::ReadString

(

String^

fieldName

)

Read a string after java-modified UTF-8 decoding from the stream.

Parameters

fieldName

The name of a member field whose value to read.

ReadStringArray()

array< String^> ^ Apache::Geode::Client::IPdxReader::ReadStringArray

(

String^

fieldName

)

Read a string array from the data.

Parameters

fieldName

The name of a member field whose value to read.

ReadUnreadFields()

IPdxUnreadFields ^ Apache::Geode::Client::IPdxReader::ReadUnreadFields

(

)

To preserve unread data, which get added in new version of type.

<return>Unread data.</return>