Skip to content

Commit c81601f

Browse files
committed
HBASE-28651 Reformat the javadoc for CellChunkMap (#5977)
Signed-off-by: Yi Mei <meiyi@apache.org> (cherry picked from commit 5803618)
1 parent e37cf99 commit c81601f

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/CellChunkMap.java

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,28 @@
2727

2828
/**
2929
* CellChunkMap is an array of serialized representations of Cell (pointing to Chunks with full Cell
30-
* data) and can be allocated both off-heap and on-heap. CellChunkMap is a byte array (chunk)
31-
* holding all that is needed to access a Cell, which is actually saved on another deeper chunk. Per
32-
* Cell we have a reference to this deeper byte array B (chunk ID, integer), offset in bytes in B
33-
* (integer), length in bytes in B (integer) and seqID of the cell (long). In order to save
34-
* reference to byte array we use the Chunk's ID given by ChunkCreator. The CellChunkMap memory
35-
* layout on chunk A relevant to a deeper byte array B, holding the actual cell data: < header >
36-
* <--------------- first Cell -----------------> <-- second Cell ...
30+
* data) and can be allocated both off-heap and on-heap.
31+
* <p>
32+
* CellChunkMap is a byte array (chunk) holding all that is needed to access a Cell, which is
33+
* actually saved on another deeper chunk. Per Cell we have a reference to this deeper byte array B
34+
* (chunk ID, integer), offset in bytes in B (integer), length in bytes in B (integer) and seqID of
35+
* the cell (long). In order to save reference to byte array we use the Chunk's ID given by
36+
* ChunkCreator.
37+
* <p>
38+
* The CellChunkMap memory layout on chunk A relevant to a deeper byte array B, holding the actual
39+
* cell data:
40+
*
41+
* <pre>
42+
*
43+
* < header > <--------------- first Cell -----------------> <-- second Cell ...
3744
* --------------------------------------------------------------------------------------- ...
38-
* integer | integer | integer | integer | long | 4 bytes | 4 bytes | 4 bytes | 4 bytes | 8 bytes |
39-
* ChunkID | chunkID of | offset in B | length of | sequence | ... of this | chunk B with | where
40-
* Cell's | Cell's | ID of | chunk A | Cell data | data starts | data in B | the Cell |
45+
* integer | integer | integer | integer | long |
46+
* 4 bytes | 4 bytes | 4 bytes | 4 bytes | 8 bytes |
47+
* ChunkID | chunkID of | offset in B | length of | sequence | ...
48+
* of this | chunk B with | where Cell's | Cell's | ID of |
49+
* chunk A | Cell data | data starts | data in B | the Cell |
4150
* --------------------------------------------------------------------------------------- ...
51+
* </pre>
4252
*/
4353
@InterfaceAudience.Private
4454
public class CellChunkMap extends CellFlatMap {
@@ -71,7 +81,7 @@ public CellChunkMap(Comparator<? super Cell> comparator, Chunk[] chunks, int min
7181
}
7282
}
7383

74-
/*
84+
/**
7585
* To be used by base (CellFlatMap) class only to create a sub-CellFlatMap Should be used only to
7686
* create only CellChunkMap from CellChunkMap
7787
*/

0 commit comments

Comments
 (0)