Skip to content

Commit bd65762

Browse files
committed
Polish Javadoc for MessagePostProcessor interfaces
See gh-25571
1 parent 6a7e58a commit bd65762

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

spring-jms/src/main/java/org/springframework/jms/core/MessagePostProcessor.java

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2005 the original author or authors.
2+
* Copyright 2002-2020 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,11 +20,12 @@
2020
import javax.jms.Message;
2121

2222
/**
23-
* To be used with JmsTemplate's send method that convert an object to a message.
24-
* It allows for further modification of the message after it has been processed
25-
* by the converter. This is useful for setting of JMS Header and Properties.
23+
* To be used with JmsTemplate's send method that converts an object to a message.
2624
*
27-
* <p>This often as an anonymous class within a method implementation.
25+
* <p>This allows for further modification of the message after it has been processed
26+
* by the converter and is useful for setting JMS headers and properties.
27+
*
28+
* <p>Often implemented as a lambda expression or as an anonymous inner class.
2829
*
2930
* @author Mark Pollack
3031
* @since 1.1
@@ -36,10 +37,11 @@
3637
public interface MessagePostProcessor {
3738

3839
/**
39-
* Apply a MessagePostProcessor to the message. The returned message is
40-
* typically a modified version of the original.
40+
* Process the given message.
41+
* <p>The returned message is typically a modified version of the original.
4142
* @param message the JMS message from the MessageConverter
42-
* @return the modified version of the Message
43+
* @return a post-processed variant of the message, or simply the incoming
44+
* message; never {@code null}
4345
* @throws javax.jms.JMSException if thrown by JMS API methods
4446
*/
4547
Message postProcessMessage(Message message) throws JMSException;

spring-messaging/src/main/java/org/springframework/messaging/core/MessagePostProcessor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ public interface MessagePostProcessor {
3434
/**
3535
* Process the given message.
3636
* @param message the message to process
37-
* @return a post-processed variant of the message,
38-
* or simply the incoming message; never {@code null}
37+
* @return a post-processed variant of the message, or simply the incoming
38+
* message; never {@code null}
3939
*/
4040
Message<?> postProcessMessage(Message<?> message);
4141

0 commit comments

Comments
 (0)