Fixed some Javadoc errors in Filters, Projections, and Sorts.

jyemin · jyemin · commit 234959374107 · 2015-02-25T21:35:29.000-05:00
diff --git a/driver-core/src/main/com/mongodb/client/model/Filters.java b/driver-core/src/main/com/mongodb/client/model/Filters.java
@@ -55,77 +55,77 @@ private Filters() {
      *
      * @param fieldName the field name
      * @param value     the value
-     * @param <TField>  the value type
+     * @param <TItem>  the value type
      * @return the filter
      * @mongodb.driver.manual reference/operator/query/eq $eq
      */
-    public static <TField> Bson eq(final String fieldName, final TField value) {
-        return new SimpleEncodingFilter<TField>(fieldName, value);
+    public static <TItem> Bson eq(final String fieldName, final TItem value) {
+        return new SimpleEncodingFilter<TItem>(fieldName, value);
     }
 
     /**
      * Creates a filter that matches all documents where the value of the field name does not equal the specified value.
      *
      * @param fieldName the field name
      * @param value     the value
-     * @param <TField>  the value type
+     * @param <TItem>  the value type
      * @return the filter
      * @mongodb.driver.manual reference/operator/query/ne $ne
      */
-    public static <TField> Bson ne(final String fieldName, final TField value) {
-        return new OperatorFilter<TField>("$ne", fieldName, value);
+    public static <TItem> Bson ne(final String fieldName, final TItem value) {
+        return new OperatorFilter<TItem>("$ne", fieldName, value);
     }
 
     /**
      * Creates a filter that matches all documents where the value of the given field is greater than the specified value.
      *
      * @param fieldName the field name
      * @param value the value
-     * @param <TField> the value type
+     * @param <TItem> the value type
      * @return the filter
      * @mongodb.driver.manual reference/operator/query/gt $gt
      */
-    public static <TField> Bson gt(final String fieldName, final TField value) {
-        return new OperatorFilter<TField>("$gt", fieldName, value);
+    public static <TItem> Bson gt(final String fieldName, final TItem value) {
+        return new OperatorFilter<TItem>("$gt", fieldName, value);
     }
 
     /**
      * Creates a filter that matches all documents where the value of the given field is less than the specified value.
      *
      * @param fieldName the field name
      * @param value the value
-     * @param <TField> the value type
+     * @param <TItem> the value type
      * @return the filter
      * @mongodb.driver.manual reference/operator/query/lt $lt
      */
-    public static <TField> Bson lt(final String fieldName, final TField value) {
-        return new OperatorFilter<TField>("$lt", fieldName, value);
+    public static <TItem> Bson lt(final String fieldName, final TItem value) {
+        return new OperatorFilter<TItem>("$lt", fieldName, value);
     }
 
     /**
      * Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
      *
      * @param fieldName the field name
      * @param value the value
-     * @param <TField> the value type
+     * @param <TItem> the value type
      * @return the filter
      * @mongodb.driver.manual reference/operator/query/gte $gte
      */
-    public static <TField> Bson gte(final String fieldName, final TField value) {
-        return new OperatorFilter<TField>("$gte", fieldName, value);
+    public static <TItem> Bson gte(final String fieldName, final TItem value) {
+        return new OperatorFilter<TItem>("$gte", fieldName, value);
     }
 
     /**
      * Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
      *
      * @param fieldName the field name
      * @param value the value
-     * @param <TField> the value type
+     * @param <TItem> the value type
      * @return the filter
      * @mongodb.driver.manual reference/operator/query/lte $lte
      */
-    public static <TField> Bson lte(final String fieldName, final TField value) {
-        return new OperatorFilter<TField>("$lte", fieldName, value);
+    public static <TItem> Bson lte(final String fieldName, final TItem value) {
+        return new OperatorFilter<TItem>("$lte", fieldName, value);
     }
 
     /**
@@ -465,12 +465,12 @@ public <TDocument> BsonDocument toBsonDocument(final Class<TDocument> documentCl
         }
     }
 
-    private static final class OperatorFilter<TField> implements Bson {
+    private static final class OperatorFilter<TItem> implements Bson {
         private final String operatorName;
         private final String fieldName;
-        private final TField value;
+        private final TItem value;
 
-        OperatorFilter(final String operatorName, final String fieldName, final TField value) {
+        OperatorFilter(final String operatorName, final String fieldName, final TItem value) {
             this.operatorName = notNull("operatorName", operatorName);
             this.fieldName = notNull("fieldName", fieldName);
             this.value = value;
diff --git a/driver-core/src/main/com/mongodb/client/model/Projections.java b/driver-core/src/main/com/mongodb/client/model/Projections.java
@@ -31,9 +31,9 @@
 
 /**
  * A factory for projections.   A convenient way to use this class is to statically import all of its methods, which allows usage like:
- * <p/>
+ *
  * <blockquote><pre>
- *    collection.find().projection(fields(include("x", "y"), excludeId())
+ *    collection.find().projection(fields(include("x", "y"), excludeId()))
  * </pre></blockquote>
  *
  * @mongodb.driver.manual tutorial/project-fields-from-query-results/#limit-fields-to-return-from-a-query Projection
@@ -99,7 +99,7 @@ public static Bson excludeId() {
      *
      * @param fieldName the field name whose value is the array
      * @return the projection
-     * @mongodb.driver.manual reference/operator/projection/positional/#projection Project the first matchin element ($ operator)
+     * @mongodb.driver.manual reference/operator/projection/positional/#projection Project the first matching element ($ operator)
      */
     public static Bson elemMatch(final String fieldName) {
         return new BsonDocument(fieldName + ".$", new BsonInt32(1));
@@ -140,7 +140,7 @@ public static Bson metaTextScore(final String fieldName) {
      * @param fieldName the field name
      * @param limit the number of elements to project.
      * @return the projection
-     * @mongodb.driver.manual
+     * @mongodb.driver.manual reference/operator/projection/slice Slice
      */
     public static Bson slice(final String fieldName, final int limit) {
         return new BsonDocument(fieldName, new BsonDocument("$slice", new BsonInt32(limit)));
@@ -153,7 +153,7 @@ public static Bson slice(final String fieldName, final int limit) {
      * @param skip the number of elements to skip before applying the limit
      * @param limit the number of elements to project
      * @return the projection
-     * @mongodb.driver.manual
+     * @mongodb.driver.manual reference/operator/projection/slice Slice
      */
     public static Bson slice(final String fieldName, final int skip, final int limit) {
         return new BsonDocument(fieldName, new BsonDocument("$slice", new BsonArray(asList(new BsonInt32(skip), new BsonInt32(limit)))));
@@ -163,9 +163,8 @@ public static Bson slice(final String fieldName, final int skip, final int limit
      * Creates a projection that combines the list of projections into a single one.  If there are duplicate keys, the last one takes
      * precedence.
      *
-     * @param projections the list projections to combine
+     * @param projections the list of projections to combine
      * @return the combined projection
-     * @mongodb.driver.manual
      */
     public static Bson fields(final Bson... projections) {
         return fields(asList(projections));
@@ -175,7 +174,7 @@ public static Bson fields(final Bson... projections) {
      * Creates a projection that combines the list of projections into a single one.  If there are duplicate keys, the last one takes
      * precedence.
      *
-     * @param projections the list projections to combine
+     * @param projections the list of projections to combine
      * @return the combined projection
      * @mongodb.driver.manual
      */
diff --git a/driver-core/src/main/com/mongodb/client/model/Sorts.java b/driver-core/src/main/com/mongodb/client/model/Sorts.java
@@ -94,7 +94,7 @@ public static Bson descending(final List<String> fieldNames) {
      *
      * @param fieldName the field name
      * @return the sort specification
-     * @mongodb.driver.manual operator/projection/meta/#sort textScore
+     * @mongodb.driver.manual reference/operator/projection/meta/#sort textScore
      */
     public static Bson metaTextScore(final String fieldName) {
         return new BsonDocument(fieldName, new BsonDocument("$meta", new BsonString("textScore")));
@@ -104,7 +104,7 @@ public static Bson metaTextScore(final String fieldName) {
      * Combine multiple sort specifications.  If any field names are repeated, the last one takes precendence.
      *
      * @param sorts the sort specifications
-     * @return the combine sort specification
+     * @return the combined sort specification
      */
     public static Bson orderBy(final Bson... sorts) {
         return orderBy(asList(sorts));
@@ -114,7 +114,7 @@ public static Bson orderBy(final Bson... sorts) {
      * Combine multiple sort specifications.  If any field names are repeated, the last one takes precendence.
      *
      * @param sorts the sort specifications
-     * @return the combine sort specification
+     * @return the combined sort specification
      */
     public static Bson orderBy(final List<Bson> sorts) {
         notNull("sorts", sorts);
