andreacavalli/rocksdb
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix java doc issues (#9253)

Browse Source 
Summary: Pull Request resolved: https://github.com/facebook/rocksdb/pull/9253

Reviewed By: jay-zhuang

Differential Revision: D32990516

Pulled By: mrambacher

fbshipit-source-id: c7cdb6562ac6871bca6ea0d9efa454f3a902a137
This commit is contained in:
Jermy Li 2021-12-16 21:03:37 -08:00 committed by Facebook GitHub Bot
parent 0050a73a4f
commit 9828b6d5fd
4 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
java/src/main/java/org/rocksdb/ColumnFamilyOptionsInterface.java
View File

@ -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);
@ -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);

3
java/src/main/java/org/rocksdb/EventListener.java
View File

@ -303,6 +303,8 @@ public interface EventListener {
* false, then they won't be called.
*
* Default: false
*
* @return whether to callback when file read/write is finished
*/
boolean shouldBeNotifiedOnFileIO();
@ -316,6 +318,7 @@ public interface EventListener {
*
* @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);

1
java/src/main/java/org/rocksdb/SstFileWriter.java
View File

@ -244,6 +244,7 @@ public class SstFileWriter extends RocksObject {
/**
* Return the current file size.
*
* @return the current file size.
* @throws RocksDBException thrown if error happens in underlying
* native library.
*/

4
java/src/main/java/org/rocksdb/WriteBatchInterface.java
View File

@ -50,7 +50,7 @@ public interface WriteBatchInterface {
* 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;
@ -64,7 +64,7 @@ public interface WriteBatchInterface {
* 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;