Skip to content

Commit afe8dca

Browse files
committed
Some Javadoc cleanup
1 parent f3dcbfe commit afe8dca

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

unsafe/src/main/java/org/apache/spark/unsafe/map/BytesToBytesMap.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@
3232

3333
/**
3434
* An append-only hash map where keys and values are contiguous regions of bytes.
35-
*
36-
* This class is not thread-safe.
37-
*
35+
* <p>
3836
* This is backed by a power-of-2-sized hash table, using quadratic probing with triangular numbers,
3937
* which is guaranteed to exhaust the space.
40-
*
38+
* <p>
4139
* Note that even though we use long for indexing, the map can support up to 2^31 keys because
4240
* we use 32 bit MurmurHash. In either case, if the key cardinality is so high, you should probably
4341
* be using sorting instead of hashing for better cache locality.
42+
* <p>
43+
* This class is not thread safe.
4444
*/
4545
public final class BytesToBytesMap {
4646

@@ -389,21 +389,21 @@ public int getValueLength() {
389389
* Store a new key and value. This method may only be called once for a given key; if you want
390390
* to update the value associated with a key, then you can directly manipulate the bytes stored
391391
* at the value address.
392-
*
392+
* <p>
393393
* It is only valid to call this method immediately after calling `lookup()` using the same key.
394-
*
394+
* <p>
395395
* After calling this method, calls to `get[Key|Value]Address()` and `get[Key|Value]Length`
396396
* will return information on the data stored by this `putNewKey` call.
397-
*
397+
* <p>
398398
* As an example usage, here's the proper way to store a new key:
399-
*
400-
* <code>
399+
* <p>
400+
* <pre>
401401
* Location loc = map.lookup(keyBaseOffset, keyBaseObject, keyLengthInBytes);
402402
* if (!loc.isDefined()) {
403403
* loc.putNewKey(keyBaseOffset, keyBaseObject, keyLengthInBytes, ...)
404404
* }
405-
* </code>
406-
*
405+
* </pre>
406+
* <p>
407407
* Unspecified behavior if the key is not defined.
408408
*/
409409
public void putNewKey(

0 commit comments

Comments
 (0)