This is an automated email from the ASF dual-hosted git repository.
aokolnychyi pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/main by this push:
new 7cec1d9796 Docs: Fix Javadoc for ManifestFile (#9016)
7cec1d9796 is described below
commit 7cec1d97965a2823878aef17d5c54fc768e8612f
Author: Anton Okolnychyi <[email protected]>
AuthorDate: Thu Nov 9 16:26:11 2023 -0800
Docs: Fix Javadoc for ManifestFile (#9016)
---
.../main/java/org/apache/iceberg/ManifestFile.java | 24 +++++++++-------------
1 file changed, 10 insertions(+), 14 deletions(-)
diff --git a/api/src/main/java/org/apache/iceberg/ManifestFile.java
b/api/src/main/java/org/apache/iceberg/ManifestFile.java
index ee38a6d414..8f20697c77 100644
--- a/api/src/main/java/org/apache/iceberg/ManifestFile.java
+++ b/api/src/main/java/org/apache/iceberg/ManifestFile.java
@@ -25,7 +25,7 @@ import java.nio.ByteBuffer;
import java.util.List;
import org.apache.iceberg.types.Types;
-/** Represents a manifest file that can be scanned to find data files in a
table. */
+/** Represents a manifest file that can be scanned to find files in a table. */
public interface ManifestFile {
Types.NestedField PATH =
required(500, "manifest_path", Types.StringType.get(), "Location URI
with FS scheme");
@@ -141,10 +141,10 @@ public interface ManifestFile {
return addedFilesCount() == null || addedFilesCount() > 0;
}
- /** Returns the number of data files with status ADDED in the manifest file.
*/
+ /** Returns the number of files with status ADDED in the manifest file. */
Integer addedFilesCount();
- /** Returns the total number of rows in all data files with status ADDED in
the manifest file. */
+ /** Returns the total number of rows in all files with status ADDED in the
manifest file. */
Long addedRowsCount();
/**
@@ -156,12 +156,10 @@ public interface ManifestFile {
return existingFilesCount() == null || existingFilesCount() > 0;
}
- /** Returns the number of data files with status EXISTING in the manifest
file. */
+ /** Returns the number of files with status EXISTING in the manifest file. */
Integer existingFilesCount();
- /**
- * Returns the total number of rows in all data files with status EXISTING
in the manifest file.
- */
+ /** Returns the total number of rows in all files with status EXISTING in
the manifest file. */
Long existingRowsCount();
/**
@@ -173,12 +171,10 @@ public interface ManifestFile {
return deletedFilesCount() == null || deletedFilesCount() > 0;
}
- /** Returns the number of data files with status DELETED in the manifest
file. */
+ /** Returns the number of files with status DELETED in the manifest file. */
Integer deletedFilesCount();
- /**
- * Returns the total number of rows in all data files with status DELETED in
the manifest file.
- */
+ /** Returns the total number of rows in all files with status DELETED in the
manifest file. */
Long deletedRowsCount();
/**
@@ -214,12 +210,12 @@ public interface ManifestFile {
return PARTITION_SUMMARY_TYPE;
}
- /** Returns true if at least one data file in the manifest has a null
value for the field. */
+ /** Returns true if at least one file in the manifest has a null value for
the field. */
boolean containsNull();
/**
- * Returns true if at least one data file in the manifest has a NaN value
for the field. Null if
- * this information doesn't exist.
+ * Returns true if at least one file in the manifest has a NaN value for
the field. Null if this
+ * information doesn't exist.
*
* <p>Default to return null to ensure backward compatibility.
*/