DATAMONGO-856 - Documentation updates.

Updated references from springsource.org to spring.io. Updated references to mongodb.org. Update vendor to Pivotal Software, Inc. Update required/recommended versions. Update CustomConversions configuration section. Added missing section id's. Fixed some typos. Added missing JavaDoc.

Original pull request: spring-projects#128.

Author: christophstrobl

README.md

@@ -1,19 +1,19 @@
 # Spring Data MongoDB
 
-The primary goal of the [Spring Data](http://www.springsource.org/spring-data) project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
+The primary goal of the [Spring Data](http://projects.spring.io/spring-data) project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
 
 The Spring Data MongoDB project aims to provide a familiar and consistent Spring-based programming model for new datastores while retaining store-specific features and capabilities. The Spring Data MongoDB project provides integration with the MongoDB document database. Key functional areas of Spring Data MongoDB are a POJO centric model for interacting with a MongoDB DBCollection and easily writing a repository style data access layer.
 
 ## Getting Help
 
 For a comprehensive treatment of all the Spring Data MongoDB features, please refer to:
 
-* the [User Guide](http://static.springsource.org/spring-data/data-mongodb/docs/current/reference/html/) 
-* the [JavaDocs](http://static.springsource.org/spring-data/data-mongodb/docs/current/api/) have extensive comments in them as well.
-* the home page of [Spring Data MongoDB](http://www.springsource.org/spring-data/mongodb) contains links to articles and other resources.
-* for more detailed questions, use the [forum](http://forum.springsource.org/forumdisplay.php?f=80). 
+* the [User Guide](http://docs.spring.io/spring-data/mongodb/docs/current/reference/html/)
+* the [JavaDocs](http://docs.spring.io/spring-data/mongodb/docs/current/api/) have extensive comments in them as well.
+* the home page of [Spring Data MongoDB](http://projects.spring.io/spring-data-mongodb) contains links to articles and other resources.
+* for more detailed questions, use the [forum](http://forum.spring.io/forum/spring-projects/data/nosql).
 
-If you are new to Spring as well as to Spring Data, look for information about [Spring projects](http://www.springsource.org/projects). 
+If you are new to Spring as well as to Spring Data, look for information about [Spring projects](http://projects.spring.io/).
 
 
 ## Quick Start
@@ -53,7 +53,7 @@ MongoTemplate is the central support class for Mongo database operations. It pro
 * Basic POJO mapping support to and from BSON
 * Convenience methods to interact with the store (insert object, update objects) and MongoDB specific ones (geo-spatial operations, upserts, map-reduce etc.)
 * Connection affinity callback
-* Exception translation into Spring's [technology agnostic DAO exception hierarchy](http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/dao.html#dao-exceptions).
+* Exception translation into Spring's [technology agnostic DAO exception hierarchy](http://docs.spring.io/spring/docs/current/spring-framework-reference/html/dao.html#dao-exceptions).
 
 ### Spring Data repositories
 
@@ -139,9 +139,9 @@ public class MyService {
 
 Here are some ways for you to get involved in the community:
 
-* Get involved with the Spring community on the Spring Community Forums.  Please help out on the [forum](http://forum.springsource.org/forumdisplay.php?f=80) by responding to questions and joining the debate.
+* Get involved with the Spring community on the Spring Community Forums.  Please help out on the [forum](http://forum.spring.io/forum/spring-projects/data/nosql) by responding to questions and joining the debate.
 * Create [JIRA](https://jira.springframework.org/browse/DATADOC) tickets for bugs and new features and comment and vote on the ones that you are interested in.  
 * Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, please reference a JIRA ticket as well covering the specific issue you are addressing.
-* Watch for upcoming articles on Spring by [subscribing](http://www.springsource.org/node/feed) to springframework.org
+* Watch for upcoming articles on Spring by [subscribing](http://spring.io/blog) to spring.io.
 
 Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup).  Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do.  Active contributors might be asked to join the core team, and given the ability to merge pull requests.

pom.xml

@@ -10,7 +10,7 @@
 
 	<name>Spring Data MongoDB</name>
 	<description>MongoDB support for Spring Data</description>
-	<url>http://www.springsource.org/spring-data/mongodb</url>
+	<url>http://projects.spring.io/spring-data-mongodb</url>
 
 	<parent>
 		<groupId>org.springframework.data.build</groupId>

spring-data-mongodb-cross-store/template.mf

@@ -1,6 +1,6 @@
 Bundle-SymbolicName: org.springframework.data.mongodb.crossstore
 Bundle-Name: Spring Data MongoDB Cross Store Support
-Bundle-Vendor: SpringSource
+Bundle-Vendor: Pivotal Software, Inc.
 Bundle-ManifestVersion: 2
 Import-Package: 
  sun.reflect;version="0";resolution:=optional

spring-data-mongodb-log4j/template.mf

@@ -1,6 +1,6 @@
 Bundle-SymbolicName: org.springframework.data.mongodb.log4j
 Bundle-Name: Spring Data Mongo DB Log4J Appender
-Bundle-Vendor: SpringSource
+Bundle-Vendor: Pivotal Software, Inc.
 Bundle-ManifestVersion: 2
 Import-Package:
  sun.reflect;version="0";resolution:=optional

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

@@ -1,6 +1,6 @@
 /*
- * Copyright 2010-2013 the original author or authors.
- *
+ * Copyright 2011-2014 the original author or authors.
+ * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -468,10 +468,32 @@ <T> MapReduceResults<T> mapReduce(Query query, String inputCollectionName, Strin
 	 */
 	<T> T findOne(Query query, Class<T> entityClass, String collectionName);
 
+	/**
+	 * Determine result of given {@link Query} contains at least one element.
+	 * 
+	 * @param query the {@link Query} class that specifies the criteria used to find a record.
+	 * @param collectionName name of the collection to check for objects.
+	 * @return
+	 */
 	boolean exists(Query query, String collectionName);
 
+	/**
+	 * Determine result of given {@link Query} contains at least one element.
+	 * 
+	 * @param query the {@link Query} class that specifies the criteria used to find a record.
+	 * @param entityClass the parameterized type.
+	 * @return
+	 */
 	boolean exists(Query query, Class<?> entityClass);
 
+	/**
+	 * Determine result of given {@link Query} contains at least one element.
+	 * 
+	 * @param query the {@link Query} class that specifies the criteria used to find a record.
+	 * @param entityClass the parameterized type.
+	 * @param collectionName name of the collection to check for objects.
+	 * @return
+	 */
 	boolean exists(Query query, Class<?> entityClass, String collectionName);
 
 	/**
@@ -529,12 +551,58 @@ <T> MapReduceResults<T> mapReduce(Query query, String inputCollectionName, Strin
 	 */
 	<T> T findById(Object id, Class<T> entityClass, String collectionName);
 
+	/**
+	 * Triggers <a href="http://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify<a/>
+	 * to apply provided {@link Update} on documents matching {@link Criteria} of given {@link Query}.
+	 * 
+	 * @param query the {@link Query} class that specifies the {@link Criteria} used to find a record and also an optional
+	 *          fields specification.
+	 * @param update the {@link Update} to apply on matching documents.
+	 * @param entityClass the parameterized type.
+	 * @return
+	 */
 	<T> T findAndModify(Query query, Update update, Class<T> entityClass);
 
+	/**
+	 * Triggers <a href="http://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify<a/>
+	 * to apply provided {@link Update} on documents matching {@link Criteria} of given {@link Query}.
+	 * 
+	 * @param query the {@link Query} class that specifies the {@link Criteria} used to find a record and also an optional
+	 *          fields specification.
+	 * @param update the {@link Update} to apply on matching documents.
+	 * @param entityClass the parameterized type.
+	 * @param collectionName the collection to query.
+	 * @return
+	 */
 	<T> T findAndModify(Query query, Update update, Class<T> entityClass, String collectionName);
 
+	/**
+	 * Triggers <a href="http://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify<a/>
+	 * to apply provided {@link Update} on documents matching {@link Criteria} of given {@link Query} taking
+	 * {@link FindAndModifyOptions} into account.
+	 * 
+	 * @param query the {@link Query} class that specifies the {@link Criteria} used to find a record and also an optional
+	 *          fields specification.
+	 * @param update the {@link Update} to apply on matching documents.
+	 * @param options the {@link FindAndModifyOptions} holding additional information.
+	 * @param entityClass the parameterized type.
+	 * @return
+	 */
 	<T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Class<T> entityClass);
 
+	/**
+	 * Triggers <a href="http://docs.mongodb.org/manual/reference/method/db.collection.findAndModify/">findAndModify<a/>
+	 * to apply provided {@link Update} on documents matching {@link Criteria} of given {@link Query} taking
+	 * {@link FindAndModifyOptions} into account.
+	 * 
+	 * @param query the {@link Query} class that specifies the {@link Criteria} used to find a record and also an optional
+	 *          fields specification.
+	 * @param update the {@link Update} to apply on matching documents.
+	 * @param options the {@link FindAndModifyOptions} holding additional information.
+	 * @param entityClass the parameterized type.
+	 * @param collectionName the collection to query.
+	 * @return
+	 */
 	<T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Class<T> entityClass,
 			String collectionName);
 
@@ -598,9 +666,9 @@ <T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Cl
 	 * <p/>
 	 * If you object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
 	 * String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
-	 * property type will be handled by Spring's BeanWrapper class that leverages Spring 3.0's new Type Conversion API.
-	 * See <a href="http://static.springsource.org/spring/docs/3.0.x/reference/validation.html#core-convert">Spring 3 Type
-	 * Conversion"</a> for more details.
+	 * property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See <a
+	 * href="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/validation.html#core-convert"
+	 * >Spring's Type Conversion"</a> for more details.
 	 * <p/>
 	 * <p/>
 	 * Insert is used to initially store the object into the database. To update an existing object use the save method.
@@ -655,9 +723,9 @@ <T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Cl
 	 * <p/>
 	 * If you object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
 	 * String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
-	 * property type will be handled by Spring's BeanWrapper class that leverages Spring 3.0's new Type Conversion API.
-	 * See <a href="http://static.springsource.org/spring/docs/3.0.x/reference/validation.html#core-convert">Spring 3 Type
-	 * Conversion"</a> for more details.
+	 * property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See <a
+	 * href="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/validation.html#core-convert"
+	 * >Spring's Type Conversion"</a> for more details.
 	 * 
 	 * @param objectToSave the object to store in the collection
 	 */
@@ -672,9 +740,9 @@ <T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Cl
 	 * <p/>
 	 * If you object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
 	 * String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
-	 * property type will be handled by Spring's BeanWrapper class that leverages Spring 3.0's new Type Cobnversion API.
-	 * See <a href="http://static.springsource.org/spring/docs/3.0.x/reference/validation.html#core-convert">Spring 3 Type
-	 * Conversion"</a> for more details.
+	 * property type will be handled by Spring's BeanWrapper class that leverages Type Cobnversion API. See <a
+	 * http://docs.spring.io/spring/docs/current/spring-framework-reference/html/validation.html#core-convert">Spring's
+	 * Type Conversion"</a> for more details.
 	 * 
 	 * @param objectToSave the object to store in the collection
 	 * @param collectionName name of the collection to store the object in
@@ -814,6 +882,14 @@ <T> T findAndModify(Query query, Update update, FindAndModifyOptions options, Cl
 	 */
 	void remove(Query query, Class<?> entityClass);
 
+	/**
+	 * Remove all documents that match the provided query document criteria from the the collection used to store the
+	 * entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.
+	 * 
+	 * @param query
+	 * @param entityClass
+	 * @param collectionName
+	 */
 	void remove(Query query, Class<?> entityClass, String collectionName);
 
 	/**

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

@@ -1,8 +1,26 @@
+/*
+ * Copyright 2012-2014 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.springframework.data.mongodb.core;
 
 import org.springframework.transaction.support.ResourceHolder;
 import org.springframework.transaction.support.ResourceHolderSynchronization;
 
+/**
+ * @author Oliver Gierke
+ */
 class MongoSynchronization extends ResourceHolderSynchronization<ResourceHolder, Object> {
 
 	public MongoSynchronization(ResourceHolder resourceHolder, Object resourceKey) {

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

@@ -51,10 +51,24 @@
 	@Deprecated
 	IndexDirection direction() default IndexDirection.ASCENDING;
 
+	/**
+	 * @see http://docs.mongodb.org/manual/core/index-unique/
+	 * @return
+	 */
 	boolean unique() default false;
 
+	/**
+	 * If set to true index will skip over any document that is missing the indexed field.
+	 * 
+	 * @see http://docs.mongodb.org/manual/core/index-sparse/
+	 * @return
+	 */
 	boolean sparse() default false;
 
+	/**
+	 * @see http://docs.mongodb.org/manual/core/index-creation/#index-creation-duplicate-dropping
+	 * @return
+	 */
 	boolean dropDups() default false;
 
 	/**

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

@@ -41,8 +41,7 @@ public enum Duplicates {
 
 	private boolean sparse = false;
 
-	public Index() {
-	}
+	public Index() {}
 
 	public Index(String key, Direction direction) {
 		fieldSpec.put(key, direction);
@@ -83,16 +82,33 @@ public Index named(String name) {
 		return this;
 	}
 
+	/**
+	 * Reject all documents that contain a duplicate value for the indexed field.
+	 * 
+	 * @see http://docs.mongodb.org/manual/core/index-unique/
+	 * @return
+	 */
 	public Index unique() {
 		this.unique = true;
 		return this;
 	}
 
+	/**
+	 * Skip over any document that is missing the indexed field.
+	 * 
+	 * @see http://docs.mongodb.org/manual/core/index-sparse/
+	 * @return
+	 */
 	public Index sparse() {
 		this.sparse = true;
 		return this;
 	}
 
+	/**
+	 * @see http://docs.mongodb.org/manual/core/index-creation/#index-creation-duplicate-dropping
+	 * @param duplicates
+	 * @return
+	 */
 	public Index unique(Duplicates duplicates) {
 		if (duplicates == Duplicates.DROP) {
 			this.dropDuplicates = true;

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

@@ -32,16 +32,42 @@
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Indexed {
 
+	/**
+	 * If set to true reject all documents that contain a duplicate value for the indexed field.
+	 * 
+	 * @see http://docs.mongodb.org/manual/core/index-unique/
+	 * @return
+	 */
 	boolean unique() default false;
 
 	IndexDirection direction() default IndexDirection.ASCENDING;
 
+	/**
+	 * If set to true index will skip over any document that is missing the indexed field.
+	 * 
+	 * @see http://docs.mongodb.org/manual/core/index-sparse/
+	 * @return
+	 */
 	boolean sparse() default false;
 
+	/**
+	 * @see http://docs.mongodb.org/manual/core/index-creation/#index-creation-duplicate-dropping
+	 * @return
+	 */
 	boolean dropDups() default false;
 
+	/**
+	 * Index name.
+	 * 
+	 * @return
+	 */
 	String name() default "";
 
+	/**
+	 * Colleciton name for index to be created on.
+	 * 
+	 * @return
+	 */
 	String collection() default "";
 
 	/**