PdxInstance.hpp

#pragma once

#ifndef GEODE_PDXINSTANCE_H_
#define GEODE_PDXINSTANCE_H_

/*
 * 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.
 */

#include "PdxSerializable.hpp"
#include "CacheableBuiltins.hpp"
#include "PdxFieldTypes.hpp"

namespace apache {
namespace geode {
namespace client {

class CPPCACHE_EXPORT PdxInstance : public PdxSerializable {
 public:
  virtual ~PdxInstance() {}

  virtual PdxSerializablePtr getObject() = 0;

  virtual bool hasField(const char* fieldname) = 0;

  virtual void getField(const char* fieldname, CacheablePtr& value) const = 0;

  virtual void getField(const char* fieldname, bool& value) const = 0;

  virtual void getField(const char* fieldname, signed char& value) const = 0;

  virtual void getField(const char* fieldname, unsigned char& value) const = 0;

  virtual void getField(const char* fieldname, int16_t& value) const = 0;

  virtual void getField(const char* fieldname, int32_t& value) const = 0;

  virtual void getField(const char* fieldname, int64_t& value) const = 0;

  virtual void getField(const char* fieldname, float& value) const = 0;

  virtual void getField(const char* fieldname, double& value) const = 0;

  virtual void getField(const char* fieldName, wchar_t& value) const = 0;

  virtual void getField(const char* fieldName, char& value) const = 0;

  virtual void getField(const char* fieldname, bool** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname, signed char** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname, unsigned char** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname, int16_t** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname, int32_t** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname, int64_t** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname, float** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname, double** value,
                        int32_t& length) const = 0;

  // charArray
  virtual void getField(const char* fieldName, wchar_t** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldName, char** value,
                        int32_t& length) const = 0;

  // String
  virtual void getField(const char* fieldname, wchar_t** value) const = 0;

  virtual void getField(const char* fieldname, char** value) const = 0;

  // StringArray
  virtual void getField(const char* fieldname, wchar_t*** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname, char*** value,
                        int32_t& length) const = 0;

  virtual void getField(const char* fieldname,
                        CacheableDatePtr& value) const = 0;

  virtual void getField(const char* fieldName, int8_t*** value,
                        int32_t& arrayLength,
                        int32_t*& elementLength) const = 0;

  virtual void getField(const char* fieldname,
                        CacheableObjectArrayPtr& value) const = 0;

  virtual bool isIdentityField(const char* fieldname) = 0;

  virtual WritablePdxInstancePtr createWriter() = 0;

  virtual int32_t hashcode() const = 0;

  virtual CacheableStringPtr toString() const = 0;

  virtual void toData(DataOutput& output) const {
    PdxSerializable::toData(output);
  }

  virtual Serializable* fromData(DataInput& input) {
    return PdxSerializable::fromData(input);
  }

  virtual bool operator==(const CacheableKey& other) const = 0;

  virtual uint32_t objectSize() const = 0;

  virtual CacheableStringArrayPtr getFieldNames() = 0;

  // From PdxSerializable
  virtual void toData(PdxWriterPtr output) = 0;

  virtual void fromData(PdxReaderPtr input) = 0;

  virtual const char* getClassName() const = 0;

  virtual PdxFieldTypes::PdxFieldType getFieldType(
      const char* fieldname) const = 0;

 protected:
  PdxInstance() {}

 private:
  // never implemented.
  PdxInstance(const PdxInstance& other);
  void operator=(const PdxInstance& other);
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_PDXINSTANCE_H_