From 897cb670aa9e0431736ea24ca007715bf0cc5ae7 Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Tue, 11 Feb 2020 09:25:40 +0100 Subject: [PATCH] GH-1897 Fixed javadocs Fixed javadocs issues that were preventing javadocs from being generated Resolves #1897 --- docs/pom.xml | 7 ++ pom.xml | 6 -- spring-cloud-stream-binder-test/pom.xml | 11 +++ spring-cloud-stream-integration-tests/pom.xml | 11 +++ .../pom.xml | 11 +++ spring-cloud-stream-test-support/pom.xml | 11 +++ .../stream/annotation/StreamListener.java | 7 +- .../binder/AbstractMessageChannelBinder.java | 93 +------------------ .../stream/binder/EmbeddedHeaderUtils.java | 3 +- .../cloud/stream/binder/HeaderMode.java | 4 +- .../SpelExpressionConverterConfiguration.java | 2 +- 11 files changed, 63 insertions(+), 103 deletions(-) diff --git a/docs/pom.xml b/docs/pom.xml index 7ffab3146..3b6f7a0c2 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -26,6 +26,13 @@ true + + org.apache.maven.plugins + maven-javadoc-plugin + + true + + diff --git a/pom.xml b/pom.xml index e9b2ce1f6..83e2cbd4d 100644 --- a/pom.xml +++ b/pom.xml @@ -120,12 +120,6 @@ - org.apache.maven.plugins maven-antrun-plugin diff --git a/spring-cloud-stream-binder-test/pom.xml b/spring-cloud-stream-binder-test/pom.xml index 477442fda..776c4a0f2 100644 --- a/spring-cloud-stream-binder-test/pom.xml +++ b/spring-cloud-stream-binder-test/pom.xml @@ -51,4 +51,15 @@ test-binder + + + + org.apache.maven.plugins + maven-javadoc-plugin + + true + + + + diff --git a/spring-cloud-stream-integration-tests/pom.xml b/spring-cloud-stream-integration-tests/pom.xml index e4c9bf9d2..1a0ddc7ab 100644 --- a/spring-cloud-stream-integration-tests/pom.xml +++ b/spring-cloud-stream-integration-tests/pom.xml @@ -47,5 +47,16 @@ test + + + + org.apache.maven.plugins + maven-javadoc-plugin + + true + + + + diff --git a/spring-cloud-stream-test-support-internal/pom.xml b/spring-cloud-stream-test-support-internal/pom.xml index 9046beba8..994d9b78f 100644 --- a/spring-cloud-stream-test-support-internal/pom.xml +++ b/spring-cloud-stream-test-support-internal/pom.xml @@ -27,4 +27,15 @@ spring-boot-starter-logging + + + + org.apache.maven.plugins + maven-javadoc-plugin + + true + + + + diff --git a/spring-cloud-stream-test-support/pom.xml b/spring-cloud-stream-test-support/pom.xml index e357cb801..4cba68d3a 100644 --- a/spring-cloud-stream-test-support/pom.xml +++ b/spring-cloud-stream-test-support/pom.xml @@ -34,4 +34,15 @@ jackson-databind + + + + org.apache.maven.plugins + maven-javadoc-plugin + + true + + + + diff --git a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/annotation/StreamListener.java b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/annotation/StreamListener.java index 5fa96eb56..b08b53805 100644 --- a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/annotation/StreamListener.java +++ b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/annotation/StreamListener.java @@ -27,6 +27,10 @@ import org.springframework.core.annotation.AliasFor; import org.springframework.messaging.handler.annotation.MessageMapping; /** + * NOTE: It is no longer recommended to use StreamListener in favor of functional programming model. + * It will be deprecated and subsequently removed in the future + *
+ *
* Annotation that marks a method to be a listener to inputs declared via * {@link EnableBinding} (e.g. channels). * @@ -53,9 +57,10 @@ import org.springframework.messaging.handler.annotation.MessageMapping; * {@link StreamListener} annotation must not specify a value. *
  • By setting an {@link Input} bound target as the annotation value of * {@link StreamListener} and using - * {@link org.springframework.messaging.handler.annotation.SendTo}
    • on the method for + * {@link org.springframework.messaging.handler.annotation.SendTo} on the method for * the return type (if applicable). In this case the method must have exactly one * parameter, corresponding to an input. + * * * * An example of declarative method signature using the former idiom is as follows: diff --git a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/AbstractMessageChannelBinder.java b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/AbstractMessageChannelBinder.java index f1e1197a7..ab766f7be 100644 --- a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/AbstractMessageChannelBinder.java +++ b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/AbstractMessageChannelBinder.java @@ -248,11 +248,6 @@ public abstract class AbstractMessageChannelBinder publisher = MessageChannelReactiveUtils -// .toPublisher(outputChannel); -// // If the app has an explicit Supplier bean defined, make that as the -// // publisher -// if (this.integrationFlowFunctionSupport.containsFunction(Supplier.class)) { -// IntegrationFlowBuilder integrationFlowBuilder = IntegrationFlows -// .from(outputChannel).bridge(); -// publisher = integrationFlowBuilder.toReactivePublisher(); -// } -// if (this.integrationFlowFunctionSupport.containsFunction(Function.class, -// this.streamFunctionProperties.getDefinition())) { -// DirectChannel actualOutputChannel = new DirectChannel(); -// if (outputChannel instanceof AbstractMessageChannel) { -// moveChannelInterceptors((AbstractMessageChannel) outputChannel, -// actualOutputChannel); -// } -// this.integrationFlowFunctionSupport.andThenFunction(publisher, -// actualOutputChannel, this.streamFunctionProperties); -// return actualOutputChannel; -// } -// } -// return (SubscribableChannel) outputChannel; -// } - -// private SubscribableChannel postProcessInboundChannelForFunction( -// MessageChannel inputChannel, ConsumerProperties consumerProperties) { -// if (this.integrationFlowFunctionSupport != null -// && (this.integrationFlowFunctionSupport.containsFunction(Consumer.class) -// || this.integrationFlowFunctionSupport -// .containsFunction(Function.class))) { -// DirectChannel actualInputChannel = new DirectChannel(); -// if (inputChannel instanceof AbstractMessageChannel) { -// moveChannelInterceptors((AbstractMessageChannel) inputChannel, -// actualInputChannel); -// } -// -// this.integrationFlowFunctionSupport.andThenFunction( -// MessageChannelReactiveUtils.toPublisher(actualInputChannel), -// inputChannel, this.streamFunctionProperties); -// return actualInputChannel; -// } -// return (SubscribableChannel) inputChannel; -// } - -// private void moveChannelInterceptors(InterceptableChannel existingMessageChannel, -// AbstractMessageChannel actualMessageChannel) { -// for (ChannelInterceptor channelInterceptor : existingMessageChannel -// .getInterceptors()) { -// actualMessageChannel.addInterceptor(channelInterceptor); -// existingMessageChannel.removeInterceptor(channelInterceptor); -// } -// } - - // END FUNCTION-TO-EXISTING-APP section - protected static class ErrorInfrastructure { private final SubscribableChannel errorChannel; diff --git a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/EmbeddedHeaderUtils.java b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/EmbeddedHeaderUtils.java index 597b204e2..75f6125c8 100644 --- a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/EmbeddedHeaderUtils.java +++ b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/EmbeddedHeaderUtils.java @@ -1,5 +1,5 @@ /* - * Copyright 2014-2017 the original author or authors. + * Copyright 2014-2020 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. @@ -59,7 +59,6 @@ public abstract class EmbeddedHeaderUtils { * @param original original message * @param headers headers to embedd * @return a new message - * @throws Exception when message couldn't be generated */ public static byte[] embedHeaders(MessageValues original, String... headers) { try { diff --git a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/HeaderMode.java b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/HeaderMode.java index d88f5127e..41a729270 100644 --- a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/HeaderMode.java +++ b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/HeaderMode.java @@ -1,5 +1,5 @@ /* - * Copyright 2016-2017 the original author or authors. + * Copyright 2016-2020 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. @@ -33,7 +33,7 @@ public enum HeaderMode { headers, /** - * Headers embedded in payload - e.g. kafka < 0.11 + * Headers embedded in payload - e.g. kafka < 0.11 */ embeddedHeaders diff --git a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/config/SpelExpressionConverterConfiguration.java b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/config/SpelExpressionConverterConfiguration.java index 81c5fd9c6..b232c67c9 100644 --- a/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/config/SpelExpressionConverterConfiguration.java +++ b/spring-cloud-stream/src/main/java/org/springframework/cloud/stream/config/SpelExpressionConverterConfiguration.java @@ -49,7 +49,7 @@ public class SpelExpressionConverterConfiguration { /** * Provide a {@link SpelPropertyAccessorRegistrar} supplied with the - * {@link JsonPropertyAccessor} and {@link TuplePropertyAccessor}. This bean is used + * {@link JsonPropertyAccessor}. This bean is used * to customize an * {@link org.springframework.integration.config.IntegrationEvaluationContextFactoryBean}. * for additional {@link org.springframework.expression.PropertyAccessor}s.