Javadoc typo fix and cleanup

This mostly fixes the url1/url2 copy and paste problem. It uses a bit more readable property syntax and introduces a single sentence (plain text) summary for class Javadoc and adds some links.
This commit is contained in:
Bernd 2017-02-16 21:16:36 +01:00 committed by Hadrian Zbarcea
parent 944b8273c0
commit c64af87ee2
1 changed files with 13 additions and 12 deletions

View File

@ -24,14 +24,15 @@ import javax.naming.Context;
import javax.naming.NamingException; import javax.naming.NamingException;
/** /**
* This implementation of <CODE>InitialContextFactory</CODE> should be used * A InitialContextFactory for WebSphere Generic JMS Provider.
* when ActiveMQ is used as WebSphere Generic JMS Provider. It is proved that it * <p>
* works on WebSphere 5.1. The reason for using this class is that custom * Works on WebSphere 5.1. The reason for using this class is that custom
* property defined for Generic JMS Provider are passed to InitialContextFactory * property defined for Generic JMS Provider are passed to {@link InitialContextFactory}
* only if it begins with java.naming or javax.naming prefix. Additionally * only if it begins with {@code java.naming} or {@code javax.naming} prefix.
* provider url for the JMS provider can not contain ',' character that is * Additionally provider url for the JMS provider can not contain {@code ','}
* necessary when the list of nodes is provided. So the role of this class is to * character that is necessary when the list of nodes is provided. So the role
* transform properties before passing it to <tt>ActiveMQInitialContextFactory</tt>. * of this class is to transform properties before passing it to
* {@link ActiveMQInitialContextFactory}.
*/ */
public class ActiveMQWASInitialContextFactory extends ActiveMQInitialContextFactory { public class ActiveMQWASInitialContextFactory extends ActiveMQInitialContextFactory {
@ -45,10 +46,10 @@ public class ActiveMQWASInitialContextFactory extends ActiveMQInitialContextFact
/** /**
* Performs following transformation of properties: * Performs following transformation of properties:
* <ul> * <ul>
* <li>(java.naming.queue.xxx.yyy,value)=>(queue.xxx/yyy,value) * <li>(java.naming.queue.xxx.yyy=value) ->(queue.xxx/yyy=value)
* <li>(java.naming.topic.xxx.yyy,value)=>(topic.xxx/yyy,value) * <li>(java.naming.topic.xxx.yyy=value) -> (topic.xxx/yyy=value)
* <li>(java.naming.connectionFactoryNames,value)=>(connectionFactoryNames,value) * <li>(java.naming.connectionxxx=value) -> (connectionxxx=value)
* <li>(java.naming.provider.url,url1;url2)=>java.naming.provider.url,url1,url1) * <li>(java.naming.provider.url=url1;url2) -> (java.naming.provider.url=url1,url2)
* <ul> * <ul>
* *
* @param environment properties for transformation * @param environment properties for transformation