Consistent javadoc param declarations for type variables

This commit is contained in:
Juergen Hoeller
2015-03-25 00:44:01 +01:00
parent 22670b7fad
commit d23893fd25
24 changed files with 80 additions and 98 deletions

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2015 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.
@@ -22,12 +22,11 @@ import org.springframework.messaging.MessagingException;
/**
* Operations for receiving messages from a destination.
*
* @param <D> the type of destination to receive messages from
*
* @author Mark Fisher
* @author Rossen Stoyanchev
* @since 4.0
* @see GenericMessagingTemplate
* @param <D> the type of destination to receive messages from
*/
public interface MessageReceivingOperations<D> {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2015 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,12 +24,11 @@ import org.springframework.messaging.MessagingException;
/**
* Operations for sending messages to and receiving the reply from a destination.
*
* @param <D> the type of destination
*
* @author Mark Fisher
* @author Rossen Stoyanchev
* @since 4.0
* @see GenericMessagingTemplate
* @param <D> the type of destination
*/
public interface MessageRequestReplyOperations<D> {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2015 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,11 +24,10 @@ import org.springframework.messaging.MessagingException;
/**
* Operations for sending messages to a destination.
*
* @param <D> the type of destination to send messages to
*
* @author Mark Fisher
* @author Rossen Stoyanchev
* @since 4.0
* @param <D> the type of destination to send messages to
*/
public interface MessageSendingOperations<D> {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2015 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.
@@ -25,10 +25,9 @@ import org.springframework.messaging.Message;
* matched to a specific Message, as well as compared to each other in the
* context of a Message to determine which one matches a request more closely.
*
* @param <T> The kind of condition that this condition can be combined with or compared to
*
* @author Rossen Stoyanchev
* @since 4.0
* @param <T> the kind of condition that this condition can be combined with or compared to
*/
public interface MessageCondition<T> {

View File

@@ -58,11 +58,10 @@ import org.springframework.util.ReflectionUtils;
* <p>Also supports discovering and invoking exception handling methods to process
* exceptions raised during message handling.
*
* @param <T> the type of the Object that contains information mapping a
* {@link org.springframework.messaging.handler.HandlerMethod} to incoming messages
*
* @author Rossen Stoyanchev
* @since 4.0
* @param <T> the type of the Object that contains information mapping a
* {@link org.springframework.messaging.handler.HandlerMethod} to incoming messages
*/
public abstract class AbstractMethodMessageHandler<T>
implements MessageHandler, ApplicationContextAware, InitializingBean {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2015 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.
@@ -22,10 +22,9 @@ import org.springframework.messaging.Message;
* A contract for managing lifecycle events for a TCP connection including
* the handling of incoming messages.
*
* @param <P> the type of payload for in and outbound messages
*
* @author Rossen Stoyanchev
* @since 4.0
* @param <P> the type of payload for in and outbound messages
*/
public interface TcpConnectionHandler<P> {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2015 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,10 +21,9 @@ import org.springframework.util.concurrent.ListenableFuture;
/**
* A contract for establishing TCP connections.
*
* @param <P> the type of payload for in and outbound messages
*
* @author Rossen Stoyanchev
* @since 4.0
* @param <P> the type of payload for in and outbound messages
*/
public interface TcpOperations<P> {

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2015 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.
@@ -34,11 +34,10 @@ import org.springframework.util.concurrent.SuccessCallback;
* Adapts a reactor {@link Promise} to {@link ListenableFuture} optionally converting
* the result Object type {@code <S>} to the expected target type {@code <T>}.
*
* @param <S> the type of object expected from the {@link Promise}
* @param <T> the type of object expected from the {@link ListenableFuture}
*
* @author Rossen Stoyanchev
* @since 4.0
* @param <S> the type of object expected from the {@link Promise}
* @param <T> the type of object expected from the {@link ListenableFuture}
*/
abstract class AbstractPromiseToListenableFutureAdapter<S, T> implements ListenableFuture<T> {
@@ -113,4 +112,5 @@ abstract class AbstractPromiseToListenableFutureAdapter<S, T> implements Listena
this.registry.addSuccessCallback(successCallback);
this.registry.addFailureCallback(failureCallback);
}
}

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2015 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.
@@ -23,15 +23,14 @@ import org.springframework.messaging.Message;
import org.springframework.messaging.tcp.TcpConnection;
import org.springframework.util.concurrent.ListenableFuture;
/**
* An implementation of {@link org.springframework.messaging.tcp.TcpConnection}
* based on the TCP client support of the Reactor project.
*
* @param <P> the payload type of Spring Message's read from
* and written to the TCP stream
*
* @author Rossen Stoyanchev
* @since 4.0
* @param <P> the payload type of Spring Message's read from and written to
* the TCP stream
*/
public class Reactor11TcpConnection<P> implements TcpConnection<P> {
@@ -42,6 +41,7 @@ public class Reactor11TcpConnection<P> implements TcpConnection<P> {
this.channel = connection;
}
@Override
public ListenableFuture<Void> send(Message<P> message) {
Promise<Void> promise = this.channel.send(message);