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

Public Member Functions
	ClassDefinition ()
	Constructor.
	ClassDefinition (int factory_id, int class_id, int version)
	Constructor.
void	add_field_def (FieldDefinition &field_definition)
	Internal API.
bool	has_field (const std::string &field_name) const
const FieldDefinition &	get_field (const std::string &field_name) const
field_type	get_field_type (const std::string &field_name) const
int	get_field_count () const
int	get_factory_id () const
int	get_class_id () const
int	get_version () const
void	set_version_if_not_set (int new_version)
	Internal API.
void	write_data (pimpl::data_output &data_output)
	Internal API.
void	read_data (object_data_input &data_input)
	Internal API.
bool	operator== (const ClassDefinition &rhs) const
bool	operator!= (const ClassDefinition &rhs) const

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

Detailed Description

Definition at line 582 of file serialization.h.

Constructor & Destructor Documentation

ClassDefinition() [1/2]

hazelcast::client::serialization::ClassDefinition::ClassDefinition

(

)

Constructor.

Definition at line 437 of file serialization.cpp.

  : factory_id_(0)
  , class_id_(0)
  , version_(-1)
  , binary_(new std::vector<byte>)
{}

ClassDefinition() [2/2]

hazelcast::client::serialization::ClassDefinition::ClassDefinition	(	int	factory_id,
		int	class_id,
		int	version )

Constructor.

Parameters

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

Definition at line 444 of file serialization.cpp.

  : factory_id_(factory_id)
  , class_id_(class_id)
  , version_(version)
  , binary_(new std::vector<byte>)
{}

Member Function Documentation

add_field_def()

void hazelcast::client::serialization::ClassDefinition::add_field_def

(

FieldDefinition &

field_definition

)

Internal API.

Parameters

fieldDefinition

to be added

Definition at line 452 of file serialization.cpp.

{
    field_definitions_map_[fd.get_name()] = fd;
}

get_class_id()

int hazelcast::client::serialization::ClassDefinition::get_class_id

(

)

const

Returns

class id

Definition at line 499 of file serialization.cpp.

{
    return class_id_;
}

get_factory_id()

int hazelcast::client::serialization::ClassDefinition::get_factory_id

(

)

const

Returns

factory id

Definition at line 493 of file serialization.cpp.

{
    return factory_id_;
}

get_field()

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

(

const std::string &

field_name

)

const

Parameters

fieldName

name of the field

Returns

field definition by given name

Exceptions

illegal_argument

when field not found

Definition at line 458 of file serialization.cpp.

{
    auto it = field_definitions_map_.find(name);
    if (it != field_definitions_map_.end()) {
        return it->second;
    }
    BOOST_THROW_EXCEPTION(exception::hazelcast_serialization(
      "ClassDefinition::getField",
      (boost::format("Invalid field name: '%1%' for ClassDefinition {id: %2%, "
                     "version: %3%}") %
       name % class_id_ % version_)
        .str()));
}

get_field_count()

int hazelcast::client::serialization::ClassDefinition::get_field_count

(

)

const

Returns

total field count

Definition at line 487 of file serialization.cpp.

{
    return (int)field_definitions_map_.size();
}

get_field_type()

field_type hazelcast::client::serialization::ClassDefinition::get_field_type

(

const std::string &

field_name

)

const

Parameters

fieldName

name of the field

Returns

type of given field

Exceptions

illegal_argument_exception

Definition at line 480 of file serialization.cpp.

{
    FieldDefinition const& fd = get_field(field_name);
    return fd.get_type();
}

get_version()

int hazelcast::client::serialization::ClassDefinition::get_version

(

)

const

Returns

version

Definition at line 505 of file serialization.cpp.

{
    return version_;
}

has_field()

bool hazelcast::client::serialization::ClassDefinition::has_field

(

const std::string &

field_name

)

const

Parameters

fieldName

field name

Returns

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

Definition at line 473 of file serialization.cpp.

{
    return field_definitions_map_.find(field_name) !=
           field_definitions_map_.end();
}

operator!=()

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

(

const ClassDefinition &

rhs

)

const

Definition at line 553 of file serialization.cpp.

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

operator==()

bool hazelcast::client::serialization::ClassDefinition::operator==

(

const ClassDefinition &

rhs

)

const

Definition at line 545 of file serialization.cpp.

{
    return factory_id_ == rhs.factory_id_ && class_id_ == rhs.class_id_ &&
           version_ == rhs.version_ &&
           field_definitions_map_ == rhs.field_definitions_map_;
}

read_data()

void hazelcast::client::serialization::ClassDefinition::read_data

(

object_data_input &

data_input

)

Internal API.

Parameters

dataInput

Definition at line 531 of file serialization.cpp.

{
    factory_id_ = data_input.read<int32_t>();
    class_id_ = data_input.read<int32_t>();
    version_ = data_input.read<int32_t>();
    int size = data_input.read<int16_t>();
    for (int i = 0; i < size; i++) {
        FieldDefinition fieldDefinition;
        fieldDefinition.read_data(data_input);
        add_field_def(fieldDefinition);
    }
}

set_version_if_not_set()

void hazelcast::client::serialization::ClassDefinition::set_version_if_not_set

(

int

new_version

)

Internal API.

Parameters

newVersion

portable version

Definition at line 511 of file serialization.cpp.

{
    if (get_version() < 0) {
        this->version_ = new_version;
    }
}

write_data()

void hazelcast::client::serialization::ClassDefinition::write_data

(

pimpl::data_output &

data_output

)

Internal API.

Parameters

dataOutput

Definition at line 519 of file serialization.cpp.

{
    data_output.write<int32_t>(factory_id_);
    data_output.write<int32_t>(class_id_);
    data_output.write<int32_t>(version_);
    data_output.write<int16_t>(field_definitions_map_.size());
    for (auto& entry : field_definitions_map_) {
        entry.second.write_data(data_output);
    }
}

Friends And Related Symbol Documentation

operator<<

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

friend

Definition at line 558 of file serialization.cpp.

{
    os << "ClassDefinition{"
       << "factoryId: " << definition.factory_id_
       << " classId: " << definition.class_id_
       << " version: " << definition.version_ << " fieldDefinitions: {";
 
    for (auto& entry : definition.field_definitions_map_) {
        os << entry.second;
    }
    os << "} }";
    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