Skip to content

Commit 4000d44

Browse files
authored
Update specifications links in source comments (#1662)
JAVA-5636
1 parent a3054ba commit 4000d44

24 files changed

+41
-42
lines changed

bson/src/main/org/bson/json/JsonMode.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,15 @@ public enum JsonMode {
4343
* Standard extended JSON representation.
4444
*
4545
* @since 3.5
46-
* @see <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst">Extended JSON Specification</a>
46+
* @see <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md">Extended JSON Specification</a>
4747
*/
4848
EXTENDED,
4949

5050
/**
5151
* Standard relaxed extended JSON representation.
5252
*
5353
* @since 3.5
54-
* @see <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst">Extended JSON Specification</a>
54+
* @see <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md">Extended JSON Specification</a>
5555
*/
5656
RELAXED
5757
}

bson/src/main/org/bson/types/Decimal128.java

+5-6
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,18 @@
1818

1919
import java.math.BigDecimal;
2020
import java.math.BigInteger;
21-
import java.util.HashSet;
22-
import java.util.Set;
23-
2421
import static java.math.MathContext.DECIMAL128;
2522
import static java.util.Arrays.asList;
2623
import static java.util.Collections.singletonList;
24+
import java.util.HashSet;
25+
import java.util.Set;
2726

2827
/**
2928
* A binary integer decimal representation of a 128-bit decimal value, supporting 34 decimal digits of significand and an exponent range
3029
* of -6143 to +6144.
3130
*
3231
* @since 3.4
33-
* @see <a href="https://github.com/mongodb/specifications/blob/master/source/bson-decimal128/decimal128.rst">BSON Decimal128
32+
* @see <a href="https://github.com/mongodb/specifications/blob/master/source/bson-decimal128/decimal128.md">BSON Decimal128
3433
* specification</a>
3534
* @see <a href="https://en.wikipedia.org/wiki/Binary_Integer_Decimal">binary integer decimal</a>
3635
* @see <a href="https://en.wikipedia.org/wiki/Decimal128_floating-point_format">decimal128 floating-point format</a>
@@ -110,7 +109,7 @@ public final class Decimal128 extends Number implements Comparable<Decimal128> {
110109
* @return the Decimal128 value representing the given String
111110
* @throws NumberFormatException if the value is out of the Decimal128 range
112111
* @see
113-
* <a href="https://github.com/mongodb/specifications/blob/master/source/bson-decimal128/decimal128.rst#from-string-representation">
112+
* <a href="https://github.com/mongodb/specifications/blob/master/source/bson-decimal128/decimal128.md#from-string-representation">
114113
* From-String Specification</a>
115114
*/
116115
public static Decimal128 parse(final String value) {
@@ -565,7 +564,7 @@ public int hashCode() {
565564
* Returns the String representation of the Decimal128 value.
566565
*
567566
* @return the String representation
568-
* @see <a href="https://github.com/mongodb/specifications/blob/master/source/bson-decimal128/decimal128.rst#to-string-representation">
567+
* @see <a href="https://github.com/mongodb/specifications/blob/master/source/bson-decimal128/decimal128.md#to-string-representation">
569568
* To-String Sprecification</a>
570569
*/
571570
@Override

driver-core/src/main/com/mongodb/internal/connection/Cluster.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ void selectServerAsync(ServerSelector serverSelector, OperationContext operation
8383

8484
/**
8585
* This method allows {@link Server}s to notify the {@link Cluster} about changes in their state as per the
86-
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst">
86+
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.md">
8787
* Server Discovery And Monitoring</a> specification.
8888
*/
8989
void onChange(ServerDescriptionChangedEvent event);

driver-core/src/main/com/mongodb/internal/connection/DefaultConnectionPool.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ final class DefaultConnectionPool implements ConnectionPool {
149149

150150
/**
151151
* @param sdamProvider For handling exceptions via the
152-
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst">
152+
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.md">
153153
* SDAM</a> machinery as specified
154-
* <a href="https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst#populating-the-pool-with-a-connection-internal-implementation">
154+
* <a href="https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.md#populating-the-pool-with-a-connection-internal-implementation">
155155
* here</a>.
156156
* Must provide an {@linkplain Optional#isPresent() empty} {@link Optional} if created in load-balanced mode,
157157
* otherwise must provide a non-empty {@link Optional}.
@@ -511,7 +511,7 @@ private void connectionPoolCreated(final ConnectionPoolListener connectionPoolLi
511511
* @return A {@link StartTime} before executing {@link ConnectionPoolListener#connectionCreated(ConnectionCreatedEvent)}
512512
* and logging the event. This order is required by
513513
514-
* <a href="https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst#events">CMAP</a>
514+
* <a href="https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.md#events">CMAP</a>
515515
* and {@link ConnectionReadyEvent#getElapsedTime(TimeUnit)}.
516516
*/
517517
private StartTime connectionCreated(final ConnectionPoolListener connectionPoolListener, final ConnectionId connectionId) {
@@ -570,7 +570,7 @@ private void connectionCheckedOut(
570570
* @return A {@link StartTime} before executing
571571
* {@link ConnectionPoolListener#connectionCheckOutStarted(ConnectionCheckOutStartedEvent)} and logging the event.
572572
* This order is required by
573-
* <a href="https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst#events">CMAP</a>
573+
* <a href="https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.md#events">CMAP</a>
574574
* and {@link ConnectionCheckedOutEvent#getElapsedTime(TimeUnit)}, {@link ConnectionCheckOutFailedEvent#getElapsedTime(TimeUnit)}.
575575
*/
576576
private StartTime connectionCheckoutStarted(final OperationContext operationContext) {
@@ -1425,7 +1425,7 @@ Timeout timeout() {
14251425
* {@link #runOnceAndStop()} unless {@link BackgroundMaintenanceManager} is {@linkplain #close() closed}.
14261426
* <p>
14271427
* This class implements
1428-
* <a href="https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst#background-thread">
1428+
* <a href="https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.md#background-thread">
14291429
* CMAP background thread</a>.
14301430
*/
14311431
@NotThreadSafe

driver-core/src/main/com/mongodb/internal/connection/SdamServerDescriptionManager.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
/**
4040
* See the
41-
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst">
41+
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.md">
4242
* Server Discovery And Monitoring</a> specification.
4343
*/
4444
@ThreadSafe

driver-core/src/main/com/mongodb/internal/connection/Server.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public interface Server {
5353

5454
/**
5555
* An approximation of the
56-
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#operationcount">
56+
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.md#operationcount">
5757
* number of operations that this server is currently executing</a>.
5858
*
5959
* @return A negative value iff the server does not track its operation count.

driver-core/src/test/functional/com/mongodb/internal/operation/ChangeStreamOperationProseTestSpecification.groovy

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ import static com.mongodb.ClusterFixture.serverVersionLessThan
4242
import static com.mongodb.internal.connection.ServerHelper.waitForLastRelease
4343
import static java.util.Arrays.asList
4444

45-
// See https://github.com/mongodb/specifications/tree/master/source/change-streams/tests/README.rst#prose-tests
45+
// See https://github.com/mongodb/specifications/tree/master/source/change-streams/tests/README.md#prose-tests
4646
@IgnoreIf({ !(serverVersionAtLeast(3, 6) && !isStandalone()) })
4747
class ChangeStreamOperationProseTestSpecification extends OperationFunctionalSpecification {
4848

driver-core/src/test/resources/client-side-encryption/README.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ and MUST be implemented by all drivers.
2727
Spec Test Format
2828
================
2929

30-
The spec tests format is an extension of `transactions spec tests <https://github.com/mongodb/specifications/blob/master/source/transactions/tests/README.rst>`_ with some additions:
30+
The spec tests format is an extension of `transactions spec tests <https://github.com/mongodb/specifications/blob/master/source/transactions/tests/README.md>`_ with some additions:
3131

3232
- A ``json_schema`` to set on the collection used for operations.
3333

@@ -182,7 +182,7 @@ Then for each element in ``tests``:
182182
183183
{"create": <collection>, "validator": {"$jsonSchema": <json_schema>}}
184184
185-
If ``encrypted_fields`` is defined in the test, the required collections and index described in `Create and Drop Collection Helpers <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#queryable-encryption-create-and-drop-collection-helpers>`_ must be created:
185+
If ``encrypted_fields`` is defined in the test, the required collections and index described in `Create and Drop Collection Helpers <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#queryable-encryption-create-and-drop-collection-helpers>`_ must be created:
186186

187187
- Use the ``dropCollection`` helper with ``encrypted_fields`` as an option and writeConcern "majority".
188188
- Use the ``createCollection`` helper with ``encrypted_fields`` as an option.
@@ -610,15 +610,15 @@ Using ``client_encrypted`` perform the following operations:
610610

611611
- ``{ "_id": "over_2mib_2", "unencrypted": <the string "a" repeated (2097152) times> }``
612612

613-
Expect the bulk write to succeed and split after first doc (i.e. two inserts occur). This may be verified using `command monitoring <https://github.com/mongodb/specifications/tree/master/source/command-logging-and-monitoring/command-logging-and-monitoring.rst>`_.
613+
Expect the bulk write to succeed and split after first doc (i.e. two inserts occur). This may be verified using `command monitoring <https://github.com/mongodb/specifications/tree/master/source/command-logging-and-monitoring/command-logging-and-monitoring.md>`_.
614614

615615
#. Bulk insert the following:
616616

617617
- The document `limits/limits-doc.json <../limits/limits-doc.json>`_ concatenated with ``{ "_id": "encryption_exceeds_2mib_1", "unencrypted": < the string "a" repeated (2097152 - 2000) times > }``
618618

619619
- The document `limits/limits-doc.json <../limits/limits-doc.json>`_ concatenated with ``{ "_id": "encryption_exceeds_2mib_2", "unencrypted": < the string "a" repeated (2097152 - 2000) times > }``
620620

621-
Expect the bulk write to succeed and split after first doc (i.e. two inserts occur). This may be verified using `command logging and monitoring <https://github.com/mongodb/specifications/tree/master/source/command-logging-and-monitoring/command-logging-and-monitoring.rst>`_.
621+
Expect the bulk write to succeed and split after first doc (i.e. two inserts occur). This may be verified using `command logging and monitoring <https://github.com/mongodb/specifications/tree/master/source/command-logging-and-monitoring/command-logging-and-monitoring.md>`_.
622622

623623
#. Insert ``{ "_id": "under_16mib", "unencrypted": <the string "a" repeated 16777216 - 2000 times>``.
624624

@@ -1661,7 +1661,7 @@ Load the file `key1-document.json <https://github.com/mongodb/specifications/tre
16611661

16621662
Read the ``"_id"`` field of ``key1Document`` as ``key1ID``.
16631663

1664-
Drop and create the collection ``db.explicit_encryption`` using ``encryptedFields`` as an option. See `FLE 2 CreateCollection() and Collection.Drop() <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#fle-2-createcollection-and-collection-drop>`_.
1664+
Drop and create the collection ``db.explicit_encryption`` using ``encryptedFields`` as an option. See `FLE 2 CreateCollection() and Collection.Drop() <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#fle-2-createcollection-and-collection-drop>`_.
16651665

16661666
Drop and create the collection ``keyvault.datakeys``.
16671667

driver-core/src/test/unit/com/mongodb/internal/connection/AbstractConnectionPoolTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
import static org.mockito.Mockito.mock;
9494

9595
// Implementation of
96-
// https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst
96+
// https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.md
9797
// specification tests
9898
@SuppressWarnings("deprecation")
9999
@RunWith(Parameterized.class)

driver-core/src/test/unit/com/mongodb/internal/connection/ConnectionPoolAsyncTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
import java.util.concurrent.Callable;
2929

3030
// Implementation of
31-
// https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst
31+
// https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.md
3232
// specification tests
3333
@RunWith(Parameterized.class)
3434
public class ConnectionPoolAsyncTest extends AbstractConnectionPoolTest {

driver-core/src/test/unit/com/mongodb/internal/connection/ConnectionPoolTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import java.util.concurrent.Callable;
2828

2929
// Implementation of
30-
// https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.rst
30+
// https://github.com/mongodb/specifications/blob/master/source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.md
3131
// specification tests
3232
@RunWith(Parameterized.class)
3333
public class ConnectionPoolTest extends AbstractConnectionPoolTest {

driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/AtlasSearchIndexManagementProseTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import com.mongodb.reactivestreams.client.syncadapter.SyncMongoClient;
2424

2525
/**
26-
* See <a href="https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.rst#search-index-management-helpers">Search Index Management Tests</a>
26+
* See <a href="https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.md#search-index-management-helpers">Search Index Management Tests</a>
2727
*/
2828
public class AtlasSearchIndexManagementProseTest extends AbstractAtlasSearchIndexManagementProseTest {
2929
protected MongoClient createMongoClient(final MongoClientSettings settings) {

driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/RetryableWritesProseTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040

4141
/**
4242
* See
43-
* <a href="https://github.com/mongodb/specifications/blob/master/source/retryable-writes/tests/README.rst#prose-tests">Retryable Write Prose Tests</a>.
43+
* <a href="https://github.com/mongodb/specifications/blob/master/source/retryable-writes/tests/README.md#prose-tests">Retryable Write Prose Tests</a>.
4444
*/
4545
public class RetryableWritesProseTest extends DatabaseTestCase {
4646
private CollectionHelper<Document> collectionHelper;

driver-reactive-streams/src/test/functional/com/mongodb/reactivestreams/client/WriteConcernProseTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
import static org.junit.jupiter.api.Assertions.fail;
4040
import static org.junit.jupiter.api.Assumptions.assumeTrue;
4141

42-
// See https://github.com/mongodb/specifications/tree/master/source/change-streams/tests/README.rst#prose-tests
42+
// See https://github.com/mongodb/specifications/tree/master/source/change-streams/tests/README.md#prose-tests
4343
public class WriteConcernProseTest extends DatabaseTestCase {
4444
private BsonDocument failPointDocument;
4545
private CollectionHelper<Document> collectionHelper;

driver-sync/src/test/functional/com/mongodb/client/AbstractServerSelectionProseTest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@
5353

5454
/**
5555
* See prose tests in
56-
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection-tests.rst">
56+
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection-tests.md">
5757
* "Server Selection Test Plan"</a>.
5858
*/
5959
public abstract class AbstractServerSelectionProseTest {
6060
/**
61-
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection-tests.rst#prose-test">
61+
* <a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection-tests.md#prose-test">
6262
* {@code operationCount}-based Selection Within Latency Window</a>.
6363
*/
6464
@Test

driver-sync/src/test/functional/com/mongodb/client/AbstractSessionsProseTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
import static org.junit.jupiter.api.Assumptions.assumeTrue;
5454

5555
// Prose tests for Sessions specification: https://github.com/mongodb/specifications/tree/master/source/sessions
56-
// Prose test README: https://github.com/mongodb/specifications/tree/master/source/sessions/tests/README.rst
56+
// Prose test README: https://github.com/mongodb/specifications/tree/master/source/sessions/tests/README.md
5757
public abstract class AbstractSessionsProseTest {
5858

5959
private static final int MONGOCRYPTD_PORT = 47017;

driver-sync/src/test/functional/com/mongodb/client/AtlasSearchIndexManagementProseTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import com.mongodb.MongoClientSettings;
2020

2121
/**
22-
* See <a href="https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.rst#search-index-management-helpers">Search Index Management Tests</a>
22+
* See <a href="https://github.com/mongodb/specifications/blob/master/source/index-management/tests/README.md#search-index-management-helpers">Search Index Management Tests</a>
2323
*/
2424
public class AtlasSearchIndexManagementProseTest extends AbstractAtlasSearchIndexManagementProseTest {
2525
protected MongoClient createMongoClient(final MongoClientSettings settings) {

driver-sync/src/test/functional/com/mongodb/client/ChangeStreamProseTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
import static org.junit.jupiter.api.Assumptions.assumeTrue;
5454

5555

56-
// See https://github.com/mongodb/specifications/tree/master/source/change-streams/tests/README.rst#prose-tests
56+
// See https://github.com/mongodb/specifications/tree/master/source/change-streams/tests/README.md#prose-tests
5757
public class ChangeStreamProseTest extends DatabaseTestCase {
5858
private BsonDocument failPointDocument;
5959

driver-sync/src/test/functional/com/mongodb/client/ClientSideOperationTimeoutProseTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323

2424
/**
25-
* See https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/tests/README.rst#prose-tests
25+
* See https://github.com/mongodb/specifications/blob/master/source/client-side-operations-timeout/tests/README.md#prose-tests
2626
*/
2727
public final class ClientSideOperationTimeoutProseTest extends AbstractClientSideOperationsTimeoutProseTest {
2828

driver-sync/src/test/functional/com/mongodb/client/RetryableWritesProseTest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585

8686
/**
8787
* See
88-
* <a href="https://github.com/mongodb/specifications/blob/master/source/retryable-writes/tests/README.rst#prose-tests">Retryable Write Prose Tests</a>.
88+
* <a href="https://github.com/mongodb/specifications/blob/master/source/retryable-writes/tests/README.md#prose-tests">Retryable Write Prose Tests</a>.
8989
*/
9090
public class RetryableWritesProseTest extends DatabaseTestCase {
9191

@@ -158,7 +158,7 @@ public static <R> void poolClearedExceptionMustBeRetryable(
158158
.applyToServerSettings(builder -> builder
159159
/* We fake server's state by configuring a fail point. This breaks the mechanism of the
160160
* streaming server monitoring protocol
161-
* (https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-monitoring.rst#streaming-protocol)
161+
* (https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-monitoring.md#streaming-protocol)
162162
* that allows the server to determine whether or not it needs to send a new state to the client.
163163
* As a result, the client has to wait for at least its heartbeat delay until it hears back from a server
164164
* (while it waits for a response, calling `ServerMonitor.connect` has no effect).

0 commit comments

Comments
 (0)