Browse Source

DATAMONGO-1234 - Fix typos in JavaDoc.

pull/300/head
Eddú Meléndez 11 years ago committed by Oliver Gierke
parent
commit
62fbe4d08c
  1. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CursorPreparer.java
  2. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoAction.java
  3. 4
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoDbUtils.java
  4. 6
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ExposedFields.java
  5. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/MongoPersistentEntityIndexResolver.java
  6. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/MongoPersistentProperty.java
  7. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java
  8. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/TextCriteria.java
  9. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Update.java
  10. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/Query.java
  11. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/support/MongoAnnotationProcessor.java
  12. 2
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/Contact.java

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CursorPreparer.java

@ -25,7 +25,7 @@ import com.mongodb.DBCursor;
interface CursorPreparer { interface CursorPreparer {
/** /**
* Prepare the given cursor (apply limits, skips and so on). Returns th eprepared cursor. * Prepare the given cursor (apply limits, skips and so on). Returns the prepared cursor.
* *
* @param cursor * @param cursor
*/ */

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoAction.java

@ -49,7 +49,7 @@ public class MongoAction {
* @param collectionName the collection name, must not be {@literal null} or empty. * @param collectionName the collection name, must not be {@literal null} or empty.
* @param entityType the POJO that is being operated against * @param entityType the POJO that is being operated against
* @param document the converted DBObject from the POJO or Spring Update object * @param document the converted DBObject from the POJO or Spring Update object
* @param query the converted DBOjbect from the Spring Query object * @param query the converted DBObject from the Spring Query object
*/ */
public MongoAction(WriteConcern defaultWriteConcern, MongoActionOperation mongoActionOperation, public MongoAction(WriteConcern defaultWriteConcern, MongoActionOperation mongoActionOperation,
String collectionName, Class<?> entityType, DBObject document, DBObject query) { String collectionName, Class<?> entityType, DBObject document, DBObject query) {

4
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoDbUtils.java

@ -199,8 +199,8 @@ public abstract class MongoDbUtils {
} }
/** /**
* Check if credentials present. In case we're using a monog-java-driver version 3 or above we do not have the need * Check if credentials present. In case we're using a mongo-java-driver version 3 or above we do not have the need
* for authentication as the auth data has to be provied within the MongoClient * for authentication as the auth data has to be provided within the MongoClient
* *
* @param credentials * @param credentials
* @return * @return

6
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ExposedFields.java

@ -88,7 +88,7 @@ public final class ExposedFields implements Iterable<ExposedField> {
} }
/** /**
* Creates a new {@link ExposedFields} instance for the given fields in either sythetic or non-synthetic way. * Creates a new {@link ExposedFields} instance for the given fields in either synthetic or non-synthetic way.
* *
* @param fields must not be {@literal null}. * @param fields must not be {@literal null}.
* @param synthetic * @param synthetic
@ -107,7 +107,7 @@ public final class ExposedFields implements Iterable<ExposedField> {
} }
/** /**
* Creates a new {@link ExposedFields} with the given orignals and synthetics. * Creates a new {@link ExposedFields} with the given originals and synthetics.
* *
* @param originals must not be {@literal null}. * @param originals must not be {@literal null}.
* @param synthetic must not be {@literal null}. * @param synthetic must not be {@literal null}.
@ -363,7 +363,7 @@ public final class ExposedFields implements Iterable<ExposedField> {
} }
/** /**
* Returns the referenve value for the given field reference. Will return 1 for a synthetic, unaliased field or the * Returns the reference value for the given field reference. Will return 1 for a synthetic, unaliased field or the
* raw rendering of the reference otherwise. * raw rendering of the reference otherwise.
* *
* @return * @return

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/MongoPersistentEntityIndexResolver.java

@ -260,7 +260,7 @@ public class MongoPersistentEntityIndexResolver implements IndexResolver {
LOGGER.info(e.getMessage(), e); LOGGER.info(e.getMessage(), e);
} catch (InvalidDataAccessApiUsageException e) { } catch (InvalidDataAccessApiUsageException e) {
LOGGER.info( LOGGER.info(
String.format("Potentially invald index structure discovered. Breaking operation for %s.", String.format("Potentially invalid index structure discovered. Breaking operation for %s.",
entity.getName()), e); entity.getName()), e);
} }
} else if (includeOptions.isForce() || indexed != null) { } else if (includeOptions.isForce() || indexed != null) {

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/MongoPersistentProperty.java

@ -45,7 +45,7 @@ public interface MongoPersistentProperty extends PersistentProperty<MongoPersist
int getFieldOrder(); int getFieldOrder();
/** /**
* Returns whether the propert is a {@link com.mongodb.DBRef}. If this returns {@literal true} you can expect * Returns whether the property is a {@link com.mongodb.DBRef}. If this returns {@literal true} you can expect
* {@link #getDBRef()} to return an non-{@literal null} value. * {@link #getDBRef()} to return an non-{@literal null} value.
* *
* @return * @return

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Query.java

@ -176,7 +176,7 @@ public class Query {
for (Order order : sort) { for (Order order : sort) {
if (order.isIgnoreCase()) { if (order.isIgnoreCase()) {
throw new IllegalArgumentException(String.format("Gven sort contained an Order for %s with ignore case! " throw new IllegalArgumentException(String.format("Given sort contained an Order for %s with ignore case! "
+ "MongoDB does not support sorting ignoreing case currently!", order.getProperty())); + "MongoDB does not support sorting ignoreing case currently!", order.getProperty()));
} }
} }

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/TextCriteria.java

@ -63,7 +63,7 @@ public class TextCriteria implements CriteriaDefinition {
} }
/** /**
* For a full list of supported languages see the mongdodb reference manual for <a * For a full list of supported languages see the mongodb reference manual for <a
* href="http://docs.mongodb.org/manual/reference/text-search-languages/">Text Search Languages</a>. * href="http://docs.mongodb.org/manual/reference/text-search-languages/">Text Search Languages</a>.
* *
* @param language * @param language

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Update.java

@ -64,7 +64,7 @@ public class Update {
} }
/** /**
* Creates an {@link Update} instance from the given {@link DBObject}. Allows to explicitly exlude fields from making * Creates an {@link Update} instance from the given {@link DBObject}. Allows to explicitly exclude fields from making
* it into the created {@link Update} object. Note, that this will set attributes directly and <em>not</em> use * it into the created {@link Update} object. Note, that this will set attributes directly and <em>not</em> use
* {@literal $set}. This means fields not given in the {@link DBObject} will be nulled when executing the update. To * {@literal $set}. This means fields not given in the {@link DBObject} will be nulled when executing the update. To
* create an only-updating {@link Update} instance of a {@link DBObject}, call {@link #set(String, Object)} for each * create an only-updating {@link Update} instance of a {@link DBObject}, call {@link #set(String, Object)} for each

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/Query.java

@ -38,7 +38,7 @@ import org.springframework.data.annotation.QueryAnnotation;
public @interface Query { public @interface Query {
/** /**
* Takes a MongoDB JSON string to define the actual query to be executed. This one will take precendece over the * Takes a MongoDB JSON string to define the actual query to be executed. This one will take precedence over the
* method name then. * method name then.
* *
* @return * @return

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/support/MongoAnnotationProcessor.java

@ -35,7 +35,7 @@ import com.mysema.query.apt.Configuration;
import com.mysema.query.apt.DefaultConfiguration; import com.mysema.query.apt.DefaultConfiguration;
/** /**
* Annotation processor to create Querydsl query types for QueryDsl annoated classes. * Annotation processor to create Querydsl query types for QueryDsl annotated classes.
* *
* @author Oliver Gierke * @author Oliver Gierke
*/ */

2
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/Contact.java

@ -20,7 +20,7 @@ import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document; import org.springframework.data.mongodb.core.mapping.Document;
/** /**
* Sample contactt domain class. * Sample contact domain class.
* *
* @author Oliver Gierke * @author Oliver Gierke
*/ */

Loading…
Cancel
Save