Skip to content

Commit

Permalink
Docs: Fix Javadoc for ManifestFile (apache#9016)
Browse files Browse the repository at this point in the history
  • Loading branch information
aokolnychyi authored Nov 10, 2023
1 parent 255986a commit 7cec1d9
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions api/src/main/java/org/apache/iceberg/ManifestFile.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
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");
Expand Down Expand Up @@ -141,10 +141,10 @@ default boolean hasAddedFiles() {
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();

/**
Expand All @@ -156,12 +156,10 @@ default boolean hasExistingFiles() {
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();

/**
Expand All @@ -173,12 +171,10 @@ default boolean hasDeletedFiles() {
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();

/**
Expand Down Expand Up @@ -214,12 +210,12 @@ static Types.StructType getType() {
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.
*/
Expand Down

0 comments on commit 7cec1d9

Please sign in to comment.