removed FIXME from Javadocs
This commit is contained in:
parent
e51260a771
commit
6576e62a4e
|
@ -44,8 +44,8 @@ public interface Database extends Disposable, TransactionContext {
|
||||||
* Creates a {@link Transaction} that operates on this {@code Database}.<br>
|
* Creates a {@link Transaction} that operates on this {@code Database}.<br>
|
||||||
* <br>
|
* <br>
|
||||||
* Note: Java transactions automatically set the {@link TransactionOptions#setUsedDuringCommitProtectionDisable}
|
* Note: Java transactions automatically set the {@link TransactionOptions#setUsedDuringCommitProtectionDisable}
|
||||||
* option. This is because the Java bindings disallow use of {@code Transaction} objects after either
|
* option. This is because the Java bindings disallow use of {@code Transaction} objects after
|
||||||
* {@link Transaction#reset} or {@link Transaction#onError} is called.
|
* {@link Transaction#onError} is called.
|
||||||
*
|
*
|
||||||
* @return a newly created {@code Transaction} that reads from and writes to this {@code Database}.
|
* @return a newly created {@code Transaction} that reads from and writes to this {@code Database}.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -61,7 +61,7 @@ public interface AsyncIterator<T> extends Iterator<T>, Disposable {
|
||||||
/**
|
/**
|
||||||
* Returns the next element in the sequence. This will not block if, since the
|
* Returns the next element in the sequence. This will not block if, since the
|
||||||
* last call to {@code next()}, {@link #onHasNext()} was called and the resulting
|
* last call to {@code next()}, {@link #onHasNext()} was called and the resulting
|
||||||
* <h1>FIXME!!!!</h1> has completed or the blocking call {@link #hasNext()} was called
|
* {@link CompletableFuture} has completed or the blocking call {@link #hasNext()} was called
|
||||||
* and has returned. It is legal, therefore, to make a call to {@code next()} without a
|
* and has returned. It is legal, therefore, to make a call to {@code next()} without a
|
||||||
* preceding call to
|
* preceding call to
|
||||||
* {@link #hasNext()} or {@link #onHasNext()}, but that invocation of {@code next()}
|
* {@link #hasNext()} or {@link #onHasNext()}, but that invocation of {@code next()}
|
||||||
|
|
|
@ -24,10 +24,11 @@ and add it to your classpath.<br>
|
||||||
<br>
|
<br>
|
||||||
<h3>Getting started</h3>
|
<h3>Getting started</h3>
|
||||||
To start using FoundationDB from Java, create an instance of the
|
To start using FoundationDB from Java, create an instance of the
|
||||||
{@link FDB FoundationDB API interface} with the version of the
|
{@link com.apple.cie.foundationdb.FDB FoundationDB API interface} with the version of the
|
||||||
API that you want to use (this release of the FoundationDB Java API supports only version {@code 500}).
|
API that you want to use (this release of the FoundationDB Java API supports only version {@code 500}).
|
||||||
With this API object you can then open {@link Cluster}s and
|
With this API object you can then open {@link com.apple.cie.foundationdb.Cluster Cluster}s and
|
||||||
{@link Database}s and start using {@link Transaction}s.
|
{@link com.apple.cie.foundationdb.Database Database}s and start using
|
||||||
|
{@link com.apple.cie.foundationdb.Transaction Transactions}s.
|
||||||
Here we give an example. The example relies on a cluster file at the
|
Here we give an example. The example relies on a cluster file at the
|
||||||
<a href="/documentation/api-general.html#default-cluster-file">default location</a>
|
<a href="/documentation/api-general.html#default-cluster-file">default location</a>
|
||||||
for your platform and a running server.<br>
|
for your platform and a running server.<br>
|
||||||
|
@ -77,7 +78,7 @@ for information about how Tuples sort and can be used to efficiently model data.
|
||||||
The {@link com.apple.cie.foundationdb.directory Directory API} is provided with the core
|
The {@link com.apple.cie.foundationdb.directory Directory API} is provided with the core
|
||||||
Java API for FoundationDB. This layer is provided in some form in all official
|
Java API for FoundationDB. This layer is provided in some form in all official
|
||||||
language bindings. The FoundationDB API provides directories as a tool for
|
language bindings. The FoundationDB API provides directories as a tool for
|
||||||
managing related {@link Subspace}s. Directories are a
|
managing related {@link com.apple.cie.foundationdb.subspace.Subspace Subspace}s. Directories are a
|
||||||
recommended approach for administering applications. Each application should
|
recommended approach for administering applications. Each application should
|
||||||
create or open at least one directory to manage its subspaces. Directories are
|
create or open at least one directory to manage its subspaces. Directories are
|
||||||
identified by hierarchical paths analogous to the paths in a Unix-like file system.
|
identified by hierarchical paths analogous to the paths in a Unix-like file system.
|
||||||
|
|
|
@ -46,8 +46,8 @@ public interface Database extends Disposable, TransactionContext {
|
||||||
* Creates a {@link Transaction} that operates on this {@code Database}.<br>
|
* Creates a {@link Transaction} that operates on this {@code Database}.<br>
|
||||||
* <br>
|
* <br>
|
||||||
* Note: Java transactions automatically set the {@link TransactionOptions#setUsedDuringCommitProtectionDisable}
|
* Note: Java transactions automatically set the {@link TransactionOptions#setUsedDuringCommitProtectionDisable}
|
||||||
* option. This is because the Java bindings disallow use of {@code Transaction} objects after either
|
* option. This is because the Java bindings disallow use of {@code Transaction} objects after
|
||||||
* {@link Transaction#reset} or {@link Transaction#onError} is called.
|
* {@link Transaction#onError} is called.
|
||||||
*
|
*
|
||||||
* @return a newly created {@code Transaction} that reads from and writes to this {@code Database}.
|
* @return a newly created {@code Transaction} that reads from and writes to this {@code Database}.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -24,11 +24,12 @@ and add it to your classpath.<br>
|
||||||
<br>
|
<br>
|
||||||
<h3>Getting started</h3>
|
<h3>Getting started</h3>
|
||||||
To start using FoundationDB from Java, create an instance of the
|
To start using FoundationDB from Java, create an instance of the
|
||||||
{@link FDB FoundationDB API interface} with the version of the
|
{@link com.apple.cie.foundationdb.FDB FoundationDB API interface} with the version of the
|
||||||
API that you want to use (this release of the FoundationDB Java API supports only version {@code 500}).
|
API that you want to use (this release of the FoundationDB Java API supports only version {@code 500}).
|
||||||
With this API object you can then open {@link Cluster}s and
|
With this API object you can then open {@link com.apple.cie.foundationdb.Cluster}s and
|
||||||
{@link Database}s and start using {@link Transaction}s.
|
{@link com.apple.cie.foundationdb.Database}s and start using
|
||||||
Here we give an example. The example relies on a cluster file at the
|
{@link com.apple.cie.foundationdb.Transaction}s. Here we give an example. The example relies on a
|
||||||
|
cluster file at the
|
||||||
<a href="/documentation/api-general.html#default-cluster-file">default location</a>
|
<a href="/documentation/api-general.html#default-cluster-file">default location</a>
|
||||||
for your platform and a running server.<br>
|
for your platform and a running server.<br>
|
||||||
<br>
|
<br>
|
||||||
|
@ -77,7 +78,7 @@ for information about how Tuples sort and can be used to efficiently model data.
|
||||||
The {@link com.apple.cie.foundationdb.directory Directory API} is provided with the core
|
The {@link com.apple.cie.foundationdb.directory Directory API} is provided with the core
|
||||||
Java API for FoundationDB. This layer is provided in some form in all official
|
Java API for FoundationDB. This layer is provided in some form in all official
|
||||||
language bindings. The FoundationDB API provides directories as a tool for
|
language bindings. The FoundationDB API provides directories as a tool for
|
||||||
managing related {@link Subspace}s. Directories are a
|
managing related {@link com.apple.cie.foundationdb.subspace.Subspace Subspace}s. Directories are a
|
||||||
recommended approach for administering applications. Each application should
|
recommended approach for administering applications. Each application should
|
||||||
create or open at least one directory to manage its subspaces. Directories are
|
create or open at least one directory to manage its subspaces. Directories are
|
||||||
identified by hierarchical paths analogous to the paths in a Unix-like file system.
|
identified by hierarchical paths analogous to the paths in a Unix-like file system.
|
||||||
|
@ -87,12 +88,12 @@ for the corresponding subspace. In effect, directories provide a level of indire
|
||||||
for access to subspaces.
|
for access to subspaces.
|
||||||
<br>
|
<br>
|
||||||
<h3>{@link com.apple.cie.foundationdb.async.Future Future}s and asynchronous operation</h3>
|
<h3>{@link com.apple.cie.foundationdb.async.Future Future}s and asynchronous operation</h3>
|
||||||
Asynchronous FoundationDB operations return {@link Future}s.
|
Asynchronous FoundationDB operations return {@link com.apple.cie.foundationdb.async.Future Future}s.
|
||||||
A {@link Future} can be used in a blocking way using the
|
A {@link com.apple.cie.foundationdb.async.Future Future} can be used in a blocking way using the
|
||||||
{@link Future#get() get()} method or in a
|
{@link com.apple.cie.foundationdb.async.Future#get() get()} method or in a
|
||||||
fully-asynchronous way using the
|
fully-asynchronous way using the
|
||||||
{@link Future#map(Function) map()} and
|
{@link com.apple.cie.foundationdb.async.Future#map(Function) map()} and
|
||||||
{@link Future#flatMap(Function) flatMap()}
|
{@link com.apple.cie.foundationdb.async.Future#flatMap(Function) flatMap()}
|
||||||
methods. Generally, the blocking style is more straightforward and the asynchronous style
|
methods. Generally, the blocking style is more straightforward and the asynchronous style
|
||||||
is more efficient. Mixing the two styles correctly can be tricky, so consider choosing
|
is more efficient. Mixing the two styles correctly can be tricky, so consider choosing
|
||||||
one or the other. See the {@linkplain com.apple.cie.foundationdb.async async Package documentation}
|
one or the other. See the {@linkplain com.apple.cie.foundationdb.async async Package documentation}
|
||||||
|
|
Loading…
Reference in New Issue