ctubbsii commented on code in PR #3476:
URL: https://github.com/apache/accumulo/pull/3476#discussion_r1224477599


##########
core/src/main/java/org/apache/accumulo/core/metadata/TabletFile.java:
##########
@@ -20,15 +20,25 @@
 
 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'.

Review Comment:
   Based on this description, it almost seems like we don't need this method, 
because it's just the substring of `getPath()` since the last index of `/`, 
which could be done in the calling code. And, with one method, it becomes a 
functional interface, too, so callers could easily map a stream to the last 
path element when they need to. In any case, the minimal change is just to fix 
the javadoc formatting:
   
   Missing `<p>` for separate paragraph, but in this case, I don't think it 
needs it. Can just use one paragraph.
   
   ```suggestion
      * 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'.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to