From bba4c065cbf9d0bba3a1f9575e3aa4a115003d50 Mon Sep 17 00:00:00 2001 From: Alec Grieser Date: Thu, 19 Apr 2018 09:44:40 -0700 Subject: [PATCH] fix broken links within javadocs --- .../main/com/apple/foundationdb/Database.java | 4 ++-- .../src/main/com/apple/foundationdb/FDB.java | 20 ++++++++-------- .../com/apple/foundationdb/KeySelector.java | 4 ++-- .../com/apple/foundationdb/Transaction.java | 10 ++++---- .../directory/DirectoryLayer.java | 2 +- .../directory/DirectoryPartition.java | 2 +- .../foundationdb/directory/package-info.java | 2 +- .../com/apple/foundationdb/package-info.java | 2 +- .../apple/foundationdb/subspace/Subspace.java | 2 +- .../foundationdb/subspace/package-info.java | 2 +- .../foundationdb/tuple/package-info.java | 2 +- bindings/java/src/main/overview.html.in | 24 +++++-------------- fdbclient/vexillographer/java.cs | 2 +- 13 files changed, 33 insertions(+), 45 deletions(-) diff --git a/bindings/java/src/main/com/apple/foundationdb/Database.java b/bindings/java/src/main/com/apple/foundationdb/Database.java index 6749da73af..628e1da471 100644 --- a/bindings/java/src/main/com/apple/foundationdb/Database.java +++ b/bindings/java/src/main/com/apple/foundationdb/Database.java @@ -160,7 +160,7 @@ public interface Database extends AutoCloseable, TransactionContext { * be unable to determine whether a transaction succeeded. In these cases, your * transaction may be executed twice. For more information about how to reason * about these situations see - * the FounationDB Developer Guide * * @param retryable the block of logic to execute in a {@link Transaction} against @@ -202,7 +202,7 @@ public interface Database extends AutoCloseable, TransactionContext { * be unable to determine whether a transaction succeeded. In these cases, your * transaction may be executed twice. For more information about how to reason * about these situations see - * the FounationDB Developer Guide
*
* Any errors encountered executing {@code retryable}, or received from the diff --git a/bindings/java/src/main/com/apple/foundationdb/FDB.java b/bindings/java/src/main/com/apple/foundationdb/FDB.java index 64192ac70e..55e392a851 100644 --- a/bindings/java/src/main/com/apple/foundationdb/FDB.java +++ b/bindings/java/src/main/com/apple/foundationdb/FDB.java @@ -180,7 +180,7 @@ public class FDB { /** * Connects to the cluster specified by the - * default fdb.cluster file. + * default fdb.cluster file. * If the FoundationDB network has not been started, it will be started in the course of this call * as if {@link FDB#startNetwork()} had been called. * @@ -199,9 +199,9 @@ public class FDB { * {@link #startNetwork()} had been called. * * @param clusterFilePath the - * cluster file + * cluster file * defining the FoundationDB cluster. This can be {@code null} if the - * default fdb.cluster file + * default fdb.cluster file * is to be used. * * @return a {@code CompletableFuture} that will be set to a FoundationDB {@code Cluster}. @@ -220,9 +220,9 @@ public class FDB { * are produced from using the resulting {@link Cluster}. * * @param clusterFilePath the - * cluster file + * cluster file * defining the FoundationDB cluster. This can be {@code null} if the - * default fdb.cluster file + * default fdb.cluster file * is to be used. * @param e used to run the FDB network thread * @@ -245,7 +245,7 @@ public class FDB { /** * Initializes networking, connects with the - * default fdb.cluster file, + * default fdb.cluster file, * and opens the database. * * @return a {@code CompletableFuture} that will be set to a FoundationDB {@link Database} @@ -259,9 +259,9 @@ public class FDB { * and opens the database. * * @param clusterFilePath the - * cluster file + * cluster file * defining the FoundationDB cluster. This can be {@code null} if the - * default fdb.cluster file + * default fdb.cluster file * is to be used. * * @return a {@code CompletableFuture} that will be set to a FoundationDB {@link Database} @@ -275,9 +275,9 @@ public class FDB { * and opens the database. * * @param clusterFilePath the - * cluster file + * cluster file * defining the FoundationDB cluster. This can be {@code null} if the - * default fdb.cluster file + * default fdb.cluster file * is to be used. * @param e the {@link Executor} to use to execute asynchronous callbacks * diff --git a/bindings/java/src/main/com/apple/foundationdb/KeySelector.java b/bindings/java/src/main/com/apple/foundationdb/KeySelector.java index b4db9e6359..789128ce6a 100644 --- a/bindings/java/src/main/com/apple/foundationdb/KeySelector.java +++ b/bindings/java/src/main/com/apple/foundationdb/KeySelector.java @@ -32,7 +32,7 @@ import com.apple.foundationdb.tuple.ByteArrayUtil; * {@link Transaction#getRange(KeySelector, KeySelector) getRange()}.
*
* For more about how key selectors work in practice, see - * the KeySelector documentation. + * the KeySelector documentation. * Note that the way the key selectors are resolved is somewhat non-intuitive, so * users who wish to use a key selector other than the default ones described below should * probably consult that documentation before proceeding. @@ -134,7 +134,7 @@ public class KeySelector { * poor choice for iterating through a large range. (Instead, use the keys * returned from a range query operation * themselves to create a new beginning {@code KeySelector}.) For more information see - * the KeySelector documentation. + * the KeySelector documentation. * * @param offset the number of keys to offset the {@code KeySelector}. This number can be * negative. diff --git a/bindings/java/src/main/com/apple/foundationdb/Transaction.java b/bindings/java/src/main/com/apple/foundationdb/Transaction.java index ad1a7814d8..2b87736d7b 100644 --- a/bindings/java/src/main/com/apple/foundationdb/Transaction.java +++ b/bindings/java/src/main/com/apple/foundationdb/Transaction.java @@ -34,12 +34,12 @@ import com.apple.foundationdb.tuple.Tuple; * the underlying database if and when the transaction is committed. Read operations do see the * effects of previous write operations on the same transaction. Committing a transaction usually * succeeds in the absence of - * conflicts.
+ * conflicts.
*
* Transactions group operations into a unit with the properties of atomicity, isolation, and * durability. Transactions also provide the ability to maintain an application's invariants or * integrity constraints, supporting the property of consistency. Together these properties are - * known as ACID.
+ * known as ACID.
*
* Transactions are also causally consistent: once a transaction has been successfully committed, * all subsequently created transactions will see the modifications made by it. @@ -49,7 +49,7 @@ import com.apple.foundationdb.tuple.Tuple; *
* Keys and values in FoundationDB are byte arrays. To encode other data types, see the * {@link Tuple Tuple API} and - * tuple layer documentation.
+ * tuple layer documentation.
*
* When used as a {@link TransactionContext}, the methods {@code run()} and * {@code runAsync()} on a {@code Transaction} will simply attempt the operations @@ -79,11 +79,11 @@ public interface Transaction extends AutoCloseable, ReadTransaction, Transaction /** * Return special-purpose, read-only view of the database. Reads done through this interface are known as "snapshot reads". * Snapshot reads selectively relax FoundationDB's isolation property, reducing - * Transaction conflicts + * Transaction conflicts * but making reasoning about concurrency harder.
*
* For more information about how to use snapshot reads correctly, see - * Using snapshot reads. + * Using snapshot reads. * * @return a read-only view of this {@code Transaction} with relaxed isolation properties */ diff --git a/bindings/java/src/main/com/apple/foundationdb/directory/DirectoryLayer.java b/bindings/java/src/main/com/apple/foundationdb/directory/DirectoryLayer.java index 035f64b298..681c8aa924 100644 --- a/bindings/java/src/main/com/apple/foundationdb/directory/DirectoryLayer.java +++ b/bindings/java/src/main/com/apple/foundationdb/directory/DirectoryLayer.java @@ -55,7 +55,7 @@ import com.apple.foundationdb.tuple.Tuple; * to manage its subspaces. * * For general guidance on directory usage, see the discussion in the - * Developer Guide. + * Developer Guide. *

*

* Directories are identified by hierarchical paths analogous to the paths diff --git a/bindings/java/src/main/com/apple/foundationdb/directory/DirectoryPartition.java b/bindings/java/src/main/com/apple/foundationdb/directory/DirectoryPartition.java index 22a479f1e1..36ed028c7e 100644 --- a/bindings/java/src/main/com/apple/foundationdb/directory/DirectoryPartition.java +++ b/bindings/java/src/main/com/apple/foundationdb/directory/DirectoryPartition.java @@ -38,7 +38,7 @@ import com.apple.foundationdb.tuple.Tuple; *

* * For general guidance on partition usage, see the - * Developer Guide. + * Developer Guide. */ class DirectoryPartition extends DirectorySubspace { diff --git a/bindings/java/src/main/com/apple/foundationdb/directory/package-info.java b/bindings/java/src/main/com/apple/foundationdb/directory/package-info.java index 206189cd0e..568ecd5a68 100644 --- a/bindings/java/src/main/com/apple/foundationdb/directory/package-info.java +++ b/bindings/java/src/main/com/apple/foundationdb/directory/package-info.java @@ -31,7 +31,7 @@ * used for the corresponding subspace. In effect, directories provide * a level of indirection for access to subspaces.
*
- * See general + * See general * directory documentation for information about how directories work and * interact with other parts of the built-in keyspace management features. */ diff --git a/bindings/java/src/main/com/apple/foundationdb/package-info.java b/bindings/java/src/main/com/apple/foundationdb/package-info.java index 953390b019..1bcb8223fa 100644 --- a/bindings/java/src/main/com/apple/foundationdb/package-info.java +++ b/bindings/java/src/main/com/apple/foundationdb/package-info.java @@ -29,7 +29,7 @@ * assure that {@link com.apple.foundationdb.Transaction#commit()} has returned successfully * before itself returning. If you are not able to use these functions for some reason * please closely read and understand the other - * developer + * developer * documentation on FoundationDB transactions. */ package com.apple.foundationdb; diff --git a/bindings/java/src/main/com/apple/foundationdb/subspace/Subspace.java b/bindings/java/src/main/com/apple/foundationdb/subspace/Subspace.java index dbebc75381..26bc34177e 100644 --- a/bindings/java/src/main/com/apple/foundationdb/subspace/Subspace.java +++ b/bindings/java/src/main/com/apple/foundationdb/subspace/Subspace.java @@ -38,7 +38,7 @@ import com.apple.foundationdb.tuple.Versionstamp; * *

* For general guidance on subspace usage, see the discussion in - * Developer Guide. + * Developer Guide. *

* *

diff --git a/bindings/java/src/main/com/apple/foundationdb/subspace/package-info.java b/bindings/java/src/main/com/apple/foundationdb/subspace/package-info.java index ee499123bb..2379d99d32 100644 --- a/bindings/java/src/main/com/apple/foundationdb/subspace/package-info.java +++ b/bindings/java/src/main/com/apple/foundationdb/subspace/package-info.java @@ -26,7 +26,7 @@ * from the result. As a best practice, API clients should use at least one * subspace for application data.
*
- * See general + * See general * subspace documentation for information about how subspaces work and * interact with other parts of the built-in keyspace management features. */ diff --git a/bindings/java/src/main/com/apple/foundationdb/tuple/package-info.java b/bindings/java/src/main/com/apple/foundationdb/tuple/package-info.java index 1025e793ee..be17e3b3fb 100644 --- a/bindings/java/src/main/com/apple/foundationdb/tuple/package-info.java +++ b/bindings/java/src/main/com/apple/foundationdb/tuple/package-info.java @@ -22,7 +22,7 @@ * Provides a set of utilities for serializing and deserializing typed data * for use in FoundationDB. When packed together into a {@link com.apple.foundationdb.tuple.Tuple} * this data is suitable for use as an index or organizational structure within FoundationDB - * keyspace. See general Tuple + * keyspace. See general Tuple * documentation for information about how Tuples sort and can be used to efficiently * model data. */ diff --git a/bindings/java/src/main/overview.html.in b/bindings/java/src/main/overview.html.in index 47860d27d1..7522d792d1 100644 --- a/bindings/java/src/main/overview.html.in +++ b/bindings/java/src/main/overview.html.in @@ -5,22 +5,10 @@ This documents the client API for using FoundationDB from Java.

Installation

FoundationDB's Java bindings rely on native libraries that are installed as part of the FoundationDB client binaries installation (see - -Installing FoundationDB client binaries). The FoundationDB Java bindings are available -through Artifactory. To use them in your Maven-enabled project, add a dependency to your -pom.xml like:
-
-{@code
-
-    com.apple.cie.foundationdb
-    fdb-java
-    VERSION
-
-}
-
-Alternatively, simply download the JAR from -Artifactory -and add it to your classpath.
+ +Installing FoundationDB client binaries). The JAR can be downloaded from +our website +and then added to your classpath.

Getting started

To start using FoundationDB from Java, create an instance of the @@ -30,7 +18,7 @@ With this API object you can then open {@link com.apple.foundationdb.Cluster Clu {@link com.apple.foundationdb.Database Database}s and start using {@link com.apple.foundationdb.Transaction Transaction}s. Here we give an example. The example relies on a cluster file at the -default location +default location for your platform and a running server.

@@ -69,7 +57,7 @@ cross-language support for storing and retrieving typed data from the
 binary data that FoundationDB supports. And, just as importantly, data packed into 
 {@code Tuple}s and used as keys sort in predictable and useful ways. See the 
 {@link com.apple.foundationdb.tuple Tuple class documentation} for information about use in Java
-and general Tuple documentation
+and general Tuple documentation
 for information about how Tuples sort and can be used to efficiently model data.
 

 
FoundationDB {@link com.apple.foundationdb.directory Directory API}

diff --git a/fdbclient/vexillographer/java.cs b/fdbclient/vexillographer/java.cs
index 192a4377bc..ba21eeec51 100644
--- a/fdbclient/vexillographer/java.cs
+++ b/fdbclient/vexillographer/java.cs
@@ -211,7 +211,7 @@ public class FDBException extends RuntimeException implements CloneableException
 
     /**
      * Gets the code for this error. A list of common errors codes
-     *  are published elsewhere within
+     *  are published elsewhere within
      *  our documentation.
      *
      * @return the internal FDB error code