explain that preparedred can be null

eclipse-kura · Dec 13, 2023 · b0f209b · b0f209b
1 parent 5baef7d
commit b0f209b
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/driver/Driver.java b/kura/org.eclipse.kura.api/src/main/java/org/eclipse/kura/driver/Driver.java
@@ -230,11 +230,14 @@ public void registerChannelListener(Map<String, Object> channelConfig, ChannelLi
      * If the validation of the channel configuration fails for some channels, the driver must not throw an exception
      * but it is required to return channel records with proper error flags set as a result of the
      * {@link PreparedRead#execute()} call.
+     * 
+     * If the driver does not implement such optimizations, null should be returned.
      *
      * @see PreparedRead
      * @param records
      *            The list of channel records that represent the request to be optimized.
-     * @return The {@link PreparedRead} instance
+     * @return The {@link PreparedRead} instance or null if the driver does not implement any protocol specific 
+     *         optimization.
      * @throws NullPointerException
      *             if the provided list is null
      */