cppcache/include/geode/CacheableObjectArray.hpp

/*
 * 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_CACHEABLEOBJECTARRAY_H_
#define GEODE_CACHEABLEOBJECTARRAY_H_

#include <vector>
#include <memory>

#include "internal/geode_globals.hpp"
#include "internal/DataSerializablePrimitive.hpp"
#include "Serializable.hpp"
#include "internal/DSCode.hpp"

/** @file
 */

namespace apache {
namespace geode {
namespace client {

/**
 * Implement an immutable Vector of <code>Cacheable</code> objects
 * that can serve as a distributable object for caching.
 */
class DataInput;
class DataOutput;
class Serializable;

class APACHE_GEODE_EXPORT CacheableObjectArray
    : public internal::DataSerializablePrimitive,
      public std::vector<std::shared_ptr<Cacheable>> {
 public:
  /** Constructor, used for deserialization. */
  inline CacheableObjectArray() : std::vector<std::shared_ptr<Cacheable>>() {}

  /** Create a vector with n elements allocated. */
  inline explicit CacheableObjectArray(int32_t n)
      : std::vector<std::shared_ptr<Cacheable>>(n) {}

  ~CacheableObjectArray() noexcept override = default;

  CacheableObjectArray& operator=(const CacheableObjectArray& other) = delete;
  CacheableObjectArray(const CacheableObjectArray& other) = delete;

  void toData(DataOutput& output) const override;

  virtual void fromData(DataInput& input) override;

  /**
   * @brief creation function for java Object[]
   */
  inline static std::shared_ptr<Serializable> createDeserializable() {
    return std::make_shared<CacheableObjectArray>();
  }

  internal::DSCode getDsCode() const override {
    return internal::DSCode::CacheableObjectArray;
  }

  /**
   * Factory method for creating the default instance of CacheableObjectArray.
   */
  inline static std::shared_ptr<CacheableObjectArray> create() {
    return std::make_shared<CacheableObjectArray>();
  }

  /**
   * Factory method for creating an instance of CacheableObjectArray with
   * given size.
   */
  inline static std::shared_ptr<CacheableObjectArray> create(int32_t n) {
    return std::make_shared<CacheableObjectArray>(n);
  }

  virtual size_t objectSize() const override;
};

}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_CACHEABLEOBJECTARRAY_H_