This is an automated email from the ASF dual-hosted git repository.
dongjoon 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 466f2f1d2 ORC-1977: Add `Deprecated` annotations for all deprecated
APIs
466f2f1d2 is described below
commit 466f2f1d2eec1db25fe58ec0c57024208be0e9a1
Author: Dongjoon Hyun <[email protected]>
AuthorDate: Thu Aug 28 11:17:55 2025 -0700
ORC-1977: Add `Deprecated` annotations for all deprecated APIs
### What changes were proposed in this pull request?
This PR aims to add `Deprecated` annotations for all deprecated APIs.
### Why are the changes needed?
To improve the visibility of deprecations. Currently, only Javadoc informs
the deprecation for these APIs.
**BEFORE**
```
$ mvn clean package -DskipTests | grep Deprecated | wc -l
15
```
**AFTER**
```
$ mvn clean package -DskipTests | grep Deprecated | wc -l
0
```
### How was this patch tested?
Pass the CIs.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #2365 from dongjoon-hyun/ORC-1977.
Authored-by: Dongjoon Hyun <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
---
java/core/src/java/org/apache/orc/DateColumnStatistics.java | 2 ++
java/core/src/java/org/apache/orc/FileMetadata.java | 1 +
java/core/src/java/org/apache/orc/MemoryManager.java | 1 +
java/core/src/java/org/apache/orc/OrcFile.java | 1 +
java/core/src/java/org/apache/orc/Reader.java | 3 +++
java/core/src/java/org/apache/orc/Writer.java | 1 +
java/core/src/java/org/apache/orc/impl/MemoryManagerImpl.java | 1 +
java/core/src/java/org/apache/orc/impl/OrcTail.java | 1 +
java/core/src/java/org/apache/orc/impl/ReaderImpl.java | 3 +++
java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java | 1 +
10 files changed, 15 insertions(+)
diff --git a/java/core/src/java/org/apache/orc/DateColumnStatistics.java
b/java/core/src/java/org/apache/orc/DateColumnStatistics.java
index 564037645..f6d22af28 100644
--- a/java/core/src/java/org/apache/orc/DateColumnStatistics.java
+++ b/java/core/src/java/org/apache/orc/DateColumnStatistics.java
@@ -54,6 +54,7 @@ public interface DateColumnStatistics extends
ColumnStatistics {
* @return minimum value
* @deprecated Use #getMinimumLocalDate instead
*/
+ @Deprecated
Date getMinimum();
/**
@@ -61,5 +62,6 @@ public interface DateColumnStatistics extends
ColumnStatistics {
* @return maximum value
* @deprecated Use #getMaximumLocalDate instead
*/
+ @Deprecated
Date getMaximum();
}
diff --git a/java/core/src/java/org/apache/orc/FileMetadata.java
b/java/core/src/java/org/apache/orc/FileMetadata.java
index f8b054fb0..9a927b94e 100644
--- a/java/core/src/java/org/apache/orc/FileMetadata.java
+++ b/java/core/src/java/org/apache/orc/FileMetadata.java
@@ -26,6 +26,7 @@ import java.util.List;
* ORC stop depending on them too. Luckily, they shouldn't be very big.
* @deprecated Use {@link org.apache.orc.impl.OrcTail} instead
*/
+@Deprecated
public interface FileMetadata {
boolean isOriginalFormat();
diff --git a/java/core/src/java/org/apache/orc/MemoryManager.java
b/java/core/src/java/org/apache/orc/MemoryManager.java
index 40eb19cbc..fa478b477 100644
--- a/java/core/src/java/org/apache/orc/MemoryManager.java
+++ b/java/core/src/java/org/apache/orc/MemoryManager.java
@@ -65,6 +65,7 @@ public interface MemoryManager {
* @throws IOException
* @deprecated Use {@link MemoryManager#checkMemory} instead
*/
+ @Deprecated
void addedRow(int rows) throws IOException;
/**
diff --git a/java/core/src/java/org/apache/orc/OrcFile.java
b/java/core/src/java/org/apache/orc/OrcFile.java
index 160aaf1f9..2daba452c 100644
--- a/java/core/src/java/org/apache/orc/OrcFile.java
+++ b/java/core/src/java/org/apache/orc/OrcFile.java
@@ -357,6 +357,7 @@ public class OrcFile {
/**
* @deprecated Use {@link #orcTail(OrcTail)} instead.
*/
+ @Deprecated
public ReaderOptions fileMetadata(final FileMetadata metadata) {
fileMetadata = metadata;
return this;
diff --git a/java/core/src/java/org/apache/orc/Reader.java
b/java/core/src/java/org/apache/orc/Reader.java
index aac9bd77f..4c7218f50 100644
--- a/java/core/src/java/org/apache/orc/Reader.java
+++ b/java/core/src/java/org/apache/orc/Reader.java
@@ -145,6 +145,7 @@ public interface Reader extends Closeable {
* @deprecated use getSchema instead
* @since 1.1.0
*/
+ @Deprecated
List<OrcProto.Type> getTypes();
/**
@@ -756,6 +757,7 @@ public interface Reader extends Closeable {
* @deprecated Use {@link #getStripeStatistics()} instead.
* @since 1.1.0
*/
+ @Deprecated
List<OrcProto.StripeStatistics> getOrcProtoStripeStatistics();
/**
@@ -779,6 +781,7 @@ public interface Reader extends Closeable {
* @deprecated Use {@link #getStatistics()} instead.
* @since 1.1.0
*/
+ @Deprecated
List<OrcProto.ColumnStatistics> getOrcProtoFileStatistics();
/**
diff --git a/java/core/src/java/org/apache/orc/Writer.java
b/java/core/src/java/org/apache/orc/Writer.java
index b63c9c86d..7e0621239 100644
--- a/java/core/src/java/org/apache/orc/Writer.java
+++ b/java/core/src/java/org/apache/orc/Writer.java
@@ -139,6 +139,7 @@ public interface Writer extends Closeable {
* @deprecated use {@link #addUserMetadata(String, ByteBuffer)} instead
* @since 1.1.0
*/
+ @Deprecated
void appendUserMetadata(List<OrcProto.UserMetadataItem> userMetadata);
/**
diff --git a/java/core/src/java/org/apache/orc/impl/MemoryManagerImpl.java
b/java/core/src/java/org/apache/orc/impl/MemoryManagerImpl.java
index 0a1f8efae..cb06e7fd9 100644
--- a/java/core/src/java/org/apache/orc/impl/MemoryManagerImpl.java
+++ b/java/core/src/java/org/apache/orc/impl/MemoryManagerImpl.java
@@ -134,6 +134,7 @@ public class MemoryManagerImpl implements MemoryManager {
* Obsolete method left for Hive, which extends this class.
* @deprecated remove this method
*/
+ @Deprecated
public void notifyWriters() throws IOException {
// PASS
}
diff --git a/java/core/src/java/org/apache/orc/impl/OrcTail.java
b/java/core/src/java/org/apache/orc/impl/OrcTail.java
index 9297f953c..be0d8ffd3 100644
--- a/java/core/src/java/org/apache/orc/impl/OrcTail.java
+++ b/java/core/src/java/org/apache/orc/impl/OrcTail.java
@@ -207,6 +207,7 @@ public final class OrcTail {
* @return the stripe statistics
* @deprecated the user should use Reader.getStripeStatistics instead.
*/
+ @Deprecated
public List<StripeStatistics> getStripeStatistics() throws IOException {
if (reader == null) {
LOG.warn("Please use Reader.getStripeStatistics or give `Reader` to
OrcTail constructor.");
diff --git a/java/core/src/java/org/apache/orc/impl/ReaderImpl.java
b/java/core/src/java/org/apache/orc/impl/ReaderImpl.java
index 9e018157f..f1c6b146b 100644
--- a/java/core/src/java/org/apache/orc/impl/ReaderImpl.java
+++ b/java/core/src/java/org/apache/orc/impl/ReaderImpl.java
@@ -480,6 +480,7 @@ public class ReaderImpl implements Reader {
* @param buffer the tail of the file
* @deprecated Use {@link ReaderImpl#ensureOrcFooter(FSDataInputStream,
Path, int, ByteBuffer)} instead.
*/
+ @Deprecated
protected static void ensureOrcFooter(ByteBuffer buffer, int psLen) throws
IOException {
int magicLength = OrcFile.MAGIC.length();
int fullLength = magicLength + 1;
@@ -717,6 +718,7 @@ public class ReaderImpl implements Reader {
* @deprecated Use {@link ReaderImpl#extractFileTail(FileSystem, Path,
long)} instead.
* This is for backward compatibility.
*/
+ @Deprecated
public static OrcTail extractFileTail(ByteBuffer buffer)
throws IOException {
return extractFileTail(buffer, -1,-1);
@@ -738,6 +740,7 @@ public class ReaderImpl implements Reader {
* @deprecated Use {@link ReaderImpl#extractFileTail(FileSystem, Path,
long)} instead.
* This is for backward compatibility.
*/
+ @Deprecated
public static OrcTail extractFileTail(ByteBuffer buffer, long fileLen, long
modificationTime)
throws IOException {
OrcProto.PostScript ps;
diff --git a/java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java
b/java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java
index 5bd980925..b2120db86 100644
--- a/java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java
+++ b/java/core/src/java/org/apache/orc/impl/RecordReaderImpl.java
@@ -1119,6 +1119,7 @@ public class RecordReaderImpl implements RecordReader {
/**
* @deprecated Use the constructor having full parameters. This exists for
backward compatibility.
*/
+ @Deprecated
public SargApplier(SearchArgument sarg,
long rowIndexStride,
SchemaEvolution evolution,
