Skip to content

Commit 7c23d61

Browse files
committed
ORC-2128: Add since Javadoc tags to all public orc-core class/interface/enum
1 parent 41642e3 commit 7c23d61

159 files changed

Lines changed: 281 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

java/core/src/java/org/apache/orc/BinaryColumnStatistics.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
/**
2222
* Statistics for binary columns.
23+
* @since 1.0.0
2324
*/
2425
public interface BinaryColumnStatistics extends ColumnStatistics {
2526
/**

java/core/src/java/org/apache/orc/BooleanColumnStatistics.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
/**
2222
* Statistics for boolean columns.
23+
* @since 1.0.0
2324
*/
2425
public interface BooleanColumnStatistics extends ColumnStatistics {
2526
/**

java/core/src/java/org/apache/orc/CollectionColumnStatistics.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
/**
2222
* Statistics for all of collections such as Map and List.
23+
* @since 1.0.0
2324
*/
2425
public interface CollectionColumnStatistics extends ColumnStatistics {
2526
/**

java/core/src/java/org/apache/orc/ColumnStatistics.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
/**
2222
* Statistics that are available for all types of columns.
23+
* @since 1.0.0
2324
*/
2425
public interface ColumnStatistics {
2526
/**

java/core/src/java/org/apache/orc/CompressionCodec.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
/**
2626
* The API for compression codecs for ORC.
2727
* Closeable.close() returns this codec to the OrcCodecPool.
28+
* @since 1.1.0
2829
*/
2930
public interface CompressionCodec extends Closeable {
3031

java/core/src/java/org/apache/orc/CompressionKind.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/**
2222
* An enumeration that lists the generic compression algorithms that
2323
* can be applied to ORC files.
24+
* @since 1.0.0
2425
*/
2526
public enum CompressionKind {
2627
NONE, ZLIB, SNAPPY, LZO, LZ4, ZSTD, BROTLI

java/core/src/java/org/apache/orc/DataMask.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
* They apply to an individual column (via ColumnVector) instead of a
3030
* VectorRowBatch.
3131
*
32+
* @since 1.5.0
3233
*/
3334
public interface DataMask {
3435

java/core/src/java/org/apache/orc/DataMaskDescription.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
/**
2222
* Information about the DataMask used to mask the unencrypted data.
23+
* @since 1.0.0
2324
*/
2425
public interface DataMaskDescription {
2526

java/core/src/java/org/apache/orc/DataReader.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
import java.nio.ByteBuffer;
2626

2727
/** An abstract data reader that IO formats can use to read bytes from underlying storage. */
28+
/**
29+
* @since 1.1.0
30+
*/
2831
public interface DataReader extends AutoCloseable, Cloneable {
2932

3033
/** Opens the DataReader, making it ready to use. */

java/core/src/java/org/apache/orc/DateColumnStatistics.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
/**
2525
* Statistics for DATE columns.
26+
* @since 1.0.0
2627
*/
2728
public interface DateColumnStatistics extends ColumnStatistics {
2829

0 commit comments

Comments
 (0)