GH-1897 Fixed javadocs

Fixed javadocs issues that were preventing javadocs from being generated

Resolves #1897

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;
 
 /**
+ * <b>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</b>
+ * <br>
+ * <br>
  * 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.</li>
  * <li>By setting an {@link Input} bound target as the annotation value of
  * {@link StreamListener} and using
- * {@link org.springframework.messaging.handler.annotation.SendTo}</li> 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.
+ * </li>
  * </ul>
  *
  * An example of declarative method signature using the former idiom is as follows:

spring-cloud-stream/src/main/java/org/springframework/cloud/stream/binder/AbstractMessageChannelBinder.java

@@ -248,11 +248,6 @@ public abstract class AbstractMessageChannelBinder<C extends ConsumerProperties,
 		}
 		this.postProcessOutputChannel(outputChannel, producerProperties);
 
-//		if (shouldWireDunctionToChannel(true)) {
-//			outputChannel = this.postProcessOutboundChannelForFunction(outputChannel,
-//					producerProperties);
-//		}
-
 		((SubscribableChannel) outputChannel)
 				.subscribe(new SendingHandler(producerMessageHandler,
 						HeaderMode.embeddedHeaders
@@ -290,7 +285,6 @@ public abstract class AbstractMessageChannelBinder<C extends ConsumerProperties,
 		};
 
 		doPublishEvent(new BindingCreatedEvent(binding));
-//		this.producerBindingExist = true;
 		return binding;
 	}
 
@@ -302,7 +296,7 @@ public abstract class AbstractMessageChannelBinder<C extends ConsumerProperties,
 	 * Whether the producer for the destination being created should be configured to use
 	 * native encoding which may, or may not, be determined from the properties. For
 	 * example, a transactional kafka binder uses a common producer for all destinations.
-	 * The default implementation returns {@link P#isUseNativeEncoding()}.
+	 * The default implementation returns {@link ProducerProperties#isUseNativeEncoding()}.
 	 * @param producerProperties the properties.
 	 * @return true to use native encoding.
 	 */
@@ -406,11 +400,7 @@ public abstract class AbstractMessageChannelBinder<C extends ConsumerProperties,
 		try {
 			ConsumerDestination destination = this.provisioningProvider
 					.provisionConsumerDestination(name, group, properties);
-			// the function support for the inbound channel is only for Sink
-//			if (shouldWireDunctionToChannel(false)) {
-//				inputChannel = this.postProcessInboundChannelForFunction(inputChannel,
-//						properties);
-//			}
+
 			if (HeaderMode.embeddedHeaders.equals(properties.getHeaderMode())) {
 				enhanceMessageChannel(inputChannel);
 			}
@@ -925,85 +915,6 @@ public abstract class AbstractMessageChannelBinder<C extends ConsumerProperties,
 		}
 	}
 
-//	/*
-//	 * FUNCTION-TO-EXISTING-APP section
-//	 *
-//	 * To support composing functions into the existing apps. These methods do/should not
-//	 * participate in any way with general function bootstrap (e.g. brand new function
-//	 * based app). For that please see FunctionConfiguration.integrationFlowCreator
-//	 */
-//	private boolean shouldWireDunctionToChannel(boolean producer) {
-//		if (!producer && this.producerBindingExist) {
-//			return false;
-//		}
-//		else {
-//			return this.streamFunctionProperties != null
-//					&& StringUtils.hasText(this.streamFunctionProperties.getDefinition())
-//					&& (!this.getApplicationContext()
-//							.containsBean("integrationFlowCreator")
-//							|| this.getApplicationContext()
-//									.getBean("integrationFlowCreator").equals(null));
-//		}
-//	}
-
-//	private SubscribableChannel postProcessOutboundChannelForFunction(
-//			MessageChannel outputChannel, ProducerProperties producerProperties) {
-//		if (this.integrationFlowFunctionSupport != null) {
-//			Publisher<?> 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;

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 {

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 &lt; 0.11
 	 */
 	embeddedHeaders
 

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.