Update DataPoint#valueEquals Javadoc

Updated the Javadoc of the DataPoint#valueEquals method so that it identifies that true is only returned when the data point type is also the same.
hms-networks · May 15, 2024 · 431ebc2 · 431ebc2
1 parent 02af36f
commit 431ebc2
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPoint.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPoint.java
@@ -136,7 +136,7 @@ public String toString() {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public abstract boolean valueEquals(DataPoint p);
 

diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointBoolean.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointBoolean.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;

diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointDword.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointDword.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;

diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointFloat.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointFloat.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;

diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointInteger.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointInteger.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;

diff --git a/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointString.java b/src/main/java/com/hms_networks/americas/sc/extensions/datapoint/DataPointString.java
@@ -81,7 +81,7 @@ public boolean equals(DataPoint p) {
    * Compares the data point's value to another data point's value.
    *
    * @param p data point to compare
-   * @return true if values are equal
+   * @return true if data points are of the same type and values are equal
    */
   public boolean valueEquals(DataPoint p) {
     boolean returnVal = false;