vmware-gemfire-native-client-c++-api-reference/latest/a00194_source.html

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */


#pragma once


#ifndef GEODE_PROPERTIES_H_

#define GEODE_PROPERTIES_H_


#include <memory>

#include <string>

#include <unordered_map>


#include "CacheableKey.hpp"

#include "internal/DataSerializablePrimitive.hpp"

#include "internal/chrono/duration.hpp"

#include "internal/geode_globals.hpp"


namespace apache {

namespace geode {

namespace client {


using apache::geode::internal::chrono::duration::to_string;


class DataInput;

class DataOutput;

class CacheableString;


class APACHE_GEODE_EXPORT Properties

    : public internal::DataSerializablePrimitive {

 public:

  class Visitor {

   public:

    virtual void visit(const std::shared_ptr<CacheableKey>& key,

                       const std::shared_ptr<Cacheable>& value) = 0;

    virtual ~Visitor() noexcept = default;

  };


  Properties() = default;

  ~Properties() noexcept override = default;

  Properties(const Properties&) = delete;

  Properties& operator=(const Properties&) = delete;


  std::shared_ptr<CacheableString> find(const std::string& key);


  std::shared_ptr<Cacheable> find(const std::shared_ptr<CacheableKey>& key);


  void insert(std::string key, std::string value);


  void insert(std::string key, const int value);


  void insert(const std::shared_ptr<CacheableKey>& key,

              const std::shared_ptr<Cacheable>& value);


  template <class _Rep, class _Period>

  void insert(std::string key,

              const std::chrono::duration<_Rep, _Period>& value) {

    insert(key, to_string(value));

  }


  void remove(const std::string& key);


  void remove(const std::shared_ptr<CacheableKey>& key);


  void foreach (Visitor& visitor) const;


  size_t getSize() const;


  void addAll(const std::shared_ptr<Properties>& other);


  static std::shared_ptr<Properties> create();


  void load(const std::string& fileName);


  static std::shared_ptr<Serializable> createDeserializable();


  void toData(DataOutput& output) const override;


  void fromData(DataInput& input) override;


  internal::DSCode getDsCode() const override;


 private:

  HashMapOfCacheable m_map;

};


}  // namespace client

}  // namespace geode

}  // namespace apache


#endif  // GEODE_PROPERTIES_H_

CacheableKey.hpp

apache::geode::client::DataInput
Provide operations for reading primitive data values, byte arrays, strings, Serializable objects from...
Definition DataInput.hpp:59

apache::geode::client::DataOutput
Provide operations for writing primitive data values, byte arrays, strings, Serializable objects to a...
Definition DataOutput.hpp:48

apache::geode::client::Properties
Contains a set of (key, value) pair properties with key being the name of the property; value,...
Definition Properties.hpp:52

apache::geode::client::Properties::addAll
void addAll(const std::shared_ptr< Properties > &other)
Add the contents of other to this instance, replacing any existing values with those from other.

apache::geode::client::Properties::insert
void insert(std::string key, std::string value)
Add or update the string value for key.

apache::geode::client::Properties::remove
void remove(const std::string &key)
Remove the key from the collection.

apache::geode::client::Properties::getSize
size_t getSize() const
Return the number of entries in the collection.

apache::geode::client::Properties::load
void load(const std::string &fileName)
Read property values from a file, overriding what is currently in the properties object.

apache::geode::client::Properties::create
static std::shared_ptr< Properties > create()
Factory method, returns an empty collection.

apache::geode::client::Properties::createDeserializable
static std::shared_ptr< Serializable > createDeserializable()
Return an empty instance for deserialization.

apache::geode::client::Properties::find
std::shared_ptr< CacheableString > find(const std::string &key)
Return the value for the given key, or nullptr if not found.

apache::geode::client::Properties::insert
void insert(const std::shared_ptr< CacheableKey > &key, const std::shared_ptr< Cacheable > &value)
Add or update Cacheable value for CacheableKey.

apache::geode::client::Properties::find
std::shared_ptr< Cacheable > find(const std::shared_ptr< CacheableKey > &key)
Return the value for the given CacheableKey, or nullptr if not found.

apache::geode::client::Properties::remove
void remove(const std::shared_ptr< CacheableKey > &key)
Remove the CacheableKey from the collection.

apache::geode::client::Properties::insert
void insert(std::string key, const int value)
Add or update the int value for key.