Skip to content

Commit 23ef136

Browse files
vbabaninvbabanin
committed
Replace fully-qualified KDoc references with imports in Kotlin timeout docs
- Add imports for MongoClientSettings, ClientSessionOptions, and TransactionOptions to use short names in KDoc links instead of fully-qualified com.mongodb.* references - Shorten pre-existing fully-qualified KDoc references for ReadPreference, WriteConcern, and MongoClientSettings.getRetryWrites in MongoCollection and MongoCluster JAVA-6122
1 parent 6b0c88b commit 23ef136

File tree

6 files changed

+45
-31
lines changed

6 files changed

+45
-31
lines changed

‎driver-kotlin-coroutine/src/main/kotlin/com/mongodb/kotlin/client/coroutine/MongoCluster.kt‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import com.mongodb.MongoClientSettings
2121
import com.mongodb.MongoException
2222
import com.mongodb.ReadConcern
2323
import com.mongodb.ReadPreference
24+
import com.mongodb.TransactionOptions
2425
import com.mongodb.WriteConcern
2526
import com.mongodb.annotations.Alpha
2627
import com.mongodb.annotations.Reason
@@ -86,8 +87,8 @@ public open class MongoCluster protected constructor(private val wrapped: JMongo
8687
* - [MongoCluster.withTimeout] (current)
8788
* - [MongoDatabase.withTimeout]
8889
* - [MongoCollection.withTimeout]
89-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
90-
* - [com.mongodb.TransactionOptions.Builder.timeout]
90+
* - [ClientSessionOptions.Builder.defaultTimeout]
91+
* - [TransactionOptions.Builder.timeout]
9192
*
9293
* If not set at a given level, the timeout is inherited from the level above.
9394
*
@@ -153,8 +154,8 @@ public open class MongoCluster protected constructor(private val wrapped: JMongo
153154
* - [MongoCluster.withTimeout] (current)
154155
* - [MongoDatabase.withTimeout]
155156
* - [MongoCollection.withTimeout]
156-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
157-
* - [com.mongodb.TransactionOptions.Builder.timeout]
157+
* - [ClientSessionOptions.Builder.defaultTimeout]
158+
* - [TransactionOptions.Builder.timeout]
158159
*
159160
* If not set at a given level, the timeout is inherited from the level above.
160161
*

‎driver-kotlin-coroutine/src/main/kotlin/com/mongodb/kotlin/client/coroutine/MongoCollection.kt‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@
1515
*/
1616
package com.mongodb.kotlin.client.coroutine
1717

18+
import com.mongodb.ClientSessionOptions
19+
import com.mongodb.MongoClientSettings
1820
import com.mongodb.MongoNamespace
1921
import com.mongodb.ReadConcern
2022
import com.mongodb.ReadPreference
23+
import com.mongodb.TransactionOptions
2124
import com.mongodb.WriteConcern
2225
import com.mongodb.annotations.Alpha
2326
import com.mongodb.annotations.Reason
@@ -110,8 +113,8 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
110113
* - [MongoCluster.withTimeout]
111114
* - [MongoDatabase.withTimeout]
112115
* - [MongoCollection.withTimeout] (current)
113-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
114-
* - [com.mongodb.TransactionOptions.Builder.timeout]
116+
* - [ClientSessionOptions.Builder.defaultTimeout]
117+
* - [TransactionOptions.Builder.timeout]
115118
*
116119
* If not set at a given level, the timeout is inherited from the level above.
117120
*
@@ -163,7 +166,7 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
163166
/**
164167
* Create a new collection instance with a different read preference.
165168
*
166-
* @param newReadPreference the new [com.mongodb.ReadPreference] for the collection
169+
* @param newReadPreference the new [ReadPreference] for the collection
167170
* @return a new MongoCollection instance with the different readPreference
168171
*/
169172
public fun withReadPreference(newReadPreference: ReadPreference): MongoCollection<T> =
@@ -182,7 +185,7 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
182185
/**
183186
* Create a new collection instance with a different write concern.
184187
*
185-
* @param newWriteConcern the new [com.mongodb.WriteConcern] for the collection
188+
* @param newWriteConcern the new [WriteConcern] for the collection
186189
* @return a new MongoCollection instance with the different writeConcern
187190
*/
188191
public fun withWriteConcern(newWriteConcern: WriteConcern): MongoCollection<T> =
@@ -198,8 +201,8 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
198201
* - [MongoCluster.withTimeout]
199202
* - [MongoDatabase.withTimeout]
200203
* - [MongoCollection.withTimeout] (current)
201-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
202-
* - [com.mongodb.TransactionOptions.Builder.timeout]
204+
* - [ClientSessionOptions.Builder.defaultTimeout]
205+
* - [TransactionOptions.Builder.timeout]
203206
*
204207
* If not set at a given level, the timeout is inherited from the level above.
205208
*

‎driver-kotlin-coroutine/src/main/kotlin/com/mongodb/kotlin/client/coroutine/MongoDatabase.kt‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@
1515
*/
1616
package com.mongodb.kotlin.client.coroutine
1717

18+
import com.mongodb.ClientSessionOptions
19+
import com.mongodb.MongoClientSettings
1820
import com.mongodb.ReadConcern
1921
import com.mongodb.ReadPreference
22+
import com.mongodb.TransactionOptions
2023
import com.mongodb.WriteConcern
2124
import com.mongodb.annotations.Alpha
2225
import com.mongodb.annotations.Reason
@@ -78,8 +81,8 @@ public class MongoDatabase(private val wrapped: JMongoDatabase) {
7881
* - [MongoCluster.withTimeout]
7982
* - [MongoDatabase.withTimeout] (current)
8083
* - [MongoCollection.withTimeout]
81-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
82-
* - [com.mongodb.TransactionOptions.Builder.timeout]
84+
* - [ClientSessionOptions.Builder.defaultTimeout]
85+
* - [TransactionOptions.Builder.timeout]
8386
*
8487
* If not set at a given level, the timeout is inherited from the level above.
8588
*
@@ -146,8 +149,8 @@ public class MongoDatabase(private val wrapped: JMongoDatabase) {
146149
* - [MongoCluster.withTimeout]
147150
* - [MongoDatabase.withTimeout] (current)
148151
* - [MongoCollection.withTimeout]
149-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
150-
* - [com.mongodb.TransactionOptions.Builder.timeout]
152+
* - [ClientSessionOptions.Builder.defaultTimeout]
153+
* - [TransactionOptions.Builder.timeout]
151154
*
152155
* If not set at a given level, the timeout is inherited from the level above.
153156
*

‎driver-kotlin-sync/src/main/kotlin/com/mongodb/kotlin/client/MongoCluster.kt‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import com.mongodb.MongoClientSettings
2121
import com.mongodb.MongoException
2222
import com.mongodb.ReadConcern
2323
import com.mongodb.ReadPreference
24+
import com.mongodb.TransactionOptions
2425
import com.mongodb.WriteConcern
2526
import com.mongodb.annotations.Alpha
2627
import com.mongodb.annotations.Reason
@@ -83,8 +84,8 @@ public open class MongoCluster protected constructor(private val wrapped: JMongo
8384
* - [MongoCluster.withTimeout] (current)
8485
* - [MongoDatabase.withTimeout]
8586
* - [MongoCollection.withTimeout]
86-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
87-
* - [com.mongodb.TransactionOptions.Builder.timeout]
87+
* - [ClientSessionOptions.Builder.defaultTimeout]
88+
* - [TransactionOptions.Builder.timeout]
8889
*
8990
* If not set at a given level, the timeout is inherited from the level above.
9091
*
@@ -154,8 +155,8 @@ public open class MongoCluster protected constructor(private val wrapped: JMongo
154155
* - [MongoCluster.withTimeout] (current)
155156
* - [MongoDatabase.withTimeout]
156157
* - [MongoCollection.withTimeout]
157-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
158-
* - [com.mongodb.TransactionOptions.Builder.timeout]
158+
* - [ClientSessionOptions.Builder.defaultTimeout]
159+
* - [TransactionOptions.Builder.timeout]
159160
*
160161
* If not set at a given level, the timeout is inherited from the level above.
161162
*
@@ -421,9 +422,9 @@ public open class MongoCluster protected constructor(private val wrapped: JMongo
421422
/**
422423
* Executes a client-level bulk write operation.
423424
*
424-
* This operation supports [retryable writes][com.mongodb.MongoClientSettings.getRetryWrites]. Depending on the
425-
* number of `models`, encoded size of `models`, and the size limits in effect, executing this operation may require
426-
* multiple `bulkWrite` commands. The eligibility for retries is determined per each `bulkWrite` command:
425+
* This operation supports [retryable writes][MongoClientSettings.getRetryWrites]. Depending on the number of
426+
* `models`, encoded size of `models`, and the size limits in effect, executing this operation may require multiple
427+
* `bulkWrite` commands. The eligibility for retries is determined per each `bulkWrite` command:
427428
* [ClientNamespacedUpdateManyModel], [ClientNamespacedDeleteManyModel] in a command render it non-retryable.
428429
*
429430
* @param clientSession The [client session][ClientSession] with which to associate this operation.

‎driver-kotlin-sync/src/main/kotlin/com/mongodb/kotlin/client/MongoCollection.kt‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@
1515
*/
1616
package com.mongodb.kotlin.client
1717

18+
import com.mongodb.ClientSessionOptions
19+
import com.mongodb.MongoClientSettings
1820
import com.mongodb.MongoNamespace
1921
import com.mongodb.ReadConcern
2022
import com.mongodb.ReadPreference
23+
import com.mongodb.TransactionOptions
2124
import com.mongodb.WriteConcern
2225
import com.mongodb.annotations.Alpha
2326
import com.mongodb.annotations.Reason
@@ -107,8 +110,8 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
107110
* - [MongoCluster.withTimeout]
108111
* - [MongoDatabase.withTimeout]
109112
* - [MongoCollection.withTimeout] (current)
110-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
111-
* - [com.mongodb.TransactionOptions.Builder.timeout]
113+
* - [ClientSessionOptions.Builder.defaultTimeout]
114+
* - [TransactionOptions.Builder.timeout]
112115
*
113116
* If not set at a given level, the timeout is inherited from the level above.
114117
*
@@ -163,7 +166,7 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
163166
/**
164167
* Create a new collection instance with a different read preference.
165168
*
166-
* @param newReadPreference the new [com.mongodb.ReadPreference] for the collection
169+
* @param newReadPreference the new [ReadPreference] for the collection
167170
* @return a new MongoCollection instance with the different readPreference
168171
*/
169172
public fun withReadPreference(newReadPreference: ReadPreference): MongoCollection<T> =
@@ -182,7 +185,7 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
182185
/**
183186
* Create a new collection instance with a different write concern.
184187
*
185-
* @param newWriteConcern the new [com.mongodb.WriteConcern] for the collection
188+
* @param newWriteConcern the new [WriteConcern] for the collection
186189
* @return a new MongoCollection instance with the different writeConcern
187190
*/
188191
public fun withWriteConcern(newWriteConcern: WriteConcern): MongoCollection<T> =
@@ -198,8 +201,8 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
198201
* - [MongoCluster.withTimeout]
199202
* - [MongoDatabase.withTimeout]
200203
* - [MongoCollection.withTimeout] (current)
201-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
202-
* - [com.mongodb.TransactionOptions.Builder.timeout]
204+
* - [ClientSessionOptions.Builder.defaultTimeout]
205+
* - [TransactionOptions.Builder.timeout]
203206
*
204207
* If not set at a given level, the timeout is inherited from the level above.
205208
*

‎driver-kotlin-sync/src/main/kotlin/com/mongodb/kotlin/client/MongoDatabase.kt‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@
1515
*/
1616
package com.mongodb.kotlin.client
1717

18+
import com.mongodb.ClientSessionOptions
19+
import com.mongodb.MongoClientSettings
1820
import com.mongodb.ReadConcern
1921
import com.mongodb.ReadPreference
22+
import com.mongodb.TransactionOptions
2023
import com.mongodb.WriteConcern
2124
import com.mongodb.annotations.Alpha
2225
import com.mongodb.annotations.Reason
@@ -76,8 +79,8 @@ public class MongoDatabase(private val wrapped: JMongoDatabase) {
7679
* - [MongoCluster.withTimeout]
7780
* - [MongoDatabase.withTimeout] (current)
7881
* - [MongoCollection.withTimeout]
79-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
80-
* - [com.mongodb.TransactionOptions.Builder.timeout]
82+
* - [ClientSessionOptions.Builder.defaultTimeout]
83+
* - [TransactionOptions.Builder.timeout]
8184
*
8285
* If not set at a given level, the timeout is inherited from the level above.
8386
*
@@ -147,8 +150,8 @@ public class MongoDatabase(private val wrapped: JMongoDatabase) {
147150
* - [MongoCluster.withTimeout]
148151
* - [MongoDatabase.withTimeout] (current)
149152
* - [MongoCollection.withTimeout]
150-
* - [com.mongodb.ClientSessionOptions.Builder.defaultTimeout]
151-
* - [com.mongodb.TransactionOptions.Builder.timeout]
153+
* - [ClientSessionOptions.Builder.defaultTimeout]
154+
* - [TransactionOptions.Builder.timeout]
152155
*
153156
* If not set at a given level, the timeout is inherited from the level above.
154157
*

0 commit comments

Comments
 (0)