You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2019/06/18 16:04:16 UTC
[geode-native] branch develop updated: GEODE-6545: Language
corrections to Pdx-related API docs. (#495)
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode-native.git
The following commit(s) were added to refs/heads/develop by this push:
new 5b33ed6 GEODE-6545: Language corrections to Pdx-related API docs. (#495)
5b33ed6 is described below
commit 5b33ed66df0e2b5fd49d62f33f837e3b90c15ae2
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Tue Jun 18 09:04:11 2019 -0700
GEODE-6545: Language corrections to Pdx-related API docs. (#495)
* GEODE-6545: Language corrections to Pdx-related API docs. No code changes, only comments.
---
cppcache/include/geode/PdxInstance.hpp | 138 +++++++++++++-------------
cppcache/include/geode/PdxInstanceFactory.hpp | 2 +-
cppcache/include/geode/PdxReader.hpp | 44 ++++----
cppcache/include/geode/PdxSerializable.hpp | 4 +-
cppcache/include/geode/PdxSerializer.hpp | 14 +--
5 files changed, 101 insertions(+), 101 deletions(-)
diff --git a/cppcache/include/geode/PdxInstance.hpp b/cppcache/include/geode/PdxInstance.hpp
index 64c345d..ecf0430 100644
--- a/cppcache/include/geode/PdxInstance.hpp
+++ b/cppcache/include/geode/PdxInstance.hpp
@@ -35,17 +35,17 @@ class CacheableObjectArray;
* deserializing the PDX. Preventing deserialization saves time
* and memory.
* The PdxInstance implementation
- * is a light weight wrapper that simply refers to the raw bytes of the PDX
+ * is a lightweight wrapper that simply refers to the raw bytes of the PDX
* that are kept in the cache.
* Applications can choose to access PdxInstances instead of C++ objects by
* configuring the Cache to prefer PDX instances during deserialization.
* This can be done in <code>cache.xml</code> by setting the attribute
* <code>read-serialized</code>
- * to true on the <code>pdx</code> element. Or it can be done programmatically
- * using
+ * to true on the <code>pdx</code> element, or it can be done programmatically
+ * using the
* {@link CacheFactory#setPdxReadSerialized(boolean) setPdxReadSerialized}
* method. Once this preference is configured, then any time deserialization of
- * a PDX is done it will deserialize into a PdxInstance. PdxInstance are
+ * a PDX is done it will deserialize into a PdxInstance. PdxInstances are
* immutable. If you want to change one call {@link #createWriter}.
*/
class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
@@ -76,13 +76,13 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
virtual bool hasField(const std::string& fieldname) = 0;
/**
- * Reads the named field and set its value in std::shared_ptr<Cacheable> type
- * out param. std::shared_ptr<Cacheable> type is corresponding to java object
+ * Reads the named field and sets its value in std::shared_ptr<Cacheable> type
+ * out param. std::shared_ptr<Cacheable> type corresponds to the Java object
* type.
* @param fieldname name of the field to read
* @param value value of the field to be set with std::shared_ptr<Cacheable>
* type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
* For deserialization C++ Native Client requires the domain class to be
* registered.
*
@@ -93,109 +93,109 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in bool type out param.
- * bool type is corresponding to java boolean type.
+ * Reads the named field and sets its value in bool type out param.
+ * bool type corresponds to the Java boolean type.
* @param fieldname name of the field to read
* @param value value of the field to be set with bool type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
virtual bool getBooleanField(const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in signed char type out param.
- * signed char type is corresponding to java byte type.
+ * Reads the named field and sets its value in signed char type out param.
+ * signed char type corresponds to the Java byte type.
* @param fieldname name of the field to read
* @param value value of the field to be set with signed char type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
virtual int8_t getByteField(const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in int16_t type out param.
- * int16_t type is corresponding to java short type.
+ * Reads the named field and sets its value in int16_t type out param.
+ * int16_t type corresponds to the Java short type.
* @param fieldname name of the field to read
* @param value value of the field to be set with int16_t type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
virtual int16_t getShortField(const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in int32_t type out param.
- * int32_t type is corresponding to java int type.
+ * Reads the named field and sets its value in int32_t type out param.
+ * int32_t type corresponds to the Java int type.
* @param fieldname name of the field to read
* @param value value of the field to be set with int32_t type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*/
virtual int32_t getIntField(const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in int64_t type out param.
- * int64_t type is corresponding to java long type.
+ * Reads the named field and sets its value in int64_t type out param.
+ * int64_t type corresponds to the Java long type.
* @param fieldname name of the field to read
* @param value value of the field to be set with int64_t type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
virtual int64_t getLongField(const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in float type out param.
- * float type is corresponding to java float type.
+ * Reads the named field and sets its value in float type out param.
+ * float type corresponds to the Java float type.
* @param fieldname name of the field to read
* @param value value of the field to be set with float type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
virtual float getFloatField(const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in double type out param.
- * double type is corresponding to java double type.
+ * Reads the named field and sets its value in double type out param.
+ * double type corresponds to the Java double type.
* @param fieldname name of the field to read
* @param value value of the field to be set with double type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
virtual double getDoubleField(const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in char type out param.
- * char type is corresponding to java char type.
+ * Reads the named field and sets its value in char type out param.
+ * char type corresponds to the Java char type.
* @param fieldname name of the field to read
* @param value value of the field to be set with char type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
virtual char16_t getCharField(const std::string& fieldName) const = 0;
/**
- * Reads the named field and set its value in std::string type out param.
- * std::string type is corresponding to java String type.
+ * Reads the named field and sets its value in std::string type out param.
+ * std::string type corresponds to the Java String type.
* @param fieldname name of the field to read
* @return string value for field.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
virtual std::string getStringField(const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in bool array type out param.
- * bool* type is corresponding to java boolean[] type.
+ * Reads the named field and sets its value in bool array type out param.
+ * bool* type corresponds to the Java boolean[] type.
* @param fieldname name of the field to read
* @param value value of the field to be set with bool array type.
* @param length length is set with number of bool elements.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -203,12 +203,12 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in signed char array type out
- * param. int8_t* type is corresponding to java byte[] type.
+ * Reads the named field and sets its value in signed char array type out
+ * param. int8_t* type corresponds to the Java byte[] type.
* @param fieldname name of the field to read
* @param value value of the field to be set with int8_t array type.
* @param length length is set with number of int8_t elements.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -216,12 +216,12 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in int16_t array type out param.
- * int16_t* type is corresponding to java short[] type.
+ * Reads the named field and sets its value in int16_t array type out param.
+ * int16_t* type corresponds to the Java short[] type.
* @param fieldname name of the field to read
* @param value value of the field to be set with int16_t array type.
* @param length length is set with number of int16_t elements.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -229,12 +229,12 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in int32_t array type out param.
- * int32_t* type is corresponding to java int[] type.
+ * Reads the named field and sets its value in int32_t array type out param.
+ * int32_t* type corresponds to the Java int[] type.
* @param fieldname name of the field to read
* @param value value of the field to be set with int32_t array type.
* @param length length is set with number of int32_t elements.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -242,12 +242,12 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in int64_t array type out param.
- * int64_t* type is corresponding to java long[] type.
+ * Reads the named field and sets its value in int64_t array type out param.
+ * int64_t* type corresponds to the Java long[] type.
* @param fieldname name of the field to read
* @param value value of the field to be set with int64_t array type.
* @param length length is set with number of int64_t elements.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -255,12 +255,12 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in float array type out param.
- * float* type is corresponding to java float[] type.
+ * Reads the named field and sets its value in float array type out param.
+ * float* type corresponds to the Java float[] type.
* @param fieldname name of the field to read
* @param value value of the field to be set with float array type.
* @param length length is set with number of float elements.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -268,12 +268,12 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in double array type out param.
- * double* type is corresponding to java double[] type.
+ * Reads the named field and sets its value in double array type out param.
+ * double* type corresponds to the Java double[] type.
* @param fieldname name of the field to read
* @param value value of the field to be set with double array type.
* @param length length is set with number of double elements.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -282,12 +282,12 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
// charArray
/**
- * Reads the named field and set its value in char array type out param.
- * char16_t* type is corresponding to java char[] type.
+ * Reads the named field and sets its value in char array type out param.
+ * char16_t* type corresponds to the Java char[] type.
* @param fieldname name of the field to read
* @param value value of the field to be set with char array type.
* @param length length is set with number of char16_t* elements.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -296,9 +296,9 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
/**
* Reads the named field as a string array.
- * std::vector<std::string> type is corresponding to java String[] type.
+ * std::vector<std::string> type corresponds to the Java String[] type.
* @param fieldname name of the field to read
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -306,13 +306,13 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in std::shared_ptr<CacheableDate>
+ * Reads the named field and sets its value in std::shared_ptr<CacheableDate>
* type out param. std::shared_ptr<CacheableDate> type is corresponding to
* java Java.util.date type.
* @param fieldname name of the field to read
* @param value value of the field to be set with
* std::shared_ptr<CacheableDate> type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -320,14 +320,14 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
const std::string& fieldname) const = 0;
/**
- * Reads the named field and set its value in array of byte arrays type out
+ * Reads the named field and sets its value in array of byte arrays type out
* param.
- * int8_t** type is corresponding to java byte[][] type.
+ * int8_t** type corresponds to the Java byte[][] type.
* @param fieldname name of the field to read.
* @param value value of the field to be set with array of byte arrays type.
* @param arrayLength arrayLength is set to the number of byte arrays.
* @param elementLength elementLength is set to individual byte array lengths.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see PdxInstance#hasField
*/
@@ -336,15 +336,15 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
int32_t*& elementLength) const = 0;
/**
- * Reads the named field and set its value in
+ * Reads the named field and sets its value in
* std::shared_ptr<CacheableObjectArray> type out param. For deserialization
* C++ Native Client requires the domain class to be registered.
- * std::shared_ptr<CacheableObjectArray> type is corresponding to java
+ * std::shared_ptr<CacheableObjectArray> type corresponds to the Java
* Object[] type.
* @param fieldname name of the field to read.
* @param value value of the field to be set with
* std::shared_ptr<CacheableObjectArray> type.
- * @throws IllegalStateException if PdxInstance doesn't has the named field.
+ * @throws IllegalStateException if PdxInstance doesn't have the named field.
*
* @see serializationRegistry->addPdxType
* @see PdxInstance#hasField
@@ -473,7 +473,7 @@ class APACHE_GEODE_EXPORT PdxInstance : public PdxSerializable {
/**
* @brief Deserialize this object. This is an internal method.
- * @param PdxReader to Deserialize the PDX object
+ * @param PdxReader to deserialize the PDX object
*/
virtual void fromData(PdxReader& input) override = 0;
diff --git a/cppcache/include/geode/PdxInstanceFactory.hpp b/cppcache/include/geode/PdxInstanceFactory.hpp
index b25e135..b6cb5ed 100644
--- a/cppcache/include/geode/PdxInstanceFactory.hpp
+++ b/cppcache/include/geode/PdxInstanceFactory.hpp
@@ -43,7 +43,7 @@ class AuthenticatedView;
* Call the write methods to populate the field data and then call {@link
* #create}
* to produce an actual instance that contains the data.
- * To create a factory call {@link Cache#createPdxInstanceFactory}
+ * To create a factory call {@link Cache#createPdxInstanceFactory}.
* A factory can only create a single instance. To create multiple instances
* create
* multiple factories or use {@link PdxInstance#createWriter} to create
diff --git a/cppcache/include/geode/PdxReader.hpp b/cppcache/include/geode/PdxReader.hpp
index 302820c..2b4d451 100644
--- a/cppcache/include/geode/PdxReader.hpp
+++ b/cppcache/include/geode/PdxReader.hpp
@@ -72,7 +72,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ char16_t is mapped to Java char</p>
* @param fieldName name of the field to read.
* @return value of type wchar_t.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -83,7 +83,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ bool is mapped to Java boolean</p>
* @param fieldName name of the field to read
* @return value of type bool.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -94,7 +94,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ int8_t is mapped to Java byte</p>
* @param fieldName name of the field to read
* @return value of type int8_t.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -105,7 +105,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ int16_t is mapped to Java short</p>
* @param fieldName name of the field to read
* @return value of type int16_t.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -116,7 +116,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ int32_t is mapped to Java int</p>
* @param fieldName name of the field to read
* @return value of type int32_t.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -127,7 +127,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ int64_t is mapped to Java long</p>
* @param fieldName name of the field to read
* @return value of type int64_t.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -138,7 +138,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ float is mapped to Java float</p>
* @param fieldName name of the field to read
* @return value of type float.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -149,7 +149,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ double is mapped to Java double</p>
* @param fieldName name of the field to read
* @return value of type double.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -161,7 +161,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @return value of type std::string*. Refer to the class description for
* how to free the return value.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -172,7 +172,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ std::shared_ptr<Cacheable> is mapped to Java object</p>
* @param fieldName name of the field to read
* @return value of type std::shared_ptr<Cacheable>.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -185,7 +185,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @param length length is set with number of char16_t elements.
* @return value of type char16_t*.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -196,7 +196,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* <p>C++ bool* is mapped to Java boolean[]</p>
* @param fieldName name of the field to read
* @param length length is set with number of bool elements.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -208,7 +208,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @param length length is set with number of int8_t elements
* @return value of type int8_t*.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -221,7 +221,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @param length length is set with number of int16_t elements
* @return value of type int16_t*.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -234,7 +234,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @param length length is set with number of int32_t elements
* @return value of type int32_t*.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -247,7 +247,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @param length length is set with number of int64_t elements
* @return value of type int64_t*.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -259,7 +259,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @param length length is set with number of float elements
* @return value of type float*.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -271,7 +271,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @param length length is set with number of double elements
* @return value of type double*.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -283,7 +283,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param fieldName name of the field to read
* @return value of type std::vector<std::string>. Refer to the class
* description for how to free the return value.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -296,7 +296,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* to Java Object[].
* @param fieldName name of the field to read
* @return value of type std::shared_ptr<CacheableObjectArray>.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -312,7 +312,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* @param elementLength elementLength is set with the length value of
* individual byte arrays.
* @return value of type int8_t**.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
@@ -326,7 +326,7 @@ class APACHE_GEODE_EXPORT PdxReader {
* Java Date</p>
* @param fieldName name of the field to read
* @return value of type std::shared_ptr<CacheableDate>.
- * @throws IllegalStateException if PdxReader doesn't has the named field.
+ * @throws IllegalStateException if PdxReader doesn't have the named field.
*
* @see PdxReader#hasField
*/
diff --git a/cppcache/include/geode/PdxSerializable.hpp b/cppcache/include/geode/PdxSerializable.hpp
index 7f19a66..3cf1842 100644
--- a/cppcache/include/geode/PdxSerializable.hpp
+++ b/cppcache/include/geode/PdxSerializable.hpp
@@ -49,14 +49,14 @@ class APACHE_GEODE_EXPORT PdxSerializable : public virtual Serializable,
int32_t hashcode() const override;
/**
- *@brief serialize this object in geode PDX format
+ *@brief Serialize this object in Geode PDX format
*@param PdxWriter to serialize the PDX object
**/
virtual void toData(PdxWriter& output) const = 0;
/**
*@brief Deserialize this object
- *@param PdxReader to Deserialize the PDX object
+ *@param PdxReader to deserialize the PDX object
**/
virtual void fromData(PdxReader& input) = 0;
diff --git a/cppcache/include/geode/PdxSerializer.hpp b/cppcache/include/geode/PdxSerializer.hpp
index 64d1de5..0820b41 100644
--- a/cppcache/include/geode/PdxSerializer.hpp
+++ b/cppcache/include/geode/PdxSerializer.hpp
@@ -29,8 +29,8 @@ namespace geode {
namespace client {
/**
- * Function pointer type which takes a void pointer to an instance of a user
- * object and class name to return the size of the user object.
+ * Function pointer type that takes a void pointer to an instance of a user
+ * object and a class name to return the size of the user object.
*/
using UserObjectSizer = std::function<size_t(const std::shared_ptr<const void>&,
const std::string&)>;
@@ -40,8 +40,8 @@ using UserObjectSizer = std::function<size_t(const std::shared_ptr<const void>&,
* serialized and deserialized as PDXs without modification
* of the domain class.
* A domain class should register function {@link
- * Serializable::registerPdxSerializer} to create new
- * instance of type for de-serilization.
+ * Serializable::registerPdxSerializer} to create a new
+ * instance of type for de-serialization.
*/
class APACHE_GEODE_EXPORT PdxSerializer {
public:
@@ -52,15 +52,15 @@ class APACHE_GEODE_EXPORT PdxSerializer {
/**
* Deserialize this object.
*
- * @param className the class name whose object need to de-serialize
+ * @param className the class name whose object needs to be de-serialized
* @param pr the PdxReader stream to use for reading the object data
*/
virtual std::shared_ptr<void> fromData(const std::string& className,
PdxReader& pdxReader) = 0;
/**
- * Serializes this object in geode PDX format.
- * @param userObject the object which need to serialize
+ * Serializes this object in Geode PDX format.
+ * @param userObject the object which needs to be serialized
* @param pw the PdxWriter object to use for serializing the object
*/
virtual bool toData(const std::shared_ptr<const void>& userObject,