Skip to content

Commit 050f3e1

Browse files
committed
HBASE-27401 Addendum fix more javadoc issues
(cherry picked from commit 4b45256)
1 parent fb98837 commit 050f3e1

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/HFileReaderImpl.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1642,10 +1642,12 @@ public HFileScanner getScanner(Configuration conf, boolean cacheBlocks, final bo
16421642
/**
16431643
* Create a Scanner on this file. No seeks or reads are done on creation. Call
16441644
* {@link HFileScanner#seekTo(Cell)} to position an start the read. There is nothing to clean up
1645-
* in a Scanner. Letting go of your references to the scanner is sufficient. Store configuration.
1646-
* True if we should cache blocks read in by this scanner. Use positional read rather than
1647-
* seek+read if true (pread is better for random reads, seek+read is better scanning). is scanner
1648-
* being used for a compaction?
1645+
* in a Scanner. Letting go of your references to the scanner is sufficient.
1646+
* @param conf Store configuration.
1647+
* @param cacheBlocks True if we should cache blocks read in by this scanner.
1648+
* @param pread Use positional read rather than seek+read if true (pread is better for
1649+
* random reads, seek+read is better scanning).
1650+
* @param isCompaction is scanner being used for a compaction?
16491651
* @return Scanner on this file.
16501652
*/
16511653
@Override

hbase-server/src/main/java/org/apache/hadoop/hbase/mob/MobFileName.java

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,11 @@ public final class MobFileName {
5151
public static final String REGION_SEP = "_";
5252

5353
/**
54-
* The start key. The string of the latest timestamp of cells in this file, the format is
55-
* yyyymmdd. The uuid
54+
* Creates an instance of MobFileName
55+
* @param startKey The start key.
56+
* @param date The string of the latest timestamp of cells in this file, the format is
57+
* yyyymmdd.
58+
* @param uuid The uuid
5659
* @param regionName name of a region, where this file was created during flush or compaction.
5760
*/
5861
private MobFileName(byte[] startKey, String date, String uuid, String regionName) {
@@ -64,8 +67,11 @@ private MobFileName(byte[] startKey, String date, String uuid, String regionName
6467
}
6568

6669
/**
67-
* The md5 hex string of the start key. The string of the latest timestamp of cells in this file,
68-
* the format is yyyymmdd. The uuid
70+
* Creates an instance of MobFileName
71+
* @param startKey The md5 hex string of the start key.
72+
* @param date The string of the latest timestamp of cells in this file, the format is
73+
* yyyymmdd.
74+
* @param uuid The uuid
6975
* @param regionName name of a region, where this file was created during flush or compaction.
7076
*/
7177
private MobFileName(String startKey, String date, String uuid, String regionName) {
@@ -77,8 +83,10 @@ private MobFileName(String startKey, String date, String uuid, String regionName
7783
}
7884

7985
/**
80-
* Creates an instance of MobFileName The md5 hex string of the start key. The string of the
81-
* latest timestamp of cells in this file, the format is yyyymmdd.
86+
* Creates an instance of MobFileName
87+
* @param startKey The md5 hex string of the start key.
88+
* @param date The string of the latest timestamp of cells in this file, the format is
89+
* yyyymmdd.
8290
* @param uuid The uuid.
8391
* @param regionName name of a region, where this file was created during flush or compaction.
8492
* @return An instance of a MobFileName.
@@ -88,8 +96,10 @@ public static MobFileName create(byte[] startKey, String date, String uuid, Stri
8896
}
8997

9098
/**
91-
* Creates an instance of MobFileName The md5 hex string of the start key. The string of the
92-
* latest timestamp of cells in this file, the format is yyyymmdd.
99+
* Creates an instance of MobFileName
100+
* @param startKey The md5 hex string of the start key.
101+
* @param date The string of the latest timestamp of cells in this file, the format is
102+
* yyyymmdd.
93103
* @param uuid The uuid.
94104
* @param regionName name of a region, where this file was created during flush or compaction.
95105
* @return An instance of a MobFileName.

0 commit comments

Comments
 (0)