[orc] branch branch-1.7 updated: ORC-952: Add `since` tag to `org.apache.orc.RecordReader` interface (#865)

[do...@apache.org]

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

dongjoon pushed a commit to branch branch-1.7
in repository https://gitbox.apache.org/repos/asf/orc.git


The following commit(s) were added to refs/heads/branch-1.7 by this push:
     new 6d14f59  ORC-952: Add `since` tag to `org.apache.orc.RecordReader` interface (#865)
6d14f59 is described below

commit 6d14f59fb3ab4a98b5107236e2c2b5040e1a0287
Author: Dongjoon Hyun <do...@apache.org>
AuthorDate: Sun Aug 15 17:15:02 2021 -0700

    ORC-952: Add `since` tag to `org.apache.orc.RecordReader` interface (#865)
    
    ### What changes were proposed in this pull request?
    
    This PR aims to add `since` tag to `org.apache.orc.Reader` interface.
    
    ### Why are the changes needed?
    
    To help ORC developers to check the API availability easily by improving code and Javadoc.
    
    ### How was this patch tested?
    
    Manual
    
    (cherry picked from commit daa57f8d349f7c6d5713f3333c6a11240040a55b)
    Signed-off-by: Dongjoon Hyun <do...@apache.org>
---
 java/core/src/java/org/apache/orc/RecordReader.java | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/java/core/src/java/org/apache/orc/RecordReader.java b/java/core/src/java/org/apache/orc/RecordReader.java
index 5b57135..dbd0c84 100644
--- a/java/core/src/java/org/apache/orc/RecordReader.java
+++ b/java/core/src/java/org/apache/orc/RecordReader.java
@@ -24,6 +24,7 @@ import java.io.IOException;
 
 /**
  * A row-by-row iterator for ORC files.
+ * @since 1.1.0
  */
 public interface RecordReader extends Closeable {
   /**
@@ -34,6 +35,7 @@ public interface RecordReader extends Closeable {
    * @param batch a row batch object to read into
    * @return were more rows available to read?
    * @throws java.io.IOException
+   * @since 1.1.0
    */
   boolean nextBatch(VectorizedRowBatch batch) throws IOException;
 
@@ -42,6 +44,7 @@ public interface RecordReader extends Closeable {
    * call to next().
    * @return the row number from 0 to the number of rows in the file
    * @throws java.io.IOException
+   * @since 1.1.0
    */
   long getRowNumber() throws IOException;
 
@@ -49,18 +52,21 @@ public interface RecordReader extends Closeable {
    * Get the progress of the reader through the rows.
    * @return a fraction between 0.0 and 1.0 of rows read
    * @throws java.io.IOException
+   * @since 1.1.0
    */
   float getProgress() throws IOException;
 
   /**
    * Release the resources associated with the given reader.
    * @throws java.io.IOException
+   * @since 1.1.0
    */
   @Override
   void close() throws IOException;
 
   /**
    * Seek to a particular row number.
+   * @since 1.1.0
    */
   void seekToRow(long rowCount) throws IOException;
 }