[nifi] branch master updated: NIFI-6089 Improve javadoc for newly added inputLength argument in RecordReaderFactory

[bb...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

bbende pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nifi.git


The following commit(s) were added to refs/heads/master by this push:
     new 6731e4c  NIFI-6089 Improve javadoc for newly added inputLength argument in RecordReaderFactory
6731e4c is described below

commit 6731e4c8eeee69e518362839e470274c90b58a5b
Author: Bryan Bende <bb...@apache.org>
AuthorDate: Wed Sep 4 11:49:19 2019 -0400

    NIFI-6089 Improve javadoc for newly added inputLength argument in RecordReaderFactory
---
 .../main/java/org/apache/nifi/serialization/RecordReaderFactory.java  | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-serialization-service-api/src/main/java/org/apache/nifi/serialization/RecordReaderFactory.java b/nifi-nar-bundles/nifi-standard-services/nifi-record-serialization-service-api/src/main/java/org/apache/nifi/serialization/RecordReaderFactory.java
index c743ba6..f86541a 100644
--- a/nifi-nar-bundles/nifi-standard-services/nifi-record-serialization-service-api/src/main/java/org/apache/nifi/serialization/RecordReaderFactory.java
+++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-serialization-service-api/src/main/java/org/apache/nifi/serialization/RecordReaderFactory.java
@@ -68,7 +68,9 @@ public interface RecordReaderFactory extends ControllerService {
      * @param variables A map containing variables which is used to resolve the Record Schema dynamically via Expression Language.
      *                 This can be null or empty.
      * @param in InputStream containing Records.
-     * @param inputLength the length of the content to read from the InputStream in bytes, a negative value indicates an unknown or unbound size
+     * @param inputLength A hint about the length of the content to read from the InputStream. This value is specified in bytes and a negative value indicates
+     *                    an unknown or unbound size. Some reader implementations must be able to seek to the end of the InputStream and will require knowing the length.
+     *                    Other implementations may be ignore this hint and may read the entire InputStream.
      * @param logger A logger bound to a component
      *
      * @return Created RecordReader instance