hazelcast::client::serialization::ClassDefinition Class Reference

ClassDefinition defines a class schema for Portable classes. More...

#include <ClassDefinition.h>

Public Member Functions
	ClassDefinition ()
	Constructor.
	ClassDefinition (int factoryId, int classId, int version)
	Constructor. More...
void	addFieldDef (FieldDefinition &fieldDefinition)
	Internal API. More...
bool	hasField (char const *fieldName) const
const FieldDefinition &	getField (const char *fieldName) const
FieldType	getFieldType (const char *fieldName) const
int	getFieldCount () const
int	getFactoryId () const
int	getClassId () const
int	getVersion () const
void	setVersionIfNotSet (int version)
	Internal API. More...
void	writeData (pimpl::DataOutput &dataOutput)
	Internal API. More...
void	readData (pimpl::DataInput &dataInput)
	Internal API. More...
bool	operator== (const ClassDefinition &rhs) const
bool	operator!= (const ClassDefinition &rhs) const

Friends
std::ostream &	operator<< (std::ostream &os, const ClassDefinition &definition)

Detailed Description

ClassDefinition defines a class schema for Portable classes.

It allows to query field names, types, class id etc. It can be created manually using ClassDefinitionBuilder or on demand during serialization phase.

See also

Portable

ClassDefinitionBuilder

Constructor & Destructor Documentation

ClassDefinition()

hazelcast::client::serialization::ClassDefinition::ClassDefinition	(	int	factoryId,
		int	classId,
		int	version
	)

Constructor.

Parameters

factoryId	factory id of class
classId	id of class
version	version of portable class

Member Function Documentation

addFieldDef()

void hazelcast::client::serialization::ClassDefinition::addFieldDef

(

FieldDefinition &

fieldDefinition

)

Internal API.

Parameters

fieldDefinition

to be added

getClassId()

int hazelcast::client::serialization::ClassDefinition::getClassId

(

)

const

Returns

class id

getFactoryId()

int hazelcast::client::serialization::ClassDefinition::getFactoryId

(

)

const

Returns

factory id

getField()

const FieldDefinition & hazelcast::client::serialization::ClassDefinition::getField

(

const char *

fieldName

)

const

Parameters

fieldName

name of the field

Returns

field definition by given name

Exceptions

IllegalArgumentException

when field not found

getFieldCount()

int hazelcast::client::serialization::ClassDefinition::getFieldCount

(

)

const

Returns

total field count

getFieldType()

FieldType hazelcast::client::serialization::ClassDefinition::getFieldType

(

const char *

fieldName

)

const

Parameters

fieldName

name of the field

Returns

type of given field

Exceptions

IllegalArgumentException

getVersion()

int hazelcast::client::serialization::ClassDefinition::getVersion

(

)

const

Returns

version

hasField()

bool hazelcast::client::serialization::ClassDefinition::hasField

(

char const *

fieldName

)

const

Parameters

fieldName

field name

Returns

true if this class definition contains a field named by given name

readData()

void hazelcast::client::serialization::ClassDefinition::readData

(

pimpl::DataInput &

dataInput

)

Internal API.

Parameters

dataInput

setVersionIfNotSet()

void hazelcast::client::serialization::ClassDefinition::setVersionIfNotSet

(

int

version

)

Internal API.

Parameters

version

portable version

writeData()

void hazelcast::client::serialization::ClassDefinition::writeData

(

pimpl::DataOutput &

dataOutput

)

Internal API.

Parameters

dataOutput

---

The documentation for this class was generated from the following files:

• hazelcast/include/hazelcast/client/serialization/ClassDefinition.h
• hazelcast/src/hazelcast/client/serialization/ClassDefinition.cpp