Spring/spring-ws
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixing javadoc

Browse Source
This commit is contained in:
Arjen Poutsma
2014-04-16 17:30:39 +02:00
parent 124675ba78
commit bbc6bf5f60
327 changed files with 2901 additions and 2292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpExchangeConnection.java
View File

@@ -53,13 +53,13 @@ public class HttpExchangeConnection extends AbstractReceiverConnection
private boolean chunkedEncoding;
/** Constructs a new exchange connection with the given <code>HttpExchange</code>. */
/** Constructs a new exchange connection with the given {@code HttpExchange}. */
protected HttpExchangeConnection(HttpExchange httpExchange) {
Assert.notNull(httpExchange, "'httpExchange' must not be null");
this.httpExchange = httpExchange;
}
/** Returns the <code>HttpExchange</code> for this connection. */
/** Returns the {@code HttpExchange} for this connection. */
public HttpExchange getHttpExchange() {
return httpExchange;
}

8
spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpsUrlConnectionMessageSender.java
View File

@@ -81,8 +81,8 @@ public class HttpsUrlConnectionMessageSender extends HttpUrlConnectionMessageSen
/**
* Specifies the key managers to use for this message sender.
* <p/>
* Setting either this property or {@link #setTrustManagers(TrustManager[]) trustManagers} is required.
*
* <p>Setting either this property or {@link #setTrustManagers(TrustManager[]) trustManagers} is required.
*
* @see SSLContext#init(KeyManager[], TrustManager[], SecureRandom)
*/
@@ -92,8 +92,8 @@ public class HttpsUrlConnectionMessageSender extends HttpUrlConnectionMessageSen
/**
* Specifies the trust managers to use for this message sender.
* <p/>
* Setting either this property or {@link #setKeyManagers(KeyManager[]) keyManagers} is required.
*
* <p>Setting either this property or {@link #setKeyManagers(KeyManager[]) keyManagers} is required.
*
* @see SSLContext#init(KeyManager[], TrustManager[], SecureRandom)
*/

6
spring-ws-support/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHttpHandler.java
View File

@@ -26,8 +26,8 @@ import org.springframework.ws.transport.support.SimpleWebServiceMessageReceiverO
/**
* {@link HttpHandler} that can be used to handle incoming {@link HttpExchange} service requests. Designed for Sun's JRE
* 1.6 HTTP server.
* <p/>
* Requires a {@link org.springframework.ws.WebServiceMessageFactory} which is used to convert the incoming {@link
*
* <p>Requires a {@link org.springframework.ws.WebServiceMessageFactory} which is used to convert the incoming {@link
* HttpExchange} into a {@link org.springframework.ws.WebServiceMessage}, and passes that to the {@link
* org.springframework.ws.transport.WebServiceMessageReceiver} {@link #setMessageReceiver(org.springframework.ws.transport.WebServiceMessageReceiver)
* registered}.
@@ -41,7 +41,7 @@ public class WebServiceMessageReceiverHttpHandler extends SimpleWebServiceMessag
private boolean chunkedEncoding = false;
/** Enables chunked encoding on response bodies. Defaults to <code>false</code>. */
/** Enables chunked encoding on response bodies. Defaults to {@code false}. */
public void setChunkedEncoding(boolean chunkedEncoding) {
this.chunkedEncoding = chunkedEncoding;
}

10
spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageReceiver.java
View File

@@ -28,10 +28,10 @@ import org.springframework.ws.transport.support.SimpleWebServiceMessageReceiverO
/**
* Convenience base class for JMS server-side transport objects. Contains a {@link WebServiceMessageReceiver}, and has
* methods for handling incoming JMS {@link BytesMessage} and {@link TextMessage} requests. Also contains a
* <code>textMessageEncoding</code> property, which determines the encoding used to read from and write to
* <code>TextMessages</code>. This property defaults to <code>UTF-8</code>.
* <p/>
* Used by {@link WebServiceMessageListener}.
* {@code textMessageEncoding} property, which determines the encoding used to read from and write to
* {@code TextMessages}. This property defaults to {@code UTF-8}.
*
* <p>Used by {@link WebServiceMessageListener}.
*
* @author Arjen Poutsma
* @since 1.5.0
@@ -45,7 +45,7 @@ public class JmsMessageReceiver extends SimpleWebServiceMessageReceiverObjectSup
private MessagePostProcessor postProcessor;
/** Sets the encoding used to read from and write to {@link TextMessage} messages. Defaults to <code>UTF-8</code>. */
/** Sets the encoding used to read from and write to {@link TextMessage} messages. Defaults to {@code UTF-8}. */
public void setTextMessageEncoding(String textMessageEncoding) {
this.textMessageEncoding = textMessageEncoding;
}

32
spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageSender.java
View File

@@ -43,12 +43,12 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils;
/**
* {@link WebServiceMessageSender} implementation that uses JMS {@link Message}s. Requires a JMS {@link
* ConnectionFactory} to operate.
* <p/>
* This message sender supports URI's of the following format: <blockquote> <tt><b>jms:</b></tt><i>destination</i>[<tt><b>?</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>][<tt><b>&amp;</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>]*
*
* <p>This message sender supports URI's of the following format: <blockquote> <tt><b>jms:</b></tt><i>destination</i>[<tt><b>?</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>][<tt><b>&amp;</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>]*
* </blockquote> where the characters <tt><b>:</b></tt>, <tt><b>?</b></tt>, and <tt><b>&amp;</b></tt> stand for
* themselves. The <i>destination</i> represents the name of the {@link Queue} or {@link Topic} that will be resolved by
* the {@link #getDestinationResolver() destination resolver}. Valid <i>param-name</i> include:
* <p/>
*
* <blockquote>
* <table>
* <tr><th><i>param-name</i></th><th><i>Description</i></th></tr>
@@ -78,15 +78,15 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils;
* </tr>
* </table>
* </blockquote>
* <p/>
* If the <tt>replyToName</tt> is not set, a {@link Session#createTemporaryQueue() temporary queue} is used.
* <p/>
* This class uses {@link BytesMessage} messages by default, but can be configured to send {@link TextMessage} messages
* instead. <b>Note</b> that <code>BytesMessages</code> are preferred, since <code>TextMessages</code> do not support
*
* <p>If the <tt>replyToName</tt> is not set, a {@link Session#createTemporaryQueue() temporary queue} is used.
*
* <p>This class uses {@link BytesMessage} messages by default, but can be configured to send {@link TextMessage} messages
* instead. <b>Note</b> that {@code BytesMessages} are preferred, since {@code TextMessages} do not support
* attachments and character encodings reliably.
* <p/>
* Some examples of JMS URIs are:
* <p/>
*
* <p>Some examples of JMS URIs are:
*
* <blockquote> <tt>jms:SomeQueue</tt><br> <tt>jms:SomeTopic?priority=3&deliveryMode=NON_PERSISTENT</tt><br>
* <tt>jms:RequestQueue?replyToName=ResponseQueueName</tt><br> <tt>jms:Queue?messageType=TEXT_MESSAGE</blockquote>
*
@@ -109,9 +109,9 @@ public class JmsMessageSender extends JmsDestinationAccessor implements WebServi
private MessagePostProcessor postProcessor;
/**
* Create a new <code>JmsMessageSender</code>
* <p/>
* <b>Note</b>: The ConnectionFactory has to be set before using the instance. This constructor can be used to
* Create a new {@code JmsMessageSender}
*
* <p><b>Note</b>: The ConnectionFactory has to be set before using the instance. This constructor can be used to
* prepare a JmsTemplate via a BeanFactory, typically setting the ConnectionFactory via {@link
* #setConnectionFactory(ConnectionFactory)}.
*
@@ -121,7 +121,7 @@ public class JmsMessageSender extends JmsDestinationAccessor implements WebServi
}
/**
* Create a new <code>JmsMessageSender</code>, given a ConnectionFactory.
* Create a new {@code JmsMessageSender}, given a ConnectionFactory.
*
* @param connectionFactory the ConnectionFactory to obtain Connections from
*/
@@ -138,7 +138,7 @@ public class JmsMessageSender extends JmsDestinationAccessor implements WebServi
this.receiveTimeout = receiveTimeout;
}
/** Sets the encoding used to read from {@link TextMessage} messages. Defaults to <code>UTF-8</code>. */
/** Sets the encoding used to read from {@link TextMessage} messages. Defaults to {@code UTF-8}. */
public void setTextMessageEncoding(String textMessageEncoding) {
this.textMessageEncoding = textMessageEncoding;
}

8
spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsReceiverConnection.java
View File

@@ -40,10 +40,10 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils;
/**
* Implementation of {@link WebServiceConnection} that is used for server-side JMS access. Exposes a {@link
* BytesMessage} or {@link TextMessage} request and response message.
* <p/>
* The response message type is equal to the request message type, i.e. if a <code>BytesMessage</code> is received as
* request, a <code>BytesMessage</code> is created as response, and if a <code>TextMessage</code> is received, a
* <code>TextMessage</code> response is created.
*
* <p>The response message type is equal to the request message type, i.e. if a {@code BytesMessage} is received as
* request, a {@code BytesMessage} is created as response, and if a {@code TextMessage} is received, a
* {@code TextMessage} response is created.
*
* @author Arjen Poutsma
* @since 1.5.0

4
spring-ws-support/src/main/java/org/springframework/ws/transport/jms/WebServiceMessageListener.java
View File

@@ -28,8 +28,8 @@ import org.springframework.ws.transport.WebServiceMessageReceiver;
/**
* Spring {@link SessionAwareMessageListener} that can be used to handle incoming {@link Message} service requests.
* <p/>
* Requires a {@link WebServiceMessageFactory} which is used to convert the incoming JMS {@link BytesMessage} into a
*
* <p>Requires a {@link WebServiceMessageFactory} which is used to convert the incoming JMS {@link BytesMessage} into a
* {@link WebServiceMessage}, and passes that to the {@link WebServiceMessageReceiver} {@link
* #setMessageReceiver(WebServiceMessageReceiver) registered}.
*

2
spring-ws-support/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java
View File

@@ -96,7 +96,7 @@ public abstract class JmsTransportUtils {
}
/**
* Converts the given JMS destination into a <code>jms</code> URI.
* Converts the given JMS destination into a {@code jms} URI.
*
* @param destination the destination
* @return a jms URI

36
spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageReceiver.java
View File

@@ -42,8 +42,8 @@ import org.springframework.ws.transport.support.AbstractAsyncStandaloneMessageRe
* transport} URI, {@link #setStoreUri(String) store} URI, and {@link #setMonitoringStrategy(MonitoringStrategy)
* monitoringStrategy} to be set, in addition to the {@link #setMessageFactory(WebServiceMessageFactory) messageFactory}
* and {@link #setMessageReceiver(WebServiceMessageReceiver) messageReceiver} required by the base class.
* <p/>
* The {@link MonitoringStrategy} is used to detect new incoming email request. If the <code>monitoringStrategy</code>
*
* <p>The {@link MonitoringStrategy} is used to detect new incoming email request. If the {@code monitoringStrategy}
* is not explicitly set, this receiver will use the {@link Pop3PollingMonitoringStrategy} for POP3 servers, and the
* {@link PollingMonitoringStrategy} for IMAP servers.
*
@@ -73,24 +73,24 @@ public class MailMessageReceiver extends AbstractAsyncStandaloneMessageReceiver
/**
* Set JavaMail properties for the {@link Session}.
* <p/>
* A new {@link Session} will be created with those properties. Use either this method or {@link #setSession}, but
*
* <p>A new {@link Session} will be created with those properties. Use either this method or {@link #setSession}, but
* not both.
* <p/>
* Non-default properties in this instance will override given JavaMail properties.
*
* <p>Non-default properties in this instance will override given JavaMail properties.
*/
public void setJavaMailProperties(Properties javaMailProperties) {
session = Session.getInstance(javaMailProperties, null);
}
/**
* Set the JavaMail <code>Session</code>, possibly pulled from JNDI.
* <p/>
* Default is a new <code>Session</code> without defaults, that is completely configured via this instance's
* Set the JavaMail {@code Session}, possibly pulled from JNDI.
*
* <p>Default is a new {@code Session} without defaults, that is completely configured via this instance's
* properties.
* <p/>
* If using a pre-configured <code>Session</code>, non-default properties in this instance will override the
* settings in the <code>Session</code>.
*
* <p>If using a pre-configured {@code Session}, non-default properties in this instance will override the
* settings in the {@code Session}.
*
* @see #setJavaMailProperties
*/
@@ -101,9 +101,9 @@ public class MailMessageReceiver extends AbstractAsyncStandaloneMessageReceiver
/**
* Sets the JavaMail Store URI to be used for retrieving request messages. Typically takes the form of
* <code>[imap|pop3]://user:password@host:port/INBOX</code>. Setting this property is required.
* <p/>
* For example, <code>imap://john:secret@imap.example.com/INBOX</code>
* {@code [imap|pop3]://user:password@host:port/INBOX}. Setting this property is required.
*
* <p>For example, {@code imap://john:secret@imap.example.com/INBOX}
*
* @see Session#getStore(URLName)
*/
@@ -113,9 +113,9 @@ public class MailMessageReceiver extends AbstractAsyncStandaloneMessageReceiver
/**
* Sets the JavaMail Transport URI to be used for sending response messages. Typically takes the form of
* <code>smtp://user:password@host:port</code>. Setting this property is required.
* <p/>
* For example, <code>smtp://john:secret@smtp.example.com</code>
* {@code smtp://user:password@host:port}. Setting this property is required.
*
* <p>For example, {@code smtp://john:secret@smtp.example.com}
*
* @see Session#getTransport(URLName)
*/

48
spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageSender.java
View File

@@ -36,23 +36,23 @@ import org.springframework.ws.transport.mail.support.MailTransportUtils;
/**
* {@link WebServiceMessageSender} implementation that uses Mail {@link MimeMessage}s. Requires a {@link
* #setTransportUri(String) transport} and {@link #setStoreUri(String) store} URI to be set.
* <p/>
* Calling {@link WebServiceConnection#receive(WebServiceMessageFactory)} on connections created by this message sender
*
* <p>Calling {@link WebServiceConnection#receive(WebServiceMessageFactory)} on connections created by this message sender
* will result in a blocking call, for the amount of milliseconds specified by the {@link #setReceiveSleepTime(long)
* receiveSleepTime} property. This will give the server time to formulate a response message. By default, this propery
* is set to 1 minute. For a proper request-response conversation to work, this property value must not be smaller the
* {@link PollingMonitoringStrategy#setPollingInterval(long) pollingInterval} property of the server-side message
* receiver polling strategy.
* <p/>
* This message sender supports URI's of the following format: <blockquote> <tt><b>mailto:</b></tt><i>to</i>[<tt><b>?</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>][<tt><b>&amp;</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>]*
*
* <p>This message sender supports URI's of the following format: <blockquote> <tt><b>mailto:</b></tt><i>to</i>[<tt><b>?</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>][<tt><b>&amp;</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>]*
* </blockquote> where the characters <tt><b>:</b></tt>, <tt><b>?</b></tt>, and <tt><b>&amp;</b></tt> stand for
* themselves. The <i>to</i> represents a RFC 822 mailbox. Valid <i>param-name</i> include:
* <p/>
*
* <blockquote><table> <tr><th><i>param-name</i></th><th><i>Description</i></th></tr>
* <tr><td><tt>subject</tt></td><td>The subject of the request message.</td></tr> </table></blockquote>
* <p/>
* Some examples of email URIs are:
* <p/>
*
* <p>Some examples of email URIs are:
*
* <blockquote><tt>mailto:john@example.com</tt><br> <tt>mailto:john@example.com@?subject=SOAP%20Test</tt><br></blockquote>
*
* @author Arjen Poutsma
@@ -85,11 +85,11 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB
/**
* Set JavaMail properties for the {@link Session}.
* <p/>
* A new {@link Session} will be created with those properties. Use either this method or {@link #setSession}, but
*
* <p>A new {@link Session} will be created with those properties. Use either this method or {@link #setSession}, but
* not both.
* <p/>
* Non-default properties in this instance will override given JavaMail properties.
*
* <p>Non-default properties in this instance will override given JavaMail properties.
*/
public void setJavaMailProperties(Properties javaMailProperties) {
session = Session.getInstance(javaMailProperties, null);
@@ -104,13 +104,13 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB
}
/**
* Set the JavaMail <code>Session</code>, possibly pulled from JNDI.
* <p/>
* Default is a new <code>Session</code> without defaults, that is completely configured via this instance's
* Set the JavaMail {@code Session}, possibly pulled from JNDI.
*
* <p>Default is a new {@code Session} without defaults, that is completely configured via this instance's
* properties.
* <p/>
* If using a pre-configured <code>Session</code>, non-default properties in this instance will override the
* settings in the <code>Session</code>.
*
* <p>If using a pre-configured {@code Session}, non-default properties in this instance will override the
* settings in the {@code Session}.
*
* @see #setJavaMailProperties
*/
@@ -121,9 +121,9 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB
/**
* Sets the JavaMail Store URI to be used for retrieving response messages. Typically takes the form of
* <code>[imap|pop3]://user:password@host:port/INBOX</code>. Setting this property is required.
* <p/>
* For example, <code>imap://john:secret@imap.example.com/INBOX</code>
* {@code [imap|pop3]://user:password@host:port/INBOX}. Setting this property is required.
*
* <p>For example, {@code imap://john:secret@imap.example.com/INBOX}
*
* @see Session#getStore(URLName)
*/
@@ -133,9 +133,9 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB
/**
* Sets the JavaMail Transport URI to be used for sending response messages. Typically takes the form of
* <code>smtp://user:password@host:port</code>. Setting this property is required.
* <p/>
* For example, <code>smtp://john:secret@smtp.example.com</code>
* {@code smtp://user:password@host:port}. Setting this property is required.
*
* <p>For example, {@code smtp://john:secret@smtp.example.com}
*
* @see Session#getTransport(URLName)
*/

6
spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/AbstractMonitoringStrategy.java
View File

@@ -44,7 +44,7 @@ public abstract class AbstractMonitoringStrategy implements MonitoringStrategy {
/**
* Sets whether messages should be marked as {@link javax.mail.Flags.Flag#DELETED DELETED} after they have been
* read. Default is <code>true</code>.
* read. Default is {@code true}.
*/
public void setDeleteMessages(boolean deleteMessages) {
this.deleteMessages = deleteMessages;
@@ -59,7 +59,7 @@ public abstract class AbstractMonitoringStrategy implements MonitoringStrategy {
* Monitors the given folder, and returns any new messages when they arrive. This implementation calls {@link
* #waitForNewMessages(Folder)}, then searches for new messages using {@link #searchForNewMessages(Folder)}, fetches
* the messages using {@link #fetchMessages(Folder, Message[])}, and finally {@link #setDeleteMessages(boolean)
* deletes} the messages, if {@link #setDeleteMessages(boolean) deleteMessages} is <code>true</code>.
* deletes} the messages, if {@link #setDeleteMessages(boolean) deleteMessages} is {@code true}.
*
* @param folder the folder to monitor
* @return the new messages
@@ -152,7 +152,7 @@ public abstract class AbstractMonitoringStrategy implements MonitoringStrategy {
/**
* Deletes the given messages from the given folder. Only invoked when {@link #setDeleteMessages(boolean)} is
* <code>true</code>.
* {@code true}.
*
* @param folder the folder to delete messages from
* @param messages the messages to delete

4
spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/ImapIdleMonitoringStrategy.java
View File

@@ -30,8 +30,8 @@ import com.sun.mail.imap.IMAPFolder;
/**
* Implementation of the {@link MonitoringStrategy} interface that uses the IMAP IDLE command for asynchronous message
* detection.
* <p/>
* <b>Note</b> that this implementation is only suitable for use with IMAP servers which support the IDLE command.
*
* <p><b>Note</b> that this implementation is only suitable for use with IMAP servers which support the IDLE command.
* Additionally, this strategy requires JavaMail version 1.4.1.
*
* @author Arjen Poutsma

2
spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/MonitoringStrategy.java
View File

@@ -22,7 +22,7 @@ import javax.mail.MessagingException;
/**
* Defines the contract for objects that monitor a given folder for new messages. Allows for multiple implementation
* strategies, including polling, or event-driven techniques such as IMAP's <code>IDLE</code> command.
* strategies, including polling, or event-driven techniques such as IMAP's {@code IDLE} command.
*
* @author Arjen Poutsma
*/

4
spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/PollingMonitoringStrategy.java
View File

@@ -22,8 +22,8 @@ import javax.mail.MessagingException;
/**
* Implementation of the {@link MonitoringStrategy} interface that uses a simple polling mechanism. Defines a {@link
* #setPollingInterval(long) polling interval} property which defines the interval in between message polls.
* <p/>
* <b>Note</b> that this implementation is not suitable for use with POP3 servers. Use the {@link
*
* <p><b>Note</b> that this implementation is not suitable for use with POP3 servers. Use the {@link
* Pop3PollingMonitoringStrategy} instead.
*
* @author Arjen Poutsma

4
spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/Pop3PollingMonitoringStrategy.java
View File

@@ -28,8 +28,8 @@ import org.springframework.ws.transport.mail.support.MailTransportUtils;
* servers. Since POP3 does not have a native mechanism to determine which messages are "new", this implementation
* simply retrieves all messages in the {@link Folder}, and delete them afterwards. All messages in the POP3 mailbox are
* therefore, by definition, new.
* <p/>
* Setting the {@link #setDeleteMessages(boolean) deleteMessages} property is therefore ignored: messages are always
*
* <p>Setting the {@link #setDeleteMessages(boolean) deleteMessages} property is therefore ignored: messages are always
* deleted.
*
* @author Arjen Poutsma

16
spring-ws-support/src/main/java/org/springframework/ws/transport/mail/support/MailTransportUtils.java
View File

@@ -79,10 +79,10 @@ public abstract class MailTransportUtils {
}
/**
* Close the given JavaMail Service and ignore any thrown exception. This is useful for typical <code>finally</code>
* Close the given JavaMail Service and ignore any thrown exception. This is useful for typical {@code finally}
* blocks in manual JavaMail code.
*
* @param service the JavaMail Service to close (may be <code>null</code>)
* @param service the JavaMail Service to close (may be {@code null})
* @see Transport
* @see Store
*/
@@ -98,10 +98,10 @@ public abstract class MailTransportUtils {
}
/**
* Close the given JavaMail Folder and ignore any thrown exception. This is useful for typical <code>finally</code>
* Close the given JavaMail Folder and ignore any thrown exception. This is useful for typical {@code finally}
* blocks in manual JavaMail code.
*
* @param folder the JavaMail Folder to close (may be <code>null</code>)
* @param folder the JavaMail Folder to close (may be {@code null})
*/
public static void closeFolder(Folder folder) {
@@ -109,10 +109,10 @@ public abstract class MailTransportUtils {
}
/**
* Close the given JavaMail Folder and ignore any thrown exception. This is useful for typical <code>finally</code>
* Close the given JavaMail Folder and ignore any thrown exception. This is useful for typical {@code finally}
* blocks in manual JavaMail code.
*
* @param folder the JavaMail Folder to close (may be <code>null</code>)
* @param folder the JavaMail Folder to close (may be {@code null})
* @param expunge whether all deleted messages should be expunged from the folder
*/
public static void closeFolder(Folder folder, boolean expunge) {
@@ -169,10 +169,10 @@ public abstract class MailTransportUtils {
}
/**
* Converts the given internet address into a <code>mailto</code> URI.
* Converts the given internet address into a {@code mailto} URI.
*
* @param to the To: address
* @param subject the subject, may be <code>null</code>
* @param subject the subject, may be {@code null}
* @return a mailto URI
*/
public static URI toUri(InternetAddress to, String subject) throws URISyntaxException {

8
spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractAsyncStandaloneMessageReceiver.java
View File

@@ -40,8 +40,8 @@ public abstract class AbstractAsyncStandaloneMessageReceiver extends AbstractSta
/**
* Set the Spring {@link TaskExecutor} to use for running the listener threads. Default is {@link
* SimpleAsyncTaskExecutor}, starting up a number of new threads.
* <p/>
* Specify an alternative task executor for integration with an existing thread pool, such as the {@link
*
* <p>Specify an alternative task executor for integration with an existing thread pool, such as the {@link
* org.springframework.scheduling.commonj.WorkManagerTaskExecutor} to integrate with WebSphere or WebLogic.
*/
public void setTaskExecutor(TaskExecutor taskExecutor) {
@@ -63,8 +63,8 @@ public abstract class AbstractAsyncStandaloneMessageReceiver extends AbstractSta
/**
* Create a default TaskExecutor. Called if no explicit TaskExecutor has been specified.
* <p/>
* The default implementation builds a {@link org.springframework.core.task.SimpleAsyncTaskExecutor} with the
*
* <p>The default implementation builds a {@link org.springframework.core.task.SimpleAsyncTaskExecutor} with the
* specified bean name (or the class name, if no bean name specified) as thread name prefix.
*
* @see org.springframework.core.task.SimpleAsyncTaskExecutor#SimpleAsyncTaskExecutor(String)

4
spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractStandaloneMessageReceiver.java
View File

@@ -54,8 +54,8 @@ public abstract class AbstractStandaloneMessageReceiver extends SimpleWebService
/**
* Set whether to automatically start the receiver after initialization.
* <p/>
* Default is <code>true</code>; set this to <code>false</code> to allow for manual startup.
*
* <p>Default is {@code true}; set this to {@code false} to allow for manual startup.
*/
public void setAutoStartup(boolean autoStartup) {
this.autoStartup = autoStartup;

4
spring-ws-support/src/main/java/org/springframework/ws/transport/support/SimpleWebServiceMessageReceiverObjectSupport.java
View File

@@ -34,14 +34,14 @@ public abstract class SimpleWebServiceMessageReceiverObjectSupport extends WebSe
private WebServiceMessageReceiver messageReceiver;
/**
* Returns the <code>WebServiceMessageReceiver</code> used by this listener.
* Returns the {@code WebServiceMessageReceiver} used by this listener.
*/
public WebServiceMessageReceiver getMessageReceiver() {
return messageReceiver;
}
/**
* Sets the <code>WebServiceMessageReceiver</code> used by this listener.
* Sets the {@code WebServiceMessageReceiver} used by this listener.
*/
public void setMessageReceiver(WebServiceMessageReceiver messageReceiver) {
this.messageReceiver = messageReceiver;

6
spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppMessageSender.java
View File

@@ -31,8 +31,8 @@ import org.springframework.ws.transport.xmpp.support.XmppTransportUtils;
/**
* {@link WebServiceMessageSender} implementation that uses XMPP {@link org.jivesoftware.smack.packet.Message}s.
* Requires a {@link #setConnection(org.jivesoftware.smack.XMPPConnection) connection}to be set.
* <p/>
* This message sender supports URI's of the following format: <blockquote> <tt><b>xmpp:</b></tt><i>to</i> </blockquote>
*
* <p>This message sender supports URI's of the following format: <blockquote> <tt><b>xmpp:</b></tt><i>to</i> </blockquote>
* The <i>to</i> represents a Jabber ID.
*
* @author Gildas Cuisinier
@@ -69,7 +69,7 @@ public class XmppMessageSender implements WebServiceMessageSender, InitializingB
/**
* Sets the encoding used to read from {@link org.jivesoftware.smack.packet.Message} object. Defaults to
* <code>UTF-8</code>.
* {@code UTF-8}.
*/
public void setMessageEncoding(String messageEncoding) {
this.messageEncoding = messageEncoding;

4
spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppConnectionFactoryBean.java
View File

@@ -58,8 +58,8 @@ public class XmppConnectionFactoryBean implements FactoryBean<XMPPConnection>, I
/**
* Sets the the server port to connect to.
* <p/>
* Defaults to {@code 5222}.
*
* <p>Defaults to {@code 5222}.
*/
public void setPort(int port) {
Assert.isTrue(port > 0, "'port' must be larger than 0");

2
spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppTransportUtils.java
View File

@@ -38,7 +38,7 @@ public abstract class XmppTransportUtils {
}
/**
* Converts the given XMPP destination into a <code>xmpp</code> URI.
* Converts the given XMPP destination into a {@code xmpp} URI.
*/
public static URI toUri(Message requestMessage) throws URISyntaxException {
return new URI(XmppTransportConstants.XMPP_URI_SCHEME, requestMessage.getTo(), null);