This is an automated email from the ASF dual-hosted git repository.
cshannon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git
The following commit(s) were added to refs/heads/main by this push:
new 89d893f4dd Improve javadocs for the TabletFile interface (#3476)
89d893f4dd is described below
commit 89d893f4dd4a727702a4c38da7c4b59f4152c7c3
Author: Christopher L. Shannon <christopher.l.shan...@gmail.com>
AuthorDate: Fri Jun 9 13:49:02 2023 -0400
Improve javadocs for the TabletFile interface (#3476)
Co-authored-by: EdColeman <d...@etcoleman.com>
Co-authored-by: Christopher Tubbs <ctubb...@apache.org>
---
.../java/org/apache/accumulo/core/metadata/TabletFile.java | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git
a/core/src/main/java/org/apache/accumulo/core/metadata/TabletFile.java
b/core/src/main/java/org/apache/accumulo/core/metadata/TabletFile.java
index baad4f5103..3486f2134f 100644
--- a/core/src/main/java/org/apache/accumulo/core/metadata/TabletFile.java
+++ b/core/src/main/java/org/apache/accumulo/core/metadata/TabletFile.java
@@ -20,15 +20,24 @@ package org.apache.accumulo.core.metadata;
import org.apache.hadoop.fs.Path;
+/**
+ * An interface that represents different types of file references that are
handled by code that
+ * processes tablet files.
+ */
public interface TabletFile {
/**
- * @return The file name of the TabletFile
+ * Returns the fileName of the TabletFile. The value return is the name
itself and not the entire
+ * path. For example, if the full path for a TabletFile is
+ * 'hdfs://nn1/accumulo/tables/5a/t-0001/F0002.rf', this method returns
'F0002.rf'.
*/
String getFileName();
/**
- * @return The path of the TabletFile
+ * Returns the full path for the TabletFile on the file system. The path may
be normalized
+ * depending on the specific implementation. For example, a path in hdfs
would be returned as
+ * 'hdfs://nn1/accumulo/tables/5a/t-0001/F0002.rf'
*/
Path getPath();
+
}
