You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by zh...@apache.org on 2022/10/06 16:55:43 UTC
[hbase] branch branch-2.5 updated: HBASE-27401 Addendum fix more javadoc issues
This is an automated email from the ASF dual-hosted git repository.
zhangduo pushed a commit to branch branch-2.5
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/branch-2.5 by this push:
new 050f3e1ef51 HBASE-27401 Addendum fix more javadoc issues
050f3e1ef51 is described below
commit 050f3e1ef516ce8dd2f215a1af101697c1fd28cb
Author: Duo Zhang <zh...@apache.org>
AuthorDate: Fri Oct 7 00:54:05 2022 +0800
HBASE-27401 Addendum fix more javadoc issues
(cherry picked from commit 4b45256910bb8ec06c7761ee4279732e493feba2)
---
.../hadoop/hbase/io/hfile/HFileReaderImpl.java | 10 +++++----
.../org/apache/hadoop/hbase/mob/MobFileName.java | 26 +++++++++++++++-------
2 files changed, 24 insertions(+), 12 deletions(-)
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFileReaderImpl.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFileReaderImpl.java
index af66bd8b3a2..35031fc5e6c 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFileReaderImpl.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFileReaderImpl.java
@@ -1642,10 +1642,12 @@ public abstract class HFileReaderImpl implements HFile.Reader, Configurable {
/**
* Create a Scanner on this file. No seeks or reads are done on creation. Call
* {@link HFileScanner#seekTo(Cell)} to position an start the read. There is nothing to clean up
- * in a Scanner. Letting go of your references to the scanner is sufficient. Store configuration.
- * True if we should cache blocks read in by this scanner. Use positional read rather than
- * seek+read if true (pread is better for random reads, seek+read is better scanning). is scanner
- * being used for a compaction?
+ * in a Scanner. Letting go of your references to the scanner is sufficient.
+ * @param conf Store configuration.
+ * @param cacheBlocks True if we should cache blocks read in by this scanner.
+ * @param pread Use positional read rather than seek+read if true (pread is better for
+ * random reads, seek+read is better scanning).
+ * @param isCompaction is scanner being used for a compaction?
* @return Scanner on this file.
*/
@Override
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/mob/MobFileName.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/mob/MobFileName.java
index 8f163cf5cc2..f45bbb43240 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/mob/MobFileName.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/mob/MobFileName.java
@@ -51,8 +51,11 @@ public final class MobFileName {
public static final String REGION_SEP = "_";
/**
- * The start key. The string of the latest timestamp of cells in this file, the format is
- * yyyymmdd. The uuid
+ * Creates an instance of MobFileName
+ * @param startKey The start key.
+ * @param date The string of the latest timestamp of cells in this file, the format is
+ * yyyymmdd.
+ * @param uuid The uuid
* @param regionName name of a region, where this file was created during flush or compaction.
*/
private MobFileName(byte[] startKey, String date, String uuid, String regionName) {
@@ -64,8 +67,11 @@ public final class MobFileName {
}
/**
- * The md5 hex string of the start key. The string of the latest timestamp of cells in this file,
- * the format is yyyymmdd. The uuid
+ * Creates an instance of MobFileName
+ * @param startKey The md5 hex string of the start key.
+ * @param date The string of the latest timestamp of cells in this file, the format is
+ * yyyymmdd.
+ * @param uuid The uuid
* @param regionName name of a region, where this file was created during flush or compaction.
*/
private MobFileName(String startKey, String date, String uuid, String regionName) {
@@ -77,8 +83,10 @@ public final class MobFileName {
}
/**
- * Creates an instance of MobFileName The md5 hex string of the start key. The string of the
- * latest timestamp of cells in this file, the format is yyyymmdd.
+ * Creates an instance of MobFileName
+ * @param startKey The md5 hex string of the start key.
+ * @param date The string of the latest timestamp of cells in this file, the format is
+ * yyyymmdd.
* @param uuid The uuid.
* @param regionName name of a region, where this file was created during flush or compaction.
* @return An instance of a MobFileName.
@@ -88,8 +96,10 @@ public final class MobFileName {
}
/**
- * Creates an instance of MobFileName The md5 hex string of the start key. The string of the
- * latest timestamp of cells in this file, the format is yyyymmdd.
+ * Creates an instance of MobFileName
+ * @param startKey The md5 hex string of the start key.
+ * @param date The string of the latest timestamp of cells in this file, the format is
+ * yyyymmdd.
* @param uuid The uuid.
* @param regionName name of a region, where this file was created during flush or compaction.
* @return An instance of a MobFileName.