hazelcast::client::serialization::FieldDefinition Class Reference

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

#include <serialization.h>

Public Member Functions
	FieldDefinition ()
	Constructor.
	FieldDefinition (int, const std::string &, field_type const &type, int version)
	Constructor.
	FieldDefinition (int index, const std::string &field_name, field_type const &type, int factory_id, int class_id, int version)
	Constructor.
const field_type &	get_type () const
std::string	get_name () const
int	get_index () const
int	get_factory_id () const
int	get_class_id () const
void	write_data (pimpl::data_output &data_output)
void	read_data (object_data_input &data_input)
bool	operator== (const FieldDefinition &rhs) const
bool	operator!= (const FieldDefinition &rhs) const

Friends
std::ostream &	operator<< (std::ostream &os, const FieldDefinition &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

ClassDefinitionBuilder FieldDefinition defines name, type, index of a field

Definition at line 505 of file serialization.h.

Constructor & Destructor Documentation

FieldDefinition() [1/3]

hazelcast::client::serialization::FieldDefinition::FieldDefinition

(

)

Constructor.

Definition at line 257 of file serialization.cpp.

  : index_(0)
  , class_id_(0)
  , factory_id_(0)
  , version_(-1)
{}

FieldDefinition() [2/3]

hazelcast::client::serialization::FieldDefinition::FieldDefinition	(	int	index,
		const std::string &	field_name,
		field_type const &	type,
		int	version )

Constructor.

Definition at line 264 of file serialization.cpp.

  : index_(index)
  , field_name_(field_name)
  , type_(type)
  , class_id_(0)
  , factory_id_(0)
  , version_(version)
{}

FieldDefinition() [3/3]

hazelcast::client::serialization::FieldDefinition::FieldDefinition	(	int	index,
		const std::string &	field_name,
		field_type const &	type,
		int	factory_id,
		int	class_id,
		int	version )

Constructor.

Definition at line 276 of file serialization.cpp.

  : index_(index)
  , field_name_(field_name)
  , type_(type)
  , class_id_(class_id)
  , factory_id_(factory_id)
  , version_(version)
{}

Member Function Documentation

get_class_id()

int hazelcast::client::serialization::FieldDefinition::get_class_id

(

)

const

Returns

class id of this field's class

Definition at line 315 of file serialization.cpp.

{
    return class_id_;
}

get_factory_id()

int hazelcast::client::serialization::FieldDefinition::get_factory_id

(

)

const

Returns

factory id of this field's class

Definition at line 309 of file serialization.cpp.

{
    return factory_id_;
}

get_index()

int hazelcast::client::serialization::FieldDefinition::get_index

(

)

const

Returns

field index

Definition at line 303 of file serialization.cpp.

{
    return index_;
}

get_name()

std::string hazelcast::client::serialization::FieldDefinition::get_name

(

)

const

Returns

field name

Definition at line 297 of file serialization.cpp.

{
    return field_name_;
}

get_type()

const field_type & hazelcast::client::serialization::FieldDefinition::get_type

(

)

const

Returns

field type

Definition at line 291 of file serialization.cpp.

{
    return type_;
}

operator!=()

bool hazelcast::client::serialization::FieldDefinition::operator!=

(

const FieldDefinition &

rhs

)

const

Definition at line 349 of file serialization.cpp.

{
    return !(rhs == *this);
}

operator==()

bool hazelcast::client::serialization::FieldDefinition::operator==

(

const FieldDefinition &

rhs

)

const

Definition at line 341 of file serialization.cpp.

{
    return field_name_ == rhs.field_name_ && type_ == rhs.type_ &&
           class_id_ == rhs.class_id_ && factory_id_ == rhs.factory_id_ &&
           version_ == rhs.version_;
}

read_data()

void hazelcast::client::serialization::FieldDefinition::read_data

(

object_data_input &

data_input

)

Parameters

dataInput

reads fieldDefinition from given dataOutput

Definition at line 331 of file serialization.cpp.

{
    index_ = data_input.read<int32_t>();
    field_name_ = data_input.read<std::string>();
    type_ = static_cast<field_type>(data_input.read<byte>());
    factory_id_ = data_input.read<int32_t>();
    class_id_ = data_input.read<int32_t>();
}

write_data()

void hazelcast::client::serialization::FieldDefinition::write_data

(

pimpl::data_output &

data_output

)

Parameters

dataOutput

writes fieldDefinition to given dataOutput

Definition at line 321 of file serialization.cpp.

{
    data_output.write<int32_t>(index_);
    data_output.write<std::string>(field_name_);
    data_output.write<byte>(static_cast<int32_t>(type_));
    data_output.write<int32_t>(factory_id_);
    data_output.write<int32_t>(class_id_);
}

Friends And Related Symbol Documentation

operator<<

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

friend

Definition at line 354 of file serialization.cpp.

{
    os << "FieldDefinition{"
       << "index: " << definition.index_
       << " fieldName: " << definition.field_name_
       << " type: " << static_cast<int32_t>(definition.type_)
       << " classId: " << definition.class_id_
       << " factoryId: " << definition.factory_id_
       << " version: " << definition.version_;
    return os;
}

---

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

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