[orc] branch main updated: ORC-953: Add `since` tag to `org.apache.orc.Writer` interface (#866)

[wi...@apache.org]

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

william pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/orc.git


The following commit(s) were added to refs/heads/main by this push:
     new 9f51d36  ORC-953: Add `since` tag to `org.apache.orc.Writer` interface (#866)
9f51d36 is described below

commit 9f51d365c0af51ff9cbb5adeb4203387f1ea7a50
Author: Dongjoon Hyun <do...@apache.org>
AuthorDate: Sun Aug 15 17:14:31 2021 -0700

    ORC-953: Add `since` tag to `org.apache.orc.Writer` interface (#866)
    
    ### What changes were proposed in this pull request?
    
    This PR aims to add `since` tag to `org.apache.orc.Writer` 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.
---
 java/core/src/java/org/apache/orc/Writer.java | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/java/core/src/java/org/apache/orc/Writer.java b/java/core/src/java/org/apache/orc/Writer.java
index 3ce5899..0f8e76e 100644
--- a/java/core/src/java/org/apache/orc/Writer.java
+++ b/java/core/src/java/org/apache/orc/Writer.java
@@ -27,12 +27,14 @@ import java.util.List;
 
 /**
  * The interface for writing ORC files.
+ * @since 1.1.0
  */
 public interface Writer extends Closeable {
 
   /**
    * Get the schema for this writer
    * @return the file schema
+   * @since 1.1.0
    */
   TypeDescription getSchema();
 
@@ -42,12 +44,14 @@ public interface Writer extends Closeable {
    * second value will replace the first.
    * @param key a key to label the data with.
    * @param value the contents of the metadata.
+   * @since 1.1.0
    */
   void addUserMetadata(String key, ByteBuffer value);
 
   /**
    * Add a row batch to the ORC file.
    * @param batch the rows to add
+   * @since 1.1.0
    */
   void addRowBatch(VectorizedRowBatch batch) throws IOException;
 
@@ -55,6 +59,7 @@ public interface Writer extends Closeable {
    * Flush all of the buffers and close the file. No methods on this writer
    * should be called afterwards.
    * @throws IOException
+   * @since 1.1.0
    */
   @Override
   void close() throws IOException;
@@ -65,6 +70,7 @@ public interface Writer extends Closeable {
    * after closing the writer.
    *
    * @return raw data size
+   * @since 1.1.0
    */
   long getRawDataSize();
 
@@ -74,6 +80,7 @@ public interface Writer extends Closeable {
    * closing the writer.
    *
    * @return row count
+   * @since 1.1.0
    */
   long getNumberOfRows();
 
@@ -81,6 +88,7 @@ public interface Writer extends Closeable {
    * Write an intermediate footer on the file such that if the file is
    * truncated to the returned offset, it would be a valid ORC file.
    * @return the offset that would be a valid end location for an ORC file
+   * @since 1.1.0
    */
   long writeIntermediateFooter() throws IOException;
 
@@ -100,6 +108,7 @@ public interface Writer extends Closeable {
    * @param length - length of stripe within byte array
    * @param stripeInfo - stripe information
    * @param stripeStatistics - unencrypted stripe statistics
+   * @since 1.1.0
    */
   void appendStripe(byte[] stripe, int offset, int length,
       StripeInformation stripeInfo,
@@ -118,6 +127,7 @@ public interface Writer extends Closeable {
    * @param stripeStatistics - stripe statistics with the last one being
    *                         for the unencrypted data and the others being for
    *                         each encryption variant.
+   * @since 1.6.0
    */
   void appendStripe(byte[] stripe, int offset, int length,
                     StripeInformation stripeInfo,
@@ -127,6 +137,7 @@ public interface Writer extends Closeable {
    * Update the current user metadata with a list of new values.
    * @param userMetadata - user metadata
    * @deprecated use {@link #addUserMetadata(String, ByteBuffer)} instead
+   * @since 1.1.0
    */
   void appendUserMetadata(List<OrcProto.UserMetadataItem> userMetadata);
 
@@ -139,6 +150,7 @@ public interface Writer extends Closeable {
    * be used judiciously.
    *
    * @return the information about the column
+   * @since 1.1.0
    */
   ColumnStatistics[] getStatistics() throws IOException;
 
@@ -150,6 +162,7 @@ public interface Writer extends Closeable {
    *
    * @return stripe information
    * @throws IOException
+   * @since 1.6.8
    */
   List<StripeInformation> getStripes() throws IOException;
 }