Skip to content

Commit 6d793bc

Browse files
committed
Fixing Javadoc for JDK9
1 parent ad28635 commit 6d793bc

File tree

5 files changed

+22
-15
lines changed

5 files changed

+22
-15
lines changed

pom.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<modelVersion>4.0.0</modelVersion>
44
<groupId>com.github.derjust</groupId>
55
<artifactId>spring-data-dynamodb</artifactId>
6-
<version>5.0.0-SNAPSHOT</version>
6+
<version>5.0.1-SNAPSHOT</version>
77
<name>Spring Data DynamoDb</name>
88
<description>Spring Data module providing support for DynamoDb repositories.</description>
99
<url>http://github.com/derjust/spring-data-dynamodb</url>
@@ -255,8 +255,9 @@
255255
<plugin>
256256
<groupId>org.apache.maven.plugins</groupId>
257257
<artifactId>maven-release-plugin</artifactId>
258-
<version>2.5</version>
258+
<version>2.5.3</version>
259259
<configuration>
260+
<tagNameFormat>v@{project.version}</tagNameFormat>
260261
<autoVersionSubmodules>true</autoVersionSubmodules>
261262
<useReleaseProfile>false</useReleaseProfile>
262263
<releaseProfiles>release</releaseProfiles>

src/main/java/org/socialsignin/spring/data/dynamodb/core/DynamoDBOperations.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ public interface DynamoDBOperations {
3939
/**
4040
* Provides access to the DynamoDB mapper table model of the underlying domain type.
4141
*
42+
* @param <T> The type of the domain type itself
4243
* @param domainClass A domain type
4344
* @return Corresponding DynamoDB table model
4445
*/

src/main/java/org/socialsignin/spring/data/dynamodb/repository/config/EnableDynamoDBRepositories.java

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
* annotation declarations e.g.:
4646
* {@code @EnableDynamoDBRepositories("org.my.pkg")} instead of
4747
* {@code @EnableDynamoDBaRepositories(basePackages="org.my.pkg")}.
48+
* @return The package name for scanning
4849
*/
4950
String[] value() default {};
5051

@@ -53,6 +54,7 @@
5354
* alias for (and mutually exclusive with) this attribute. Use
5455
* {@link #basePackageClasses()} for a type-safe alternative to String-based
5556
* package names.
57+
* @return The package name for scanning
5658
*/
5759
String[] basePackages() default {};
5860

@@ -62,6 +64,7 @@
6264
* specified will be scanned. Consider creating a special no-op marker class
6365
* or interface in each package that serves no purpose other than being
6466
* referenced by this attribute.
67+
* @return The class to figure out the base package for scanning
6568
*/
6669
Class<?>[] basePackageClasses() default {};
6770

@@ -70,21 +73,23 @@
7073
* narrows the set of candidate components from everything in
7174
* {@link #basePackages()} to everything in the base packages that matches
7275
* the given filter or filters.
76+
* @return All the include filters
7377
*/
7478
Filter[] includeFilters() default {};
7579

7680
/**
7781
* Specifies which types are not eligible for component scanning.
82+
* @return All the exclude filters
7883
*/
7984
Filter[] excludeFilters() default {};
8085

8186
/**
8287
* Returns the postfix to be used when looking up custom repository
8388
* implementations. Defaults to {@literal Impl}. So for a repository named
8489
* {@code PersonRepository} the corresponding implementation class will be
85-
* looked up scanning for {@code PersonRepositoryImpl}.
90+
* looked up scanning for {@code PersonRepositoryImpl}. Defaults to 'Impl'.
8691
*
87-
* @return
92+
* @return The implementation postfix that's used
8893
*/
8994
String repositoryImplementationPostfix() default "Impl";
9095

@@ -93,49 +98,49 @@
9398
* properties file. Will default to
9499
* {@code META-INFO/jpa-named-queries.properties}.
95100
*
96-
* @return
101+
* @return The location itself
97102
*/
98103
String namedQueriesLocation() default "";
99104

100105
/**
101106
* Returns the key of the {@link org.springframework.data.repository.query.QueryLookupStrategy} to be used for lookup
102107
* queries for query methods. Defaults to {@link Key#CREATE_IF_NOT_FOUND}.
103108
*
104-
* @return
109+
* @return The lookup strategy
105110
*/
106111
Key queryLookupStrategy() default Key.CREATE_IF_NOT_FOUND;
107112

108113
/**
109114
* Returns the {@link org.springframework.beans.factory.FactoryBean} class to be used for each repository
110115
* instance. Defaults to {@link DynamoDBRepositoryFactoryBean}.
111116
*
112-
* @return
117+
* @return The repository factory bean cleass
113118
*/
114119
Class<?> repositoryFactoryBeanClass() default DynamoDBRepositoryFactoryBean.class;
115120

116-
// DynamoDB sepcific configuration
121+
// DynamoDB specific configuration
117122

118123
/**
119124
* Returns the {@link com.amazonaws.services.dynamodbv2.AmazonDynamoDB } reference to be used for each
120125
* repository instance
121126
*
122-
* @return
127+
* @return The {@link com.amazonaws.services.dynamodbv2.AmazonDynamoDB} bean name
123128
*/
124129
String amazonDynamoDBRef() default "";
125130

126131
/**
127132
* Returns the {@link com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperConfig } reference to be used for to
128133
* configure AmazonDynamoDB
129134
*
130-
* @return
135+
* @return The {@link com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperConfig} bean name
131136
*/
132137
String dynamoDBMapperConfigRef() default "";
133138

134139
/**
135140
* Returns the {@link javax.validation.Validator } reference to be used for to
136141
* validate DynamoDB entities
137142
*
138-
* @return
143+
* @return The {@link org.socialsignin.spring.data.dynamodb.core.DynamoDBOperations} bean name
139144
*/
140145
String dynamoDBOperationsRef() default "";
141146

src/main/java/org/socialsignin/spring/data/dynamodb/repository/query/AbstractDynamoDBQueryCriteria.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public abstract class AbstractDynamoDBQueryCriteria<T, ID> implements DynamoDBQu
7070
public abstract boolean isApplicableForLoad();
7171

7272
/**
73-
* @throws UnsupportedOperationException if a {@link #sort} is initalized (non-null && not {@link Sort#unsorted()}
73+
* @throws UnsupportedOperationException if a {@link #sort} is initalized (non-null &amp;&amp; not {@link Sort#unsorted()}
7474
*/
7575
protected void ensureNoSort() throws UnsupportedOperationException {
7676
if (sort != null && sort != Sort.unsorted()) {

src/main/java/org/socialsignin/spring/data/dynamodb/repository/query/DynamoDBQueryLookupStrategy.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,9 @@ protected <T, ID> RepositoryQuery createDynamoDBQuery(Method method, RepositoryM
154154
* Creates a {@link QueryLookupStrategy} for the given
155155
* {@link com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper} and {@link Key}.
156156
*
157-
* @param dynamoDBOperations
158-
* @param key
159-
* @return
157+
* @param dynamoDBOperations The current operation
158+
* @param key The key of the entity
159+
* @return The created {@link QueryLookupStrategy}
160160
*/
161161
public static QueryLookupStrategy create(DynamoDBOperations dynamoDBOperations, Key key) {
162162

0 commit comments

Comments
 (0)