wbtiger
/
foundationdb
mirror of https://github.com/apple/foundationdb.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Database documentation was updated in the wrong place.

This commit is contained in:
A.J. Beamon 2017-12-08 15:37:24 -08:00
parent 33d047b6e8
commit ab431004a3
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
bindings/java/src-completable/main/com/apple/foundationdb/Database.java
View File

@ -35,8 +35,10 @@ import java.util.function.Function;
* in the {@link TransactionContext} interface. When used on a {@code Database} these
* methods will call {@code Transaction#commit()} after user code has been
* executed. These methods will not return successfully until {@code commit()} has
* returned successfully.
*
* returned successfully.<br>
* <br>
* <b>Note:</b> {@code Database} objects must be disposed when no longer in use in order
* to free associated native memory.
*/
public interface Database extends Disposable, TransactionContext {
/**
@ -44,10 +46,7 @@ public interface Database extends Disposable, TransactionContext {
* <br>
* <b>Note:</b> Java transactions automatically set the {@link TransactionOptions#setUsedDuringCommitProtectionDisable}
* option. This is because the Java bindings disallow use of {@code Transaction} objects after
* {@link Transaction#onError} is called.<br>
* <br>
* <b>Note:</b> {@code Database} objects must be disposed when no longer in use in order
* to free associated native memory.
* {@link Transaction#onError} is called.
*
* @return a newly created {@code Transaction} that reads from and writes to this {@code Database}.
*/