Added API docs linking to estimatedDocumentCount

rozza · rozza · commit 4bf96c972ab0 · 2019-06-28T13:33:27.000+01:00
JAVA-3299
diff --git a/driver-async/src/main/com/mongodb/async/client/MongoCollection.java b/driver-async/src/main/com/mongodb/async/client/MongoCollection.java
@@ -229,7 +229,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -253,7 +254,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection according to the given options.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -278,7 +280,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection according to the given options.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -304,7 +307,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -330,7 +334,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection according to the given options.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -357,7 +362,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection according to the given options.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
diff --git a/driver-sync/src/main/com/mongodb/client/MongoCollection.java b/driver-sync/src/main/com/mongodb/client/MongoCollection.java
@@ -225,7 +225,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -249,7 +250,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection according to the given options.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -274,7 +276,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection according to the given options.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -300,7 +303,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -326,7 +330,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection according to the given options.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *
@@ -353,7 +358,8 @@ public interface MongoCollection<TDocument> {
      * Counts the number of documents in the collection according to the given options.
      *
      * <p>
-     * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
+     * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.
+     * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:
      * </p>
      * <pre>
      *

Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,8 @@ public interface MongoCollection<TDocument> {`
`229`	`229`	`* Counts the number of documents in the collection.`
`230`	`230`	`*`
`231`	`231`	`* <p>`
`232`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`232`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.`
	`233`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`233`	`234`	`* </p>`
`234`	`235`	`* <pre>`
`235`	`236`	`*`
`@@ -253,7 +254,8 @@ public interface MongoCollection<TDocument> {`
`253`	`254`	`* Counts the number of documents in the collection according to the given options.`
`254`	`255`	`*`
`255`	`256`	`* <p>`
`256`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`257`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.`
	`258`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`257`	`259`	`* </p>`
`258`	`260`	`* <pre>`
`259`	`261`	`*`
`@@ -278,7 +280,8 @@ public interface MongoCollection<TDocument> {`
`278`	`280`	`* Counts the number of documents in the collection according to the given options.`
`279`	`281`	`*`
`280`	`282`	`* <p>`
`281`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`283`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.`
	`284`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`282`	`285`	`* </p>`
`283`	`286`	`* <pre>`
`284`	`287`	`*`
`@@ -304,7 +307,8 @@ public interface MongoCollection<TDocument> {`
`304`	`307`	`* Counts the number of documents in the collection.`
`305`	`308`	`*`
`306`	`309`	`* <p>`
`307`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`310`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.`
	`311`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`308`	`312`	`* </p>`
`309`	`313`	`* <pre>`
`310`	`314`	`*`
`@@ -330,7 +334,8 @@ public interface MongoCollection<TDocument> {`
`330`	`334`	`* Counts the number of documents in the collection according to the given options.`
`331`	`335`	`*`
`332`	`336`	`* <p>`
`333`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`337`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.`
	`338`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`334`	`339`	`* </p>`
`335`	`340`	`* <pre>`
`336`	`341`	`*`
`@@ -357,7 +362,8 @@ public interface MongoCollection<TDocument> {`
`357`	`362`	`* Counts the number of documents in the collection according to the given options.`
`358`	`363`	`*`
`359`	`364`	`* <p>`
`360`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`365`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount(SingleResultCallback)}.`
	`366`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`361`	`367`	`* </p>`
`362`	`368`	`* <pre>`
`363`	`369`	`*`
Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,8 @@ public interface MongoCollection<TDocument> {`
`225`	`225`	`* Counts the number of documents in the collection.`
`226`	`226`	`*`
`227`	`227`	`* <p>`
`228`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`228`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.`
	`229`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`229`	`230`	`* </p>`
`230`	`231`	`* <pre>`
`231`	`232`	`*`
`@@ -249,7 +250,8 @@ public interface MongoCollection<TDocument> {`
`249`	`250`	`* Counts the number of documents in the collection according to the given options.`
`250`	`251`	`*`
`251`	`252`	`* <p>`
`252`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`253`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.`
	`254`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`253`	`255`	`* </p>`
`254`	`256`	`* <pre>`
`255`	`257`	`*`
`@@ -274,7 +276,8 @@ public interface MongoCollection<TDocument> {`
`274`	`276`	`* Counts the number of documents in the collection according to the given options.`
`275`	`277`	`*`
`276`	`278`	`* <p>`
`277`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`279`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.`
	`280`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`278`	`281`	`* </p>`
`279`	`282`	`* <pre>`
`280`	`283`	`*`
`@@ -300,7 +303,8 @@ public interface MongoCollection<TDocument> {`
`300`	`303`	`* Counts the number of documents in the collection.`
`301`	`304`	`*`
`302`	`305`	`* <p>`
`303`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`306`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.`
	`307`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`304`	`308`	`* </p>`
`305`	`309`	`* <pre>`
`306`	`310`	`*`
`@@ -326,7 +330,8 @@ public interface MongoCollection<TDocument> {`
`326`	`330`	`* Counts the number of documents in the collection according to the given options.`
`327`	`331`	`*`
`328`	`332`	`* <p>`
`329`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`333`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.`
	`334`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`330`	`335`	`* </p>`
`331`	`336`	`* <pre>`
`332`	`337`	`*`
`@@ -353,7 +358,8 @@ public interface MongoCollection<TDocument> {`
`353`	`358`	`* Counts the number of documents in the collection according to the given options.`
`354`	`359`	`*`
`355`	`360`	`* <p>`
`356`		`- * Note: When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
	`361`	`+ * Note: For a fast count of the total documents in a collection see {@link #estimatedDocumentCount()}.`
	`362`	`+ * When migrating from {@code count()} to {@code countDocuments()} the following query operators must be replaced:`
`357`	`363`	`* </p>`
`358`	`364`	`* <pre>`
`359`	`365`	`*`