VMware Tanzu GemFire .NET Client API Reference

VMware Tanzu GemFire .NET Client: IPdxReader Interface Reference
VMware Tanzu GemFire .NET Client
IPdxReader Interface Reference

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. 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. More...

Inherited by PdxReader.

Public Member Functions

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

Properties

ITypeRegistry TypeRegistry [get]
 Getter method for ITypeRegistry More...
 

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. 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 IPdxReader.HasField ( string  fieldName)

Whether field is available or not.

Parameters
fieldNameThe name of a member field.

◆ IsIdentityField()

bool IPdxReader.IsIdentityField ( string  fieldName)

Whether field is used as identity field or not.

Parameters
fieldNameThe name of a member field.

◆ ReadArrayOfByteArrays()

IReadOnlyCollection<IReadOnlyCollection<byte> > IPdxReader.ReadArrayOfByteArrays ( string  fieldName)

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

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadBoolean()

bool IPdxReader.ReadBoolean ( string  fieldName)

Read a bool value from the stream.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadBooleanArray()

IReadOnlyCollection<bool> IPdxReader.ReadBooleanArray ( string  fieldName)

Read a bool IReadOnlyCollection from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadByte()

byte IPdxReader.ReadByte ( string  fieldName)

Read a signed byte from the stream.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadByteArray()

IReadOnlyCollection<byte> IPdxReader.ReadByteArray ( string  fieldName)

Read a signed byte IReadOnlyCollection from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadChar()

char IPdxReader.ReadChar ( string  fieldName)

Read a char value from the stream.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadCharArray()

IReadOnlyCollection<char> IPdxReader.ReadCharArray ( string  fieldName)

Read a char IReadOnlyCollection from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadDate()

DateTime IPdxReader.ReadDate ( string  fieldName)

Read a Date from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadDouble()

double IPdxReader.ReadDouble ( string  fieldName)

Read a double precision number from the stream.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadDoubleArray()

IReadOnlyCollection<double> IPdxReader.ReadDoubleArray ( string  fieldName)

Read a double IReadOnlyCollection from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadField()

object IPdxReader.ReadField ( string  fieldName,
Type  type 
)

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

Parameters
fieldNameThe name of a member field.
typeThe type of a member field, which value needs to read.

◆ ReadFloat()

float IPdxReader.ReadFloat ( string  fieldName)

Read a floating point number from the stream.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadFloatArray()

IReadOnlyCollection<float> IPdxReader.ReadFloatArray ( string  fieldName)

Read a float from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadInt()

int IPdxReader.ReadInt ( string  fieldName)

Read a 32-bit integer from the stream.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadIntArray()

IReadOnlyCollection<int> IPdxReader.ReadIntArray ( string  fieldName)

Read a int IReadOnlyCollection from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadLong()

long IPdxReader.ReadLong ( string  fieldName)

Read a 64-bit integer from the stream.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadLongArray()

IReadOnlyCollection<long> IPdxReader.ReadLongArray ( string  fieldName)

Read a long IReadOnlyCollection from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadObject()

object IPdxReader.ReadObject ( string  fieldName)

Read a serializable object from the data. Null objects are handled.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadObjectArray()

IReadOnlyCollection<object> IPdxReader.ReadObjectArray ( string  fieldName)

Read a object IReadOnlyCollection from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadShort()

short IPdxReader.ReadShort ( string  fieldName)

Read a 16-bit integer from the stream.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadShortArray()

IReadOnlyCollection<short> IPdxReader.ReadShortArray ( string  fieldName)

Read a short from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadString()

string IPdxReader.ReadString ( string  fieldName)

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

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadStringArray()

IReadOnlyCollection<string> IPdxReader.ReadStringArray ( string  fieldName)

Read a string IReadOnlyCollection from the data.

Parameters
fieldNameThe name of a member field whose value to read.

◆ ReadUnreadFields()

IPdxUnreadFields IPdxReader.ReadUnreadFields ( )

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

<return>Unread data.</return>

Property Documentation

◆ TypeRegistry

ITypeRegistry IPdxReader.TypeRegistry
get

Getter method for ITypeRegistry


The documentation for this interface was generated from the following file:
  • gemfire.client/Interfaces/IPdxReader.cs