DATAMONGO-1631 - Polishing

Update Javadoc and test classes.

Original Pull Request: #490
This commit is contained in:
Christoph Strobl
2017-09-08 19:58:38 +02:00
parent 3ab3dab2b4
commit ba81caffe4
3 changed files with 17 additions and 13 deletions

View File

@@ -18,10 +18,8 @@ package org.springframework.data.mongodb.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.ReactiveMongoDatabaseFactory;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.ReactiveMongoOperations;
import org.springframework.data.mongodb.core.ReactiveMongoTemplate;
import org.springframework.data.mongodb.core.SimpleMongoDbFactory;
import org.springframework.data.mongodb.core.SimpleReactiveMongoDatabaseFactory;
import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
@@ -31,6 +29,7 @@ import com.mongodb.reactivestreams.client.MongoClient;
* Base class for reactive Spring Data MongoDB configuration using JavaConfig.
*
* @author Mark Paluch
* @author Christoph Strobl
* @since 2.0
* @see MongoConfigurationSupport
*/
@@ -38,17 +37,17 @@ import com.mongodb.reactivestreams.client.MongoClient;
public abstract class AbstractReactiveMongoConfiguration extends MongoConfigurationSupport {
/**
* Return the Reactive Streams {@link MongoClient} instance to connect to. Annotate with {@link Bean} in case you want to expose a
* {@link MongoClient} instance to the {@link org.springframework.context.ApplicationContext}.
* Return the Reactive Streams {@link MongoClient} instance to connect to. Annotate with {@link Bean} in case you want
* to expose a {@link MongoClient} instance to the {@link org.springframework.context.ApplicationContext}.
*
* @return
* @return never {@literal null}.
*/
public abstract MongoClient reactiveMongoClient();
/**
* Creates a {@link ReactiveMongoTemplate}.
* Creates {@link ReactiveMongoOperations}.
*
* @return
* @return never {@literal null}.
*/
@Bean
public ReactiveMongoOperations reactiveMongoTemplate() throws Exception {
@@ -56,12 +55,12 @@ public abstract class AbstractReactiveMongoConfiguration extends MongoConfigurat
}
/**
* Creates a {@link SimpleMongoDbFactory} to be used by the {@link MongoTemplate}. Will use the {@link Mongo} instance
* configured in {@link #reactiveMongoClient()}.
* Creates a {@link ReactiveMongoDatabaseFactory} to be used by the {@link ReactiveMongoOperations}. Will use the
* {@link MongoClient} instance configured in {@link #reactiveMongoClient()}.
*
* @see #reactiveMongoClient()
* @see #reactiveMongoTemplate()
* @return
* @return never {@literal null}.
*/
@Bean
public ReactiveMongoDatabaseFactory reactiveMongoDbFactory() {
@@ -75,7 +74,7 @@ public abstract class AbstractReactiveMongoConfiguration extends MongoConfigurat
* @see #customConversions()
* @see #mongoMappingContext()
* @see #reactiveMongoDbFactory()
* @return
* @return never {@literal null}.
* @throws Exception
*/
@Bean

View File

@@ -35,9 +35,10 @@ import com.mongodb.reactivestreams.client.MongoClients;
* Integration tests for {@link AbstractReactiveMongoConfiguration}.
*
* @author Mark Paluch
* @author Christoph Strobl
*/
@RunWith(SpringRunner.class)
@ContextConfiguration(classes = AbstractReactiveMongoConfigurationIntegrationTests.ReactiveConfiguration.class)
@ContextConfiguration
public class AbstractReactiveMongoConfigurationIntegrationTests {
@Autowired ApplicationContext context;

View File

@@ -34,14 +34,18 @@ import org.springframework.data.mongodb.config.AbstractReactiveMongoConfiguratio
import org.springframework.data.mongodb.core.query.Collation;
import org.springframework.data.mongodb.test.util.MongoVersionRule;
import org.springframework.data.util.Version;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import com.mongodb.reactivestreams.client.MongoClient;
import com.mongodb.reactivestreams.client.MongoClients;
/**
* @author Mark Paluch
* @author Christoph Strobl
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration
public class ReactiveMongoTemplateCollationTests {
public static @ClassRule MongoVersionRule REQUIRES_AT_LEAST_3_4_0 = MongoVersionRule.atLeast(Version.parse("3.4.0"));
@@ -51,7 +55,7 @@ public class ReactiveMongoTemplateCollationTests {
static class Config extends AbstractReactiveMongoConfiguration {
@Override
public com.mongodb.reactivestreams.client.MongoClient reactiveMongoClient() {
public MongoClient reactiveMongoClient() {
return MongoClients.create();
}