hazelcast::client::serialization::ClassDefinitionBuilder Class Reference

ClassDefinitionBuilder is used to build and register ClassDefinitions manually. More...

#include <serialization.h>

Public Member Functions
	ClassDefinitionBuilder (int factory_id, int class_id, int version)
ClassDefinitionBuilder &	add_portable_field (const std::string &field_name, std::shared_ptr< ClassDefinition > def)
ClassDefinitionBuilder &	add_portable_array_field (const std::string &field_name, std::shared_ptr< ClassDefinition > def)
ClassDefinitionBuilder &	add_field (FieldDefinition &field_definition)
void	add_field (const std::string &field_name, field_type const &field_type)
std::shared_ptr< ClassDefinition >	build ()
int	get_factory_id ()
int	get_class_id ()
int	get_version ()

Detailed Description

ClassDefinitionBuilder is used to build and register ClassDefinitions manually.

See also

ClassDefinition

SerializationConfig#addClassDefinition(ClassDefinition)

Definition at line 691 of file serialization.h.

Constructor & Destructor Documentation

ClassDefinitionBuilder()

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

Definition at line 132 of file serialization.cpp.

  : factory_id_(factory_id)
  , class_id_(class_id)
  , version_(version)
  , index_(0)
  , done_(false)
{}

Member Function Documentation

add_field() [1/2]

void hazelcast::client::serialization::ClassDefinitionBuilder::add_field	(	const std::string &	field_name,
		field_type const &	field_type )

Definition at line 231 of file serialization.cpp.

{
    check();
    FieldDefinition fieldDefinition(index_++, field_name, field_type, version_);
    field_definitions_.push_back(fieldDefinition);
}

add_field() [2/2]

ClassDefinitionBuilder & hazelcast::client::serialization::ClassDefinitionBuilder::add_field

(

FieldDefinition &

field_definition

)

Definition at line 184 of file serialization.cpp.

{
    check();
    int defIndex = field_definition.get_index();
    if (index_ != defIndex) {
        char buf[100];
        util::hz_snprintf(buf,
                          100,
                          "Invalid field index. Index in definition:%d, being "
                          "added at index:%d",
                          defIndex,
                          index_);
        BOOST_THROW_EXCEPTION(
          exception::illegal_argument("ClassDefinitionBuilder::addField", buf));
    }
    index_++;
    field_definitions_.push_back(field_definition);
    return *this;
}

add_portable_array_field()

ClassDefinitionBuilder & hazelcast::client::serialization::ClassDefinitionBuilder::add_portable_array_field	(	const std::string &	field_name,
		std::shared_ptr< ClassDefinition >	def )

Definition at line 163 of file serialization.cpp.

{
    check();
    if (def->get_class_id() == 0) {
        BOOST_THROW_EXCEPTION(exception::illegal_argument(
          "ClassDefinitionBuilder::addPortableField",
          "Portable class id cannot be zero!"));
    }
    FieldDefinition fieldDefinition(index_++,
                                    field_name,
                                    field_type::TYPE_PORTABLE_ARRAY,
                                    def->get_factory_id(),
                                    def->get_class_id(),
                                    def->get_version());
    field_definitions_.push_back(fieldDefinition);
    return *this;
}

add_portable_field()

ClassDefinitionBuilder & hazelcast::client::serialization::ClassDefinitionBuilder::add_portable_field	(	const std::string &	field_name,
		std::shared_ptr< ClassDefinition >	def )

Definition at line 143 of file serialization.cpp.

{
    check();
    if (def->get_class_id() == 0) {
        BOOST_THROW_EXCEPTION(exception::illegal_argument(
          "ClassDefinitionBuilder::addPortableField",
          "Portable class id cannot be zero!"));
    }
    FieldDefinition fieldDefinition(index_++,
                                    field_name,
                                    field_type::TYPE_PORTABLE,
                                    def->get_factory_id(),
                                    def->get_class_id(),
                                    def->get_version());
    field_definitions_.push_back(fieldDefinition);
    return *this;
}

build()

std::shared_ptr< ClassDefinition > hazelcast::client::serialization::ClassDefinitionBuilder::build

(

)

Definition at line 205 of file serialization.cpp.

{
    done_ = true;
    std::shared_ptr<ClassDefinition> cd(
      new ClassDefinition(factory_id_, class_id_, version_));
 
    std::vector<FieldDefinition>::iterator fdIt;
    for (fdIt = field_definitions_.begin(); fdIt != field_definitions_.end();
         fdIt++) {
        cd->add_field_def(*fdIt);
    }
    return cd;
}

get_class_id()

int hazelcast::client::serialization::ClassDefinitionBuilder::get_class_id

(

)

Definition at line 246 of file serialization.cpp.

{
    return class_id_;
}

get_factory_id()

int hazelcast::client::serialization::ClassDefinitionBuilder::get_factory_id

(

)

Definition at line 240 of file serialization.cpp.

{
    return factory_id_;
}

get_version()

int hazelcast::client::serialization::ClassDefinitionBuilder::get_version

(

)

Definition at line 252 of file serialization.cpp.

{
    return version_;
}

---

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

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