Skip to content

Commit

Permalink
Polish Javadoc for MessagePostProcessor interfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrannen committed Aug 10, 2020
1 parent 6a7e58a commit bd65762
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2005 the original author or authors.
* Copyright 2002-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.
Expand All @@ -20,11 +20,12 @@
import javax.jms.Message;

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

/**
* Apply a MessagePostProcessor to the message. The returned message is
* typically a modified version of the original.
* Process the given message.
* <p>The returned message is typically a modified version of the original.
* @param message the JMS message from the MessageConverter
* @return the modified version of the Message
* @return a post-processed variant of the message, or simply the incoming
* message; never {@code null}
* @throws javax.jms.JMSException if thrown by JMS API methods
*/
Message postProcessMessage(Message message) throws JMSException;
Expand Down
Expand Up @@ -34,8 +34,8 @@ public interface MessagePostProcessor {
/**
* Process the given message.
* @param message the message to process
* @return a post-processed variant of the message,
* or simply the incoming message; never {@code null}
* @return a post-processed variant of the message, or simply the incoming
* message; never {@code null}
*/
Message<?> postProcessMessage(Message<?> message);

Expand Down

0 comments on commit bd65762

Please sign in to comment.