Skip to content

Commit

Permalink
fix java doc issues (#9253)
Browse files Browse the repository at this point in the history
Summary: Pull Request resolved: #9253

Reviewed By: jay-zhuang

Differential Revision: D32990516

Pulled By: mrambacher

fbshipit-source-id: c7cdb6562ac6871bca6ea0d9efa454f3a902a137
  • Loading branch information
javeme authored and facebook-github-bot committed Dec 17, 2021
1 parent 0050a73 commit 9828b6d
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ public interface ColumnFamilyOptionsInterface<T extends ColumnFamilyOptionsInter
* The function recovers options to a previous version. Only 4.6 or later
* versions are supported.
*
* @param majorVersion The major version to recover default values of options
* @param minorVersion The minor version to recover default values of options
* @return the instance of the current object.
*/
T oldDefaults(int majorVersion, int minorVersion);
Expand All @@ -30,8 +32,8 @@ public interface ColumnFamilyOptionsInterface<T extends ColumnFamilyOptionsInter
* Some functions that make it easier to optimize RocksDB
* Use this if your DB is very small (like under 1GB) and you don't want to
* spend lots of memory for memtables.
* An optional cache object is passed in to be used as the block cache
*
* @param cache An optional cache object is passed in to be used as the block cache
* @return the instance of the current object.
*/
T optimizeForSmallDb(Cache cache);
Expand Down
3 changes: 3 additions & 0 deletions java/src/main/java/org/rocksdb/EventListener.java
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,8 @@ void onBackgroundError(
* false, then they won't be called.
*
* Default: false
*
* @return whether to callback when file read/write is finished
*/
boolean shouldBeNotifiedOnFileIO();

Expand All @@ -316,6 +318,7 @@ void onBackgroundError(
*
* @param backgroundErrorReason background error reason code
* @param backgroundError background error codes
* @return whether to suppress the automatic recovery
*/
boolean onErrorRecoveryBegin(
final BackgroundErrorReason backgroundErrorReason, final Status backgroundError);
Expand Down
1 change: 1 addition & 0 deletions java/src/main/java/org/rocksdb/SstFileWriter.java
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ public void finish() throws RocksDBException {
/**
* Return the current file size.
*
* @return the current file size.
* @throws RocksDBException thrown if error happens in underlying
* native library.
*/
Expand Down
4 changes: 2 additions & 2 deletions java/src/main/java/org/rocksdb/WriteBatchInterface.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ void put(ColumnFamilyHandle columnFamilyHandle, byte[] key, byte[] value)
* Supports direct buffer only.
* @param value the value associated with the specified key. It is using position and limit.
* Supports direct buffer only.
* @throws RocksDBException
* @throws RocksDBException thrown if error happens in underlying native library.
*/
void put(final ByteBuffer key, final ByteBuffer value) throws RocksDBException;

Expand All @@ -64,7 +64,7 @@ void put(ColumnFamilyHandle columnFamilyHandle, byte[] key, byte[] value)
* Supports direct buffer only.
* @param value the value associated with the specified key. It is using position and limit.
* Supports direct buffer only.
* @throws RocksDBException
* @throws RocksDBException thrown if error happens in underlying native library.
*/
void put(ColumnFamilyHandle columnFamilyHandle, final ByteBuffer key, final ByteBuffer value)
throws RocksDBException;
Expand Down

0 comments on commit 9828b6d

Please sign in to comment.