Skip to content

HBASE-28651 Reformat the javadoc for CellChunkMap #5977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Apache9 merged 1 commit into from
Jun 11, 2024
Merged

HBASE-28651 Reformat the javadoc for CellChunkMap #5977

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 21 additions & 11 deletions hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/CellChunkMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,28 @@

/**
* CellChunkMap is an array of serialized representations of Cell (pointing to Chunks with full Cell
* data) and can be allocated both off-heap and on-heap. CellChunkMap is a byte array (chunk)
* holding all that is needed to access a Cell, which is actually saved on another deeper chunk. Per
* Cell we have a reference to this deeper byte array B (chunk ID, integer), offset in bytes in B
* (integer), length in bytes in B (integer) and seqID of the cell (long). In order to save
* reference to byte array we use the Chunk's ID given by ChunkCreator. The CellChunkMap memory
* layout on chunk A relevant to a deeper byte array B, holding the actual cell data: < header >
* <--------------- first Cell -----------------> <-- second Cell ...
* data) and can be allocated both off-heap and on-heap.
* <p>
* CellChunkMap is a byte array (chunk) holding all that is needed to access a Cell, which is
* actually saved on another deeper chunk. Per Cell we have a reference to this deeper byte array B
* (chunk ID, integer), offset in bytes in B (integer), length in bytes in B (integer) and seqID of
* the cell (long). In order to save reference to byte array we use the Chunk's ID given by
* ChunkCreator.
* <p>
* The CellChunkMap memory layout on chunk A relevant to a deeper byte array B, holding the actual
* cell data:
*
* <pre>
*
* < header > <--------------- first Cell -----------------> <-- second Cell ...
* --------------------------------------------------------------------------------------- ...
* integer | integer | integer | integer | long | 4 bytes | 4 bytes | 4 bytes | 4 bytes | 8 bytes |
* ChunkID | chunkID of | offset in B | length of | sequence | ... of this | chunk B with | where
* Cell's | Cell's | ID of | chunk A | Cell data | data starts | data in B | the Cell |
* integer | integer | integer | integer | long |
* 4 bytes | 4 bytes | 4 bytes | 4 bytes | 8 bytes |
* ChunkID | chunkID of | offset in B | length of | sequence | ...
* of this | chunk B with | where Cell's | Cell's | ID of |
* chunk A | Cell data | data starts | data in B | the Cell |
* --------------------------------------------------------------------------------------- ...
* </pre>
*/
@InterfaceAudience.Private
public class CellChunkMap extends CellFlatMap {
Expand Down Expand Up @@ -71,7 +81,7 @@ public CellChunkMap(Comparator<? super Cell> comparator, Chunk[] chunks, int min
}
}

/*
/**
* To be used by base (CellFlatMap) class only to create a sub-CellFlatMap Should be used only to
* create only CellChunkMap from CellChunkMap
*/
Expand Down