Skip to content

Commit 0056f92

Browse files
derjustderjust
committed
Fix Javadoc and cast warnings
1 parent 712448e commit 0056f92

File tree

10 files changed

+50
-39
lines changed

10 files changed

+50
-39
lines changed

‎src/changes/changes.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@
2323
<author email="zeeman@zeeman.de">derjust</author>
2424
</properties>
2525
<body>
26+
<release version="5.0.3" date="" description="Maintenance release">
27+
<action dev="derjust" type="fix" date="2018-03-05">
28+
Fix Javadoc and cast warnings
29+
</action>
30+
</release>
2631
<release version="5.0.2" date="2018-03-05" description="Maintenance release">
2732
<action dev="vitolimandibhrata" issue="40" type="add" date="2017-01-07">
2833
Added support for Auditing

‎src/main/java/org/socialsignin/spring/data/dynamodb/config/AbstractDynamoDBConfiguration.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ protected String[] getMappingBasePackages() {
6767
* Creates a {@link DynamoDBMappingContext} equipped with entity classes scanned from the mapping base package.
6868
*
6969
* @see #getMappingBasePackages()
70-
* @return
71-
* @throws ClassNotFoundException
70+
* @return A newly created {@link DynamoDBMappingContext}
71+
* @throws ClassNotFoundException if the class with {@link DynamoDBTable} annotation can't be loaded
7272
*/
7373
@Bean
7474
public DynamoDBMappingContext dynamoDBMappingContext() throws ClassNotFoundException {
@@ -83,8 +83,8 @@ public DynamoDBMappingContext dynamoDBMappingContext() throws ClassNotFoundExcep
8383
* Scans the mapping base package for classes annotated with {@link DynamoDBTable}.
8484
*
8585
* @see #getMappingBasePackages()
86-
* @return
87-
* @throws ClassNotFoundException
86+
* @return All classes with {@link DynamoDBTable} annotation
87+
* @throws ClassNotFoundException if the class with {@link DynamoDBTable} annotation can't be loaded
8888
*/
8989
protected Set<Class<?>> getInitialEntitySet() throws ClassNotFoundException {
9090

‎src/main/java/org/socialsignin/spring/data/dynamodb/config/EnableDynamoDBAuditing.java‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,31 +37,23 @@
3737
public @interface EnableDynamoDBAuditing {
3838

3939
/**
40-
* Configures the {@link org.springframework.data.domain.AuditorAware} bean to be used to lookup the current principal.
41-
*
42-
* @return
40+
* @return Configures the {@link org.springframework.data.domain.AuditorAware} bean to be used to lookup the current principal.
4341
*/
4442
String auditorAwareRef() default "";
4543

4644
/**
47-
* Configures whether the creation and modification dates are set. Defaults to {@literal true}.
48-
*
49-
* @return
45+
* @return Configures whether the creation and modification dates are set. Defaults to {@literal true}.
5046
*/
5147
boolean setDates() default true;
5248

5349
/**
54-
* Configures whether the entity shall be marked as modified on creation. Defaults to {@literal true}.
55-
*
56-
* @return
50+
* @return Configures whether the entity shall be marked as modified on creation. Defaults to {@literal true}.
5751
*/
5852
boolean modifyOnCreate() default true;
5953

6054
/**
61-
* Configures a {@link org.springframework.data.auditing.DateTimeProvider} bean name that allows customizing the {@link org.joda.time.DateTime} to be
55+
* @return Configures a {@link org.springframework.data.auditing.DateTimeProvider} bean name that allows customizing the {@link org.joda.time.DateTime} to be
6256
* used for setting creation and modification dates.
63-
*
64-
* @return
6557
*/
6658
String dateTimeProviderRef() default "";
6759
}

‎src/main/java/org/socialsignin/spring/data/dynamodb/core/DynamoDBTemplate.java‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,27 @@ public class DynamoDBTemplate implements DynamoDBOperations, ApplicationContextA
5252
private final DynamoDBMapperConfig dynamoDBMapperConfig;
5353
private ApplicationEventPublisher eventPublisher;
5454

55-
/** Convenient constructor to use the default {@link DynamoDBMapper#DynamoDBMapper(AmazonDynamoDB)} */
55+
/** Convenient constructor to use the default {@link DynamoDBMapper#DynamoDBMapper(AmazonDynamoDB)}
56+
* @param amazonDynamoDB The AWS SDK instance to talk to DynamoDB
57+
* @param dynamoDBMapperConfig The config to use
58+
* */
5659
public DynamoDBTemplate(AmazonDynamoDB amazonDynamoDB, DynamoDBMapperConfig dynamoDBMapperConfig)
5760
{
5861
this(amazonDynamoDB, dynamoDBMapperConfig, null);
5962
}
6063

61-
/** Convenient constructor to use the {@link DynamoDBMapperConfig#DEFAULT} */
64+
/** Convenient constructor to use the {@link DynamoDBMapperConfig#DEFAULT}
65+
* @param amazonDynamoDB The AWS SDK instance to talk to DynamoDB
66+
* @param dynamoDBMapper The Mapper to use
67+
* */
6268
public DynamoDBTemplate(AmazonDynamoDB amazonDynamoDB, DynamoDBMapper dynamoDBMapper)
6369
{
6470
this(amazonDynamoDB, null, dynamoDBMapper);
6571
}
6672

67-
/** Convenient construcotr to thse the {@link DynamoDBMapperConfig#DEFAULT} and default {@link DynamoDBMapper#DynamoDBMapper(AmazonDynamoDB)} */
73+
/** Convenient construcotr to thse the {@link DynamoDBMapperConfig#DEFAULT} and default {@link DynamoDBMapper#DynamoDBMapper(AmazonDynamoDB)}
74+
* @param amazonDynamoDB The AWS SDK instance to talk to DynamoDB
75+
* */
6876
public DynamoDBTemplate(AmazonDynamoDB amazonDynamoDB)
6977
{
7078
this(amazonDynamoDB, null, null);

‎src/main/java/org/socialsignin/spring/data/dynamodb/repository/support/DynamoDBRepositoryFactory.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,11 @@ protected QueryLookupStrategy getQueryLookupStrategy(Key key) {
111111
/**
112112
* Callback to create a {@link DynamoDBCrudRepository} instance with the given {@link RepositoryMetadata}
113113
*
114-
* @param <T>
115-
* @param <ID>
116-
* @param metadata
114+
* @param <T> Type of the Entity
115+
* @param <ID> Type of the Hash (Primary) Key
116+
* @param metadata Metadata of the entity
117117
* @see #getTargetRepository(RepositoryInformation)
118-
* @return
118+
* @return the created {@link DynamoDBCrudRepository} instance
119119
*/
120120
@SuppressWarnings({ "unchecked", "rawtypes" })
121121
protected <T, ID extends Serializable> DynamoDBCrudRepository<?, ?> getDynamoDBRepository(

‎src/main/java/org/socialsignin/spring/data/dynamodb/utils/SortHandler.java‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,17 @@ public class SortHandler {
2828
private SortHandler() {
2929
}
3030

31-
public static void ensureNoSort(Pageable pageable) {
31+
/**
32+
* @param pageable The {@link Pageable} to check that no sort is specified
33+
*/
34+
public static void ensureNoSort(Pageable pageable) {
3235
Sort sort = pageable.getSort();
3336
ensureNoSort(sort);
3437
}
3538

3639
/**
37-
* @throws UnsupportedOperationException if a {@code sort} is initialized (non-null &amp;&amp; not {@link Sort#unsorted()}
40+
* @param sort The {@link Sort} to check that no sort is specified
41+
* @throws UnsupportedOperationException if a {@code sort} is initialized (non-null)
3842
*/
3943
public static void ensureNoSort(Sort sort) throws UnsupportedOperationException {
4044
if (sort != null) {

‎src/test/java/org/socialsignin/spring/data/dynamodb/core/DynamoDBTemplateTest.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ public class DynamoDBTemplateTest {
5656
private DynamoDBMapperConfig dynamoDBMapperConfig;
5757
@Mock
5858
private ApplicationContext applicationContext;
59-
59+
@Mock
60+
private DynamoDBQueryExpression<User> countUserQuery;
61+
6062
private DynamoDBTemplate dynamoDBTemplate;
6163

6264
@Before
@@ -124,7 +126,7 @@ public void testBatchSave_CallsCorrectDynamoDBMapperMethod()
124126

125127
@Test
126128
public void testCountQuery() {
127-
DynamoDBQueryExpression<User> query = mock(DynamoDBQueryExpression.class);
129+
DynamoDBQueryExpression<User> query = countUserQuery;
128130
int actual = dynamoDBTemplate.count(User.class, query);
129131

130132
verify(dynamoDBMapper).count(User.class, query);

‎src/test/java/org/socialsignin/spring/data/dynamodb/query/QueryExpressionCountQueryTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public class QueryExpressionCountQueryTest {
4242

4343
@Before
4444
public void setUp() {
45-
underTest = new QueryExpressionCountQuery(dynamoDBOperations, User.class, queryExpression);
45+
underTest = new QueryExpressionCountQuery<>(dynamoDBOperations, User.class, queryExpression);
4646
}
4747

4848
@Test

‎src/test/java/org/socialsignin/spring/data/dynamodb/repository/cdi/DynamoDBRepositoryBeanTest.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public void setUp() {
7070

7171
@Test
7272
public void testNullOperationsOk() {
73-
DynamoDBRepositoryBean underTest = new DynamoDBRepositoryBean(beanManager, amazonDynamoDBBean,
73+
DynamoDBRepositoryBean<SampleRepository> underTest = new DynamoDBRepositoryBean(beanManager, amazonDynamoDBBean,
7474
dynamoDBMapperConfigBean, null, qualifiers, repositoryType);
7575

7676
assertNotNull(underTest);
@@ -80,13 +80,13 @@ public void testNullOperationsOk() {
8080
public void testNullOperationFail() {
8181
expectedException.expectMessage("amazonDynamoDBBean must not be null!");
8282

83-
DynamoDBRepositoryBean underTest = new DynamoDBRepositoryBean(beanManager, null,
83+
DynamoDBRepositoryBean<SampleRepository> underTest = new DynamoDBRepositoryBean(beanManager, null,
8484
dynamoDBMapperConfigBean, null, qualifiers, repositoryType);
8585
}
8686

8787
@Test
8888
public void testSetOperationOk1() {
89-
DynamoDBRepositoryBean underTest = new DynamoDBRepositoryBean(beanManager, null,
89+
DynamoDBRepositoryBean<SampleRepository> underTest = new DynamoDBRepositoryBean(beanManager, null,
9090
null, dynamoDBOperationsBean, qualifiers, repositoryType);
9191

9292
assertNotNull(underTest);
@@ -96,15 +96,15 @@ public void testSetOperationOk1() {
9696
public void testSetOperationFail1() {
9797
expectedException.expectMessage("Cannot specify both dynamoDBMapperConfigBean bean and dynamoDBOperationsBean in repository configuration");
9898

99-
DynamoDBRepositoryBean underTest = new DynamoDBRepositoryBean(beanManager, null,
99+
DynamoDBRepositoryBean<SampleRepository> underTest = new DynamoDBRepositoryBean(beanManager, null,
100100
dynamoDBMapperConfigBean, dynamoDBOperationsBean, qualifiers, repositoryType);
101101
}
102102

103103
@Test
104104
public void testSetOperationFail2() {
105105
expectedException.expectMessage("Cannot specify both amazonDynamoDB bean and dynamoDBOperationsBean in repository configuration");
106106

107-
DynamoDBRepositoryBean underTest = new DynamoDBRepositoryBean(beanManager, amazonDynamoDBBean,
107+
DynamoDBRepositoryBean<SampleRepository> underTest = new DynamoDBRepositoryBean(beanManager, amazonDynamoDBBean,
108108
null, dynamoDBOperationsBean, qualifiers, repositoryType);
109109
}
110110

‎src/test/java/org/socialsignin/spring/data/dynamodb/utils/DynamoDBLocalResource.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,25 @@ public static <T> CreateTableResult createTable(AmazonDynamoDB ddb, Class<T> dom
5959
hashKeyAttribute = hashKeyProperty;
6060
}
6161

62-
Optional<String> rangeKey = Optional.empty();
62+
String rangeKey = null;
6363
if (entityInfo instanceof DynamoDBIdIsHashAndRangeKeyEntityInformation) {
64-
rangeKey = Optional.of(((DynamoDBIdIsHashAndRangeKeyEntityInformation)entityInfo).getRangeKeyPropertyName());
64+
rangeKey = ((DynamoDBIdIsHashAndRangeKeyEntityInformation)entityInfo).getRangeKeyPropertyName();
6565
}
6666

6767
return createTable(ddb, tableName, hashKeyAttribute, rangeKey);
6868
}
6969

70-
private static CreateTableResult createTable(AmazonDynamoDB ddb, String tableName, String hashKeyName, Optional<String> rangeKeyName) {
70+
private static CreateTableResult createTable(AmazonDynamoDB ddb, String tableName, String hashKeyName, String rangeKeyName) {
7171
List<AttributeDefinition> attributeDefinitions = new ArrayList<>();
7272
attributeDefinitions.add(new AttributeDefinition(hashKeyName, ScalarAttributeType.S));
7373

7474
List<KeySchemaElement> ks = new ArrayList<>();
7575
ks.add(new KeySchemaElement(hashKeyName, KeyType.HASH));
7676

77-
if (rangeKeyName.isPresent()) {
78-
attributeDefinitions.add(new AttributeDefinition(rangeKeyName.get(), ScalarAttributeType.S));
77+
if (rangeKeyName != null) {
78+
attributeDefinitions.add(new AttributeDefinition(rangeKeyName, ScalarAttributeType.S));
7979

80-
ks.add(new KeySchemaElement(rangeKeyName.get(), KeyType.RANGE));
80+
ks.add(new KeySchemaElement(rangeKeyName, KeyType.RANGE));
8181
}
8282

8383
ProvisionedThroughput provisionedthroughput = new ProvisionedThroughput(10L, 10L);

0 commit comments

Comments
 (0)