From f3cf6f013e233074fbffd4a5fa8c8e008c5061bc Mon Sep 17 00:00:00 2001 From: Oliver Gierke Date: Mon, 7 May 2012 12:06:11 +0200 Subject: [PATCH] Polished Javadoc in repository subsystem. --- .../data/gemfire/mapping/GemfirePersistentEntity.java | 2 +- .../springframework/data/gemfire/mapping/Regions.java | 8 ++++---- .../query/DefaultGemfireEntityInformation.java | 6 +++--- .../repository/query/GemfireEntityInformation.java | 2 +- .../gemfire/repository/query/GemfireQueryMethod.java | 6 ++++-- .../support/GemfireRepositoryFactoryBean.java | 10 +++++++--- 6 files changed, 20 insertions(+), 14 deletions(-) diff --git a/src/main/java/org/springframework/data/gemfire/mapping/GemfirePersistentEntity.java b/src/main/java/org/springframework/data/gemfire/mapping/GemfirePersistentEntity.java index 9cb5878e..2012cac1 100644 --- a/src/main/java/org/springframework/data/gemfire/mapping/GemfirePersistentEntity.java +++ b/src/main/java/org/springframework/data/gemfire/mapping/GemfirePersistentEntity.java @@ -49,7 +49,7 @@ public class GemfirePersistentEntity extends BasicPersistentEntity> { * name in case no mapping information is found. * * @param type must not be {@literal null}. - * @return + * @return the {@link Region} the given type is mapped to. */ @SuppressWarnings("unchecked") public Region getRegion(Class type) { @@ -74,10 +74,10 @@ public class Regions implements Iterable> { } /** - * Returns the region with the given name. + * Returns the {@link Region} with the given name. * * @param name must not be {@literal null}. - * @return + * @return the {@link Region} with the given name. */ @SuppressWarnings("unchecked") public Region getRegion(String name) { @@ -87,7 +87,7 @@ public class Regions implements Iterable> { return (Region) regions.get(name); } - /* + /* * (non-Javadoc) * @see java.lang.Iterable#iterator() */ diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/DefaultGemfireEntityInformation.java b/src/main/java/org/springframework/data/gemfire/repository/query/DefaultGemfireEntityInformation.java index 944f0d9c..056ea1f1 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/DefaultGemfireEntityInformation.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/DefaultGemfireEntityInformation.java @@ -27,21 +27,21 @@ import org.springframework.data.repository.core.support.ReflectionEntityInformat * @author Oliver Gierke */ public class DefaultGemfireEntityInformation extends DelegatingEntityInformation - implements GemfireEntityInformation { +implements GemfireEntityInformation { private final GemfirePersistentEntity entity; /** * Creates a new {@link DefaultGemfireEntityInformation}. * - * @param domainClass must not be {@literal null}. + * @param entity must not be {@literal null}. */ public DefaultGemfireEntityInformation(GemfirePersistentEntity entity) { super(new ReflectionEntityInformation(entity.getType())); this.entity = entity; } - /* + /* * (non-Javadoc) * @see org.springframework.data.gemfire.repository.query.GemfireEntityInformation#getRegionName() */ diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireEntityInformation.java b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireEntityInformation.java index 1b44fde7..2b043f95 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireEntityInformation.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireEntityInformation.java @@ -31,7 +31,7 @@ public interface GemfireEntityInformation extends En /** * Returns the name of the {@link Region} the entity is held in. * - * @return + * @return the name of the {@link Region} the entity is held in. */ String getRegionName(); } diff --git a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethod.java b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethod.java index cab19a3e..69655726 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethod.java +++ b/src/main/java/org/springframework/data/gemfire/repository/query/GemfireQueryMethod.java @@ -58,14 +58,16 @@ public class GemfireQueryMethod extends QueryMethod { /** * Returns whether the query method contains an annotated, non-empty query. * - * @return + * @return whether the query method contains an annotated, non-empty query. */ public boolean hasAnnotatedQuery() { return StringUtils.hasText(getAnnotatedQuery()); } /** - * @return the entity + * Returns the {@link GemfirePersistentEntity} the method deals with. + * + * @return the {@link GemfirePersistentEntity} the method deals with. */ public GemfirePersistentEntity getPersistentEntity() { return entity; diff --git a/src/main/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactoryBean.java b/src/main/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactoryBean.java index 1dfa5079..1152b123 100644 --- a/src/main/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactoryBean.java +++ b/src/main/java/org/springframework/data/gemfire/repository/support/GemfireRepositoryFactoryBean.java @@ -19,6 +19,7 @@ import java.io.Serializable; import java.util.Collection; import org.springframework.beans.BeansException; +import org.springframework.beans.factory.FactoryBean; import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.data.gemfire.mapping.GemfirePersistentEntity; @@ -32,16 +33,17 @@ import com.gemstone.bp.edu.emory.mathcs.backport.java.util.Collections; import com.gemstone.gemfire.cache.Region; /** + * {@link FactoryBean} adapter for {@link GemfireRepositoryFactory}. * * @author Oliver Gierke */ public class GemfireRepositoryFactoryBean, S, ID extends Serializable> extends - RepositoryFactoryBeanSupport implements ApplicationContextAware { +RepositoryFactoryBeanSupport implements ApplicationContextAware { private MappingContext, GemfirePersistentProperty> context; private Iterable> regions; - /* + /* * (non-Javadoc) * @see org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext) */ @@ -53,13 +55,15 @@ public class GemfireRepositoryFactoryBean, S, ID ext } /** + * Configures the {@link MappingContext} to be used. + * * @param context the context to set */ public void setMappingContext(MappingContext, GemfirePersistentProperty> context) { this.context = context; } - /* + /* * (non-Javadoc) * @see org.springframework.data.repository.core.support.RepositoryFactoryBeanSupport#createRepositoryFactory() */