You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2018/10/18 12:22:53 UTC
[incubator-plc4x] branch master updated (58cfc35 -> d94b11c)
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git.
from 58cfc35 Merge remote-tracking branch 'github/master'
new 2583252 [Modbus] remove side effects from getter calls. simplfy array aggregation
new d94b11c [Modbus] remove validation on reading by avoiding supplying of null items in the first place.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../messages/items/DefaultByteArrayFieldItem.java | 5 +
.../items/DefaultModbusByteArrayFieldItem.java | 141 +++++++++------------
2 files changed, 65 insertions(+), 81 deletions(-)
[incubator-plc4x] 02/02: [Modbus] remove validation on reading by
avoiding supplying of null items in the first place.
Posted by sr...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
commit d94b11c093e323e43eb7ad938caf9a039e44f443
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Thu Oct 18 12:21:17 2018 +0200
[Modbus] remove validation on reading by avoiding supplying of null items in the first place.
---
.../messages/items/DefaultByteArrayFieldItem.java | 5 +++++
.../items/DefaultModbusByteArrayFieldItem.java | 25 +++-------------------
2 files changed, 8 insertions(+), 22 deletions(-)
diff --git a/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/messages/items/DefaultByteArrayFieldItem.java b/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/messages/items/DefaultByteArrayFieldItem.java
index 078422d..0aeac4f 100644
--- a/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/messages/items/DefaultByteArrayFieldItem.java
+++ b/plc4j/protocols/driver-bases/base/src/main/java/org/apache/plc4x/java/base/messages/items/DefaultByteArrayFieldItem.java
@@ -18,10 +18,15 @@ under the License.
*/
package org.apache.plc4x.java.base.messages.items;
+import java.util.Objects;
+
public class DefaultByteArrayFieldItem extends FieldItem<Byte[]> {
public DefaultByteArrayFieldItem(Byte[]... values) {
super(values);
+ for (Byte[] value : values) {
+ Objects.requireNonNull(value);
+ }
}
@Override
diff --git a/plc4j/protocols/modbus/src/main/java/org/apache/plc4x/java/modbus/messages/items/DefaultModbusByteArrayFieldItem.java b/plc4j/protocols/modbus/src/main/java/org/apache/plc4x/java/modbus/messages/items/DefaultModbusByteArrayFieldItem.java
index 27a2cd2..4b3002f 100644
--- a/plc4j/protocols/modbus/src/main/java/org/apache/plc4x/java/modbus/messages/items/DefaultModbusByteArrayFieldItem.java
+++ b/plc4j/protocols/modbus/src/main/java/org/apache/plc4x/java/modbus/messages/items/DefaultModbusByteArrayFieldItem.java
@@ -65,8 +65,7 @@ public class DefaultModbusByteArrayFieldItem extends DefaultByteArrayFieldItem {
@Override
public boolean isValidShort(int index) {
- return this.completeByteArray.length >= shortIndexToByteIndex(index) + SHORT_BYTES &&
- validateByteValues(shortIndexToByteIndex(index), SHORT_BYTES);
+ return this.completeByteArray.length >= shortIndexToByteIndex(index) + SHORT_BYTES;
}
@Override
@@ -104,8 +103,7 @@ public class DefaultModbusByteArrayFieldItem extends DefaultByteArrayFieldItem {
@Override
public boolean isValidInteger(int index) {
- return this.completeByteArray.length >= intIndexToByteIndex(index) + INTEGER_BYTES &&
- validateByteValues(intIndexToByteIndex(index), INTEGER_BYTES);
+ return this.completeByteArray.length >= intIndexToByteIndex(index) + INTEGER_BYTES;
}
@Override
@@ -143,8 +141,7 @@ public class DefaultModbusByteArrayFieldItem extends DefaultByteArrayFieldItem {
@Override
public boolean isValidLong(int index) {
- return this.completeByteArray.length >= longIndexToByteIndex(index) + LONG_BYTES &&
- validateByteValues(longIndexToByteIndex(index), LONG_BYTES);
+ return this.completeByteArray.length >= longIndexToByteIndex(index) + LONG_BYTES;
}
@Override
@@ -181,22 +178,6 @@ public class DefaultModbusByteArrayFieldItem extends DefaultByteArrayFieldItem {
}
/**
- * validates if requested bytes contain only non-null values
- *
- * @param startIndex index of the first byte requested
- * @param length amount of subsequent bytes
- * @return true if requested values are not-null, false otherwise
- */
- private boolean validateByteValues(int startIndex, int length) {
- for (int byteIndex = startIndex; byteIndex < startIndex + length; byteIndex++) {
- if (this.completeByteArray[byteIndex] == null) {
- return false;
- }
- }
- return true;
- }
-
- /**
* returns a subarray with the wanted index first
*
* @param index start-index of wanted value
[incubator-plc4x] 01/02: [Modbus] remove side effects from getter
calls. simplfy array aggregation
Posted by sr...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
commit 2583252434f153b427afda1cb06dca3323ddf059
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Thu Oct 18 12:14:54 2018 +0200
[Modbus] remove side effects from getter calls.
simplfy array aggregation
---
.../items/DefaultModbusByteArrayFieldItem.java | 142 ++++++++++-----------
1 file changed, 70 insertions(+), 72 deletions(-)
diff --git a/plc4j/protocols/modbus/src/main/java/org/apache/plc4x/java/modbus/messages/items/DefaultModbusByteArrayFieldItem.java b/plc4j/protocols/modbus/src/main/java/org/apache/plc4x/java/modbus/messages/items/DefaultModbusByteArrayFieldItem.java
index 963a493..27a2cd2 100644
--- a/plc4j/protocols/modbus/src/main/java/org/apache/plc4x/java/modbus/messages/items/DefaultModbusByteArrayFieldItem.java
+++ b/plc4j/protocols/modbus/src/main/java/org/apache/plc4x/java/modbus/messages/items/DefaultModbusByteArrayFieldItem.java
@@ -23,9 +23,8 @@ import org.apache.plc4x.java.base.messages.items.DefaultByteArrayFieldItem;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
-import java.util.ArrayList;
import java.util.Arrays;
-import java.util.List;
+import java.util.stream.Stream;
/**
* default implementation for DefaultByteArrayFieldItem for Usage within Modbus module
@@ -45,7 +44,7 @@ public class DefaultModbusByteArrayFieldItem extends DefaultByteArrayFieldItem {
public DefaultModbusByteArrayFieldItem(Byte[]... values) {
super(values);
this.byteOrder = DEFAULT_ENDIANNESS;
- this.completeByteArray = getCompleteByteArray();
+ this.completeByteArray = Arrays.stream(getValues()).flatMap(Stream::of).toArray(Byte[]::new);
}
@Override
@@ -66,127 +65,131 @@ public class DefaultModbusByteArrayFieldItem extends DefaultByteArrayFieldItem {
@Override
public boolean isValidShort(int index) {
- return this.completeByteArray.length>=shortIndexToByteIndex(index)+SHORT_BYTES &&
- validateByteValues(shortIndexToByteIndex(index),SHORT_BYTES);
+ return this.completeByteArray.length >= shortIndexToByteIndex(index) + SHORT_BYTES &&
+ validateByteValues(shortIndexToByteIndex(index), SHORT_BYTES);
}
@Override
public Short getShort(int index) {
- if(isValidShort(index)){
- return ByteBuffer
- .wrap(ArrayUtils.toPrimitive(getByteArrayFromIndex(shortIndexToByteIndex(index))))
- .order(this.byteOrder)
- .getShort();
- }
- return null;
+ return getShort(index, this.byteOrder);
}
/**
* returns the short result for the given index with explicit chose of ByteOrder
- * @param index index in relation to the requested data-type (here Short), see comment of regarding index-transformation
+ *
+ * @param index index in relation to the requested data-type (here Short), see comment of regarding index-transformation
* @param byteOrder byte-order used for decoding of byte-array
* @return resulting short value if valid data is given, null otherwise
*/
- public Short getShort(int index, ByteOrder byteOrder){
- this.byteOrder = byteOrder;
- return getShort(index);
+ public Short getShort(int index, ByteOrder byteOrder) {
+ if (!isValidShort(index)) {
+ return null;
+ }
+ return ByteBuffer
+ .wrap(ArrayUtils.toPrimitive(getByteArrayFromIndex(shortIndexToByteIndex(index))))
+ .order(byteOrder)
+ .getShort();
}
/**
* converts the starting index of a short array to source type Byte
* e.g. user wants to request the 2nd long value --> index=1 --> byteIndex=2
+ *
* @param shortIndex index from users view
* @return resulting byteArrayIndex
*/
- private static int shortIndexToByteIndex(int shortIndex){
- return shortIndex*SHORT_BYTES;
+ private static int shortIndexToByteIndex(int shortIndex) {
+ return shortIndex * SHORT_BYTES;
}
@Override
public boolean isValidInteger(int index) {
- return this.completeByteArray.length>=intIndexToByteIndex(index)+INTEGER_BYTES &&
- validateByteValues(intIndexToByteIndex(index),INTEGER_BYTES);
+ return this.completeByteArray.length >= intIndexToByteIndex(index) + INTEGER_BYTES &&
+ validateByteValues(intIndexToByteIndex(index), INTEGER_BYTES);
}
@Override
public Integer getInteger(int index) {
- if(isValidInteger(index)){
- return ByteBuffer
- .wrap(ArrayUtils.toPrimitive(getByteArrayFromIndex(intIndexToByteIndex(index))))
- .order(this.byteOrder)
- .getInt();
- }
- return null;
+ return getInteger(index, this.byteOrder);
}
/**
* returns the int result for the given index with explicit chose of ByteOrder
- * @param index index in relation to the requested data-type (here Integer), see comment of regarding index-transformation
+ *
+ * @param index index in relation to the requested data-type (here Integer), see comment of regarding index-transformation
* @param byteOrder byte-order used for decoding of byte-array
* @return resulting short value if valid data is given, null otherwise
*/
- public Integer getInteger(int index, ByteOrder byteOrder){
- this.byteOrder = byteOrder;
- return getInteger(index);
+ public Integer getInteger(int index, ByteOrder byteOrder) {
+ if (!isValidInteger(index)) {
+ return null;
+ }
+ return ByteBuffer
+ .wrap(ArrayUtils.toPrimitive(getByteArrayFromIndex(intIndexToByteIndex(index))))
+ .order(byteOrder)
+ .getInt();
}
/**
* converts the starting index of an int array to source type Byte
* e.g. user wants to request the 4th integer value --> index=3 --> byteIndex=12
+ *
* @param intIndex index from users view
* @return resulting byteArrayIndex
*/
- private static int intIndexToByteIndex(int intIndex){
- return intIndex*INTEGER_BYTES;
+ private static int intIndexToByteIndex(int intIndex) {
+ return intIndex * INTEGER_BYTES;
}
@Override
public boolean isValidLong(int index) {
- return this.completeByteArray.length>=longIndexToByteIndex(index)+LONG_BYTES &&
- validateByteValues(longIndexToByteIndex(index),LONG_BYTES);
+ return this.completeByteArray.length >= longIndexToByteIndex(index) + LONG_BYTES &&
+ validateByteValues(longIndexToByteIndex(index), LONG_BYTES);
}
@Override
public Long getLong(int index) {
- if(isValidLong(index)){
- return ByteBuffer
- .wrap(ArrayUtils.toPrimitive(getByteArrayFromIndex(longIndexToByteIndex(index))))
- .order(this.byteOrder)
- .getLong();
- }
- return null;
+ return getLong(index, this.byteOrder);
}
/**
* returns the long result for the given index with explicit chose of ByteOrder
- * @param index index in relation to the requested data-type (here Long), see comment of regarding index-transformation
+ *
+ * @param index index in relation to the requested data-type (here Long), see comment of regarding index-transformation
* @param byteOrder byte-order used for decoding of byte-array
* @return resulting short value if valid data is given, null otherwise
*/
- public Long getLong(int index,ByteOrder byteOrder) {
- this.byteOrder = byteOrder;
- return getLong(index);
+ public Long getLong(int index, ByteOrder byteOrder) {
+ if (!isValidLong(index)) {
+ return null;
+ }
+ return ByteBuffer
+ .wrap(ArrayUtils.toPrimitive(getByteArrayFromIndex(longIndexToByteIndex(index))))
+ .order(byteOrder)
+ .getLong();
}
/**
* converts the starting index of a long array to source type Byte
* e.g. user wants to request the 3rd long value --> index=2 --> byteIndex=16
+ *
* @param longIndex index from users view
* @return resulting byteArrayIndex
*/
- private static int longIndexToByteIndex(int longIndex){
- return longIndex*LONG_BYTES;
+ private static int longIndexToByteIndex(int longIndex) {
+ return longIndex * LONG_BYTES;
}
/**
* validates if requested bytes contain only non-null values
- * @param startIndex index of the first byte requested
- * @param length amount of subsequent bytes
- * @return true if requested values are not-null, false otherwise
+ *
+ * @param startIndex index of the first byte requested
+ * @param length amount of subsequent bytes
+ * @return true if requested values are not-null, false otherwise
*/
- private boolean validateByteValues(int startIndex, int length){
- for(int byteIndex=startIndex; byteIndex<startIndex+length;byteIndex++){
- if(this.completeByteArray[byteIndex]==null){
+ private boolean validateByteValues(int startIndex, int length) {
+ for (int byteIndex = startIndex; byteIndex < startIndex + length; byteIndex++) {
+ if (this.completeByteArray[byteIndex] == null) {
return false;
}
}
@@ -194,34 +197,29 @@ public class DefaultModbusByteArrayFieldItem extends DefaultByteArrayFieldItem {
}
/**
- * derives an ordered byte array from the given values to simplify handling
- * @return the ordered byte array
- */
- private Byte[] getCompleteByteArray(){
- List<Byte> byteList = new ArrayList<>();
- for(int valuesIndex=0;valuesIndex<getNumberOfValues();valuesIndex++){
- byteList.addAll(Arrays.asList(getValue(valuesIndex)));
- }
- return byteList.toArray(new Byte[0]);
- }
-
- /**
* returns a subarray with the wanted index first
+ *
* @param index start-index of wanted value
* @return the sub-array
*/
- private Byte[] getByteArrayFromIndex(int index){
- if(index>this.completeByteArray.length){
+ private Byte[] getByteArrayFromIndex(int index) {
+ if (index > this.completeByteArray.length) {
return new Byte[0];
}
- return Arrays.copyOfRange(this.completeByteArray,index,this.completeByteArray.length);
+ return Arrays.copyOfRange(this.completeByteArray, index, this.completeByteArray.length);
}
@Override
public boolean equals(Object o) {
- if (this == o) return true;
- if (o == null || getClass() != o.getClass()) return false;
- if (!super.equals(o)) return false;
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ if (!super.equals(o)) {
+ return false;
+ }
DefaultModbusByteArrayFieldItem that = (DefaultModbusByteArrayFieldItem) o;
return Arrays.equals(completeByteArray, that.completeByteArray);
}