You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by cd...@apache.org on 2018/08/02 09:20:15 UTC
[incubator-plc4x] 04/04: Removed the TODOs
This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch JulianFeinauer-s7-communication-documentation
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
commit 4caff3ccedd2f84e550a17490722ac6f7baf7f2a
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Thu Aug 2 11:20:06 2018 +0200
Removed the TODOs
---
.../main/java/org/apache/plc4x/java/api/messages/PlcReadRequest.java | 2 --
.../java/org/apache/plc4x/java/api/messages/items/ReadRequestItem.java | 2 --
.../org/apache/plc4x/java/api/messages/items/ReadResponseItem.java | 1 -
.../java/org/apache/plc4x/java/api/messages/items/RequestItem.java | 1 +
.../plc4x/java/api/messages/specific/TypeSafePlcReadRequest.java | 2 --
.../src/main/java/org/apache/plc4x/java/s7/netty/Plc4XS7Protocol.java | 2 --
.../apache/plc4x/java/s7/netty/model/messages/S7RequestMessage.java | 1 +
.../java/org/apache/plc4x/java/s7/netty/model/params/VarParameter.java | 3 ---
8 files changed, 2 insertions(+), 12 deletions(-)
diff --git a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcReadRequest.java b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcReadRequest.java
index 456f1f3..a190e5d 100644
--- a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcReadRequest.java
+++ b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/PlcReadRequest.java
@@ -35,8 +35,6 @@ import java.util.Objects;
*
* Provides a builder for object construction through {@link PlcReadRequest#builder()}.
*
- * TODO 01.08.2018 jf: Can we make constructors private and force users to use the Builder to enforce immutability?
- *
* @see TypeSafePlcReadRequest
*/
public class PlcReadRequest extends PlcRequest<ReadRequestItem<?>> {
diff --git a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/ReadRequestItem.java b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/ReadRequestItem.java
index 3f4f68e..c88e1d9 100644
--- a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/ReadRequestItem.java
+++ b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/ReadRequestItem.java
@@ -64,8 +64,6 @@ public class ReadRequestItem<T> extends RequestItem<T> {
return false;
}
ReadRequestItem<?> that = (ReadRequestItem<?>) o;
- // TODO 01.18.18 jf: we should also call the comparison of super at least otherwise this can lead to unwanted behavior.
- // Perhaps we should generate a UUID or something for each ReadRequest to have a good equality comparison
return size == that.size;
}
diff --git a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/ReadResponseItem.java b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/ReadResponseItem.java
index 97cb36e..789d832 100644
--- a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/ReadResponseItem.java
+++ b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/ReadResponseItem.java
@@ -66,7 +66,6 @@ public class ReadResponseItem<T> extends ResponseItem<ReadRequestItem<T>> {
return false;
}
ReadResponseItem<?> that = (ReadResponseItem<?>) o;
- // TODO 01.08.18 jf: should we also use a UUID here or at least a check for equal request as this could lead to effects due to unwanted equality (same for hashCode).
return Objects.equals(values, that.values);
}
diff --git a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/RequestItem.java b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/RequestItem.java
index 94b53cc..390ef5d 100644
--- a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/RequestItem.java
+++ b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/items/RequestItem.java
@@ -24,6 +24,7 @@ import java.util.Objects;
/**
* Wrapper Object to encapsulate an {@link Address} and the expected datatype as {@link Class}.
+ *
* @param <DATA_TYPE> Generic Type of data at address
*/
public abstract class RequestItem<DATA_TYPE> {
diff --git a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/specific/TypeSafePlcReadRequest.java b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/specific/TypeSafePlcReadRequest.java
index d1101d5..3c3d20d 100644
--- a/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/specific/TypeSafePlcReadRequest.java
+++ b/plc4j/api/src/main/java/org/apache/plc4x/java/api/messages/specific/TypeSafePlcReadRequest.java
@@ -32,8 +32,6 @@ import java.util.Optional;
*
* Can be constructed using the {@link PlcReadRequest#builder()} method.
*
- * TODO 01.08.18 jf: Could we hide constructors from users and enforce usage of the PlcReadRequest.builder?
- *
* @param <T> Type of the {@link Class} of requested values
*/
public class TypeSafePlcReadRequest<T> extends PlcReadRequest {
diff --git a/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/Plc4XS7Protocol.java b/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/Plc4XS7Protocol.java
index 05163f8..64d66df 100644
--- a/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/Plc4XS7Protocol.java
+++ b/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/Plc4XS7Protocol.java
@@ -58,8 +58,6 @@ import static org.apache.plc4x.java.s7.netty.util.S7TypeEncoder.encodeData;
* This layer transforms between {@link PlcRequestContainer}s {@link S7Message}s.
* And stores all "in-flight" requests in an internal structure ({@link Plc4XS7Protocol#requests}).
*
- * TODO 01.08.18, jf: is a Cleanup of the requests map necessary? Can it occur that for a request no response is generated that leads to success or failure?
- *
* While sending a request, a {@link S7RequestMessage} is generated and send downstream (to the {@link S7Protocol}.
*
* When a {@link S7ResponseMessage} is received it takes the existing request container from its Map and finishes
diff --git a/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/model/messages/S7RequestMessage.java b/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/model/messages/S7RequestMessage.java
index b769ab4..b3f567c 100644
--- a/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/model/messages/S7RequestMessage.java
+++ b/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/model/messages/S7RequestMessage.java
@@ -27,6 +27,7 @@ import java.util.List;
/**
* Container Object for Requests to S7 which additionally stores information if the request was acknowledged (by the PLC?).
+ *
* @see S7Message for the other attributes.
*/
public class S7RequestMessage extends S7Message {
diff --git a/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/model/params/VarParameter.java b/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/model/params/VarParameter.java
index b76d57f..e0b18aa 100644
--- a/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/model/params/VarParameter.java
+++ b/plc4j/protocols/s7/src/main/java/org/apache/plc4x/java/s7/netty/model/params/VarParameter.java
@@ -19,7 +19,6 @@ under the License.
package org.apache.plc4x.java.s7.netty.model.params;
import org.apache.plc4x.java.s7.netty.model.params.items.VarParameterItem;
-import org.apache.plc4x.java.s7.netty.model.payloads.VarPayload;
import org.apache.plc4x.java.s7.netty.model.types.ParameterType;
import java.util.List;
@@ -28,8 +27,6 @@ import java.util.List;
* "Command" Message to inform PLC of wanted operation.
* Also contains {@link VarParameter#items} that hold detailed information on the "Command", e.g.,
* addresses to read or to write to.
- *
- * TODO 01.08.18 jf: Could this be renamed to Something like Command as this seems to be the command message pattern?
*/
public class VarParameter implements S7Parameter {