Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add @NonNullApi where appropriate

Browse Source 
Packages with `@Nullable` annotations need to have `@NonNulApi` at the package level.

There may be classes in these packages that have nullable arguments/returns that are
not currently marked as `@Nullable`. These will be fixed over time.

Also suppress JSR305 warnings when compiling tests.

* Polishing - PR Comments
This commit is contained in:
Gary Russell
2018-08-01 16:53:42 -04:00
committed by Artem Bilan
parent 03a3bbb65f
commit 23a3462d8b
21 changed files with 49 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
build.gradle
View File

@@ -5,7 +5,7 @@ buildscript {
}
dependencies {
classpath 'io.spring.gradle:docbook-reference-plugin:0.3.1'
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.3'
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.8'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
classpath "org.jetbrains.kotlin:kotlin-allopen:$kotlinVersion"
}
@@ -97,6 +97,7 @@ subprojects { subproject ->
derbyVersion = '10.13.1.1'
eclipseLinkVersion = '2.7.1'
ftpServerVersion = '1.1.1'
googleJsr305Version = '3.0.2'
groovyVersion = '2.4.15'
guavaVersion = '20.0'
hamcrestVersion = '1.3'
@@ -161,7 +162,8 @@ subprojects { subproject ->
}
// JSR-305 only used for non-required meta-annotations
compileOnly("com.google.code.findbugs:jsr305:3.0.2")
compileOnly("com.google.code.findbugs:jsr305:$googleJsr305Version")
testCompile("com.google.code.findbugs:jsr305:$googleJsr305Version")
testCompile "org.junit.jupiter:junit-jupiter-api:$junitJupiterVersion"
testRuntime "org.junit.jupiter:junit-jupiter-engine:$junitJupiterVersion"
@@ -760,16 +762,16 @@ asciidoctor {
logDocuments = true
options = [
doctype: 'book',
attributes: [
docinfo: '',
toc2: '',
'compat-mode': '',
imagesdir: '',
stylesdir: "stylesheets/",
stylesheet: 'golo.css',
'spring-integration-version': "$version",
'source-highlighter': 'highlightjs'
]
]
attributes = [
docinfo: '',
toc2: '',
'compat-mode': '',
imagesdir: '',
stylesdir: "stylesheets/",
stylesheet: 'golo.css',
'spring-integration-version': "$version",
'source-highlighter': 'highlightjs'
]
}

1
spring-integration-amqp/src/main/java/org/springframework/integration/amqp/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Base package for AMQP support.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.amqp;

5
spring-integration-amqp/src/main/java/org/springframework/integration/amqp/support/AmqpMessageHeaderErrorMessageStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2017 the original author or authors.
* Copyright 2017-2018 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.
@@ -24,6 +24,7 @@ import org.springframework.amqp.support.AmqpHeaders;
import org.springframework.core.AttributeAccessor;
import org.springframework.integration.support.ErrorMessageStrategy;
import org.springframework.integration.support.ErrorMessageUtils;
import org.springframework.lang.Nullable;
import org.springframework.messaging.Message;
import org.springframework.messaging.support.ErrorMessage;
@@ -45,7 +46,7 @@ public class AmqpMessageHeaderErrorMessageStrategy implements ErrorMessageStrate
public static final String AMQP_RAW_MESSAGE = AmqpHeaders.PREFIX + "raw_message";
@Override
public ErrorMessage buildErrorMessage(Throwable throwable, AttributeAccessor context) {
public ErrorMessage buildErrorMessage(Throwable throwable, @Nullable AttributeAccessor context) {
Object inputMessage = context == null ? null
: context.getAttribute(ErrorMessageUtils.INPUT_MESSAGE_CONTEXT_KEY);
Map<String, Object> headers = context == null ? new HashMap<String, Object>() :

5
spring-integration-amqp/src/main/java/org/springframework/integration/amqp/support/MappingUtils.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2016-2017 the original author or authors.
* Copyright 2016-2018 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.
@@ -21,6 +21,7 @@ import org.springframework.amqp.core.MessageProperties;
import org.springframework.amqp.support.AmqpHeaders;
import org.springframework.amqp.support.converter.ContentTypeDelegatingMessageConverter;
import org.springframework.amqp.support.converter.MessageConverter;
import org.springframework.lang.Nullable;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageHeaders;
import org.springframework.util.MimeType;
@@ -94,7 +95,7 @@ public final class MappingUtils {
* @param defaultDeliveryMode the default delivery mode.
*/
public static void checkDeliveryMode(Message<?> requestMessage, MessageProperties messageProperties,
MessageDeliveryMode defaultDeliveryMode) {
@Nullable MessageDeliveryMode defaultDeliveryMode) {
if (defaultDeliveryMode != null &&
requestMessage.getHeaders().get(AmqpHeaders.DELIVERY_MODE) == null) {
messageProperties.setDeliveryMode(defaultDeliveryMode);

5
spring-integration-amqp/src/main/java/org/springframework/integration/amqp/support/NackedAmqpMessageException.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2017 the original author or authors.
* Copyright 2017-2018 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.
@@ -16,6 +16,7 @@
package org.springframework.integration.amqp.support;
import org.springframework.lang.Nullable;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessagingException;
@@ -35,7 +36,7 @@ public class NackedAmqpMessageException extends MessagingException {
private final String nackReason;
public NackedAmqpMessageException(Message<?> message, Object correlationData, String nackReason) {
public NackedAmqpMessageException(Message<?> message, @Nullable Object correlationData, String nackReason) {
super(message);
this.correlationData = correlationData;
this.nackReason = nackReason;

4
spring-integration-core/src/main/java/org/springframework/integration/acks/AckUtils.java
View File

@@ -50,7 +50,7 @@ public final class AckUtils {
* and is not already ack'd.
* @param ackCallback the callback.
*/
public static void autoAck(AcknowledgmentCallback ackCallback) {
public static void autoAck(@Nullable AcknowledgmentCallback ackCallback) {
if (ackCallback != null && ackCallback.isAutoAck() && !ackCallback.isAcknowledged()) {
ackCallback.acknowledge(Status.ACCEPT);
}
@@ -61,7 +61,7 @@ public final class AckUtils {
* and is not already ack'd.
* @param ackCallback the callback.
*/
public static void autoNack(AcknowledgmentCallback ackCallback) {
public static void autoNack(@Nullable AcknowledgmentCallback ackCallback) {
if (ackCallback != null && ackCallback.isAutoAck() && !ackCallback.isAcknowledged()) {
ackCallback.acknowledge(Status.REJECT);
}

1
spring-integration-core/src/main/java/org/springframework/integration/acks/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Provides classes related to message acknowledgment.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.acks;

3
spring-integration-core/src/main/java/org/springframework/integration/channel/AbstractPollableChannel.java
View File

@@ -22,6 +22,7 @@ import java.util.List;
import org.springframework.integration.support.management.PollableChannelManagement;
import org.springframework.integration.support.management.metrics.CounterFacade;
import org.springframework.lang.Nullable;
import org.springframework.messaging.Message;
import org.springframework.messaging.PollableChannel;
import org.springframework.messaging.support.ChannelInterceptor;
@@ -71,6 +72,7 @@ public abstract class AbstractPollableChannel extends AbstractMessageChannel
* receiving thread is interrupted.
*/
@Override
@Nullable
public Message<?> receive() {
return receive(-1);
}
@@ -89,6 +91,7 @@ public abstract class AbstractPollableChannel extends AbstractMessageChannel
* interrupted.
*/
@Override
@Nullable
public Message<?> receive(long timeout) {
ChannelInterceptorList interceptorList = getInterceptors();
Deque<ChannelInterceptor> interceptorStack = null;

1
spring-integration-core/src/main/java/org/springframework/integration/channel/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Provides classes representing various channel types.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.channel;

1
spring-integration-core/src/main/java/org/springframework/integration/gateway/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Provides classes supporting messaging gateways.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.gateway;

1
spring-integration-core/src/main/java/org/springframework/integration/leader/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Temporary package until s-c-c-core is released.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.leader;

1
spring-integration-core/src/main/java/org/springframework/integration/mapping/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Provides classes related to mapping to/from message headers.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.mapping;

1
spring-integration-core/src/main/java/org/springframework/integration/package-info.java
View File

@@ -3,4 +3,5 @@
*
* Provides fundamental classes.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration;

1
spring-integration-core/src/main/java/org/springframework/integration/support/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Base core support package.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.support;

1
spring-integration-file/src/main/java/org/springframework/integration/file/support/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Provides various support classes used across Spring Integration File Components.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.file.support;

1
spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/package-info.java
View File

@@ -2,5 +2,6 @@
* All things related to tcp connections - client and
* server factories; listener and sender interfaces.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.ip.tcp.connection;

1
spring-integration-ip/src/main/java/org/springframework/integration/ip/udp/package-info.java
View File

@@ -1,4 +1,5 @@
/**
* Base package for UDP support.
*/
@org.springframework.lang.NonNullApi
package org.springframework.integration.ip.udp;

3
spring-integration-mongodb/src/test/java/org/springframework/integration/mongodb/dsl/MongoDbTests.java
View File

@@ -59,6 +59,7 @@ import com.mongodb.client.MongoCollection;
/**
* @author Xavier Padró
* @author Gary Russell
*
* @since 5.0
*/
@@ -314,7 +315,7 @@ public class MongoDbTests extends MongoDbAvailableTests {
@Bean
public IntegrationFlow gatewayCollectionCallbackFlow() {
return f -> f
.handle(collectionCallbackOutboundGateway(MongoCollection::count))
.handle(collectionCallbackOutboundGateway(MongoCollection::countDocuments))
.channel(getResultChannel());
}

5
spring-integration-mongodb/src/test/java/org/springframework/integration/mongodb/outbound/MongoDbOutboundGatewayTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2016-2017 the original author or authors.
* Copyright 2016-2018 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.
@@ -56,6 +56,7 @@ import com.mongodb.client.MongoCollection;
/**
* @author Xavier Padró
* @author Gary Russell
* @since 5.0
*/
@ContextConfiguration
@@ -313,7 +314,7 @@ public class MongoDbOutboundGatewayTests extends MongoDbAvailableTests {
gateway.setEntityClass(Person.class);
gateway.setCollectionNameExpression(new LiteralExpression("data"));
gateway.setCollectionCallback(MongoCollection::count);
gateway.setCollectionCallback(MongoCollection::countDocuments);
gateway.afterPropertiesSet();
long result = (long) gateway.handleRequestMessage(message);

5
spring-integration-redis/src/main/java/org/springframework/integration/redis/util/RedisUtils.java
View File

@@ -18,6 +18,7 @@ package org.springframework.integration.redis.util;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import org.springframework.data.redis.core.RedisCallback;
@@ -27,6 +28,7 @@ import org.springframework.data.redis.core.RedisOperations;
* A set of utility methods for common Redis functions.
*
* @author Artem Bilan
* @author Gary Russell
*
* @since 5.1
*/
@@ -36,11 +38,12 @@ public final class RedisUtils {
private static final String VERSION_PROPERTY = "redis_version";
@SuppressWarnings("serial")
private static final Map<RedisOperations<?, ?>, Boolean> unlinkAvailable =
new LinkedHashMap<RedisOperations<?, ?>, Boolean>() {
@Override
protected boolean removeEldestEntry(Map.Entry eldest) {
protected boolean removeEldestEntry(Entry<RedisOperations<?, ?>, Boolean> eldest) {
return size() > 100;
}

2
spring-integration-redis/src/test/java/org/springframework/integration/redis/store/DelayerHandlerRescheduleIntegrationTests.java
View File

@@ -118,7 +118,7 @@ public class DelayerHandlerRescheduleIntegrationTests extends RedisAvailableTest
assertEquals(1, messageStore.getMessageGroupCount());
int n = 0;
while (n++ < 200 && messageStore.messageGroupSize(delayerMessageGroupId) > 0) {
while (n++ < 300 && messageStore.messageGroupSize(delayerMessageGroupId) > 0) {
Thread.sleep(100);
}
assertEquals(0, messageStore.messageGroupSize(delayerMessageGroupId));