Fix trivial Javadoc omissions (#9534)

Summary:
- fix spelling of `valueSizeSofLimit` and add "param" description in ReadOptions
- add 3 missing "return" in RocksDB

Pull Request resolved: https://github.com/facebook/rocksdb/pull/9534

Reviewed By: riversand963

Differential Revision: D34131186

Pulled By: mrambacher

fbshipit-source-id: 7eb7ec177906052837180b291d67fb1c838c49e1
main
stefan-zobel 3 years ago committed by Facebook GitHub Bot
parent 9983eecdfb
commit ddb7620a61
  1. 6
      java/src/main/java/org/rocksdb/ReadOptions.java
  2. 3
      java/src/main/java/org/rocksdb/RocksDB.java

@ -751,12 +751,12 @@ public class ReadOptions extends RocksObject {
* *
* Default: {@code std::numeric_limits<uint64_t>::max()} * Default: {@code std::numeric_limits<uint64_t>::max()}
* *
* @param valueSizeSofLimit * @param valueSizeSoftLimit the maximum cumulative value size of the keys
* @return the reference to the current ReadOptions * @return the reference to the current ReadOptions
*/ */
public ReadOptions setValueSizeSoftLimit(final long valueSizeSofLimit) { public ReadOptions setValueSizeSoftLimit(final long valueSizeSoftLimit) {
assert (isOwningHandle()); assert (isOwningHandle());
setValueSizeSoftLimit(nativeHandle_, valueSizeSofLimit); setValueSizeSoftLimit(nativeHandle_, valueSizeSoftLimit);
return this; return this;
} }

@ -2296,6 +2296,7 @@ public class RocksDB extends RocksObject {
* @throws RocksDBException if error happens in underlying native library. * @throws RocksDBException if error happens in underlying native library.
* @throws IllegalArgumentException thrown if the number of passed keys and passed values * @throws IllegalArgumentException thrown if the number of passed keys and passed values
* do not match. * do not match.
* @return the list of values for the given list of keys
*/ */
public List<ByteBufferGetStatus> multiGetByteBuffers(final ReadOptions readOptions, public List<ByteBufferGetStatus> multiGetByteBuffers(final ReadOptions readOptions,
final List<ByteBuffer> keys, final List<ByteBuffer> values) throws RocksDBException { final List<ByteBuffer> keys, final List<ByteBuffer> values) throws RocksDBException {
@ -2318,6 +2319,7 @@ public class RocksDB extends RocksObject {
* @throws RocksDBException if error happens in underlying native library. * @throws RocksDBException if error happens in underlying native library.
* @throws IllegalArgumentException thrown if the number of passed keys, passed values and * @throws IllegalArgumentException thrown if the number of passed keys, passed values and
* passed column family handles do not match. * passed column family handles do not match.
* @return the list of values for the given list of keys
*/ */
public List<ByteBufferGetStatus> multiGetByteBuffers( public List<ByteBufferGetStatus> multiGetByteBuffers(
final List<ColumnFamilyHandle> columnFamilyHandleList, final List<ByteBuffer> keys, final List<ColumnFamilyHandle> columnFamilyHandleList, final List<ByteBuffer> keys,
@ -2341,6 +2343,7 @@ public class RocksDB extends RocksObject {
* @throws RocksDBException if error happens in underlying native library. * @throws RocksDBException if error happens in underlying native library.
* @throws IllegalArgumentException thrown if the number of passed keys, passed values and * @throws IllegalArgumentException thrown if the number of passed keys, passed values and
* passed column family handles do not match. * passed column family handles do not match.
* @return the list of values for the given list of keys
*/ */
public List<ByteBufferGetStatus> multiGetByteBuffers(final ReadOptions readOptions, public List<ByteBufferGetStatus> multiGetByteBuffers(final ReadOptions readOptions,
final List<ColumnFamilyHandle> columnFamilyHandleList, final List<ByteBuffer> keys, final List<ColumnFamilyHandle> columnFamilyHandleList, final List<ByteBuffer> keys,

Loading…
Cancel
Save