You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@synapse.apache.org by as...@apache.org on 2006/05/23 12:46:19 UTC
svn commit: r408867 - in /incubator/synapse/trunk/java: ./ modules/core/src/org/apache/synapse/config/xml/

Author: asankha
Date: Tue May 23 03:46:18 2006
New Revision: 408867

URL: http://svn.apache.org/viewvc?rev=408867&view=rev
Log:
Fix Javadoc warnings

Modified:
    incubator/synapse/trunk/java/maven.xml
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/ClassMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/DropMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FaultMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FilterMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/HeaderMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/InMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/LogMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/MediatorPropertyFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/OutMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/PropertyMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SendMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SequenceMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SwitchMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SynapseMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/TransformMediatorFactory.java
    incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/XMLConfigurationBuilder.java

Modified: incubator/synapse/trunk/java/maven.xml
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/maven.xml?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/maven.xml (original)
+++ incubator/synapse/trunk/java/maven.xml Tue May 23 03:46:18 2006
@@ -413,7 +413,8 @@
                      author="true"
                      version="true"
                      use="true"
-                     windowtitle="Synapse API">
+                     windowtitle="Synapse API"
+                     additionalparam="-breakiterator">
             <ant:sourcepath>
                 <ant:pathelement location="modules/core/src"/>
                 <!--<ant:pathelement location="modules/mediators/src"/>-->

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/ClassMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/ClassMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/ClassMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/ClassMediatorFactory.java Tue May 23 03:46:18 2006
@@ -31,9 +31,11 @@
 /**
  * Creates an instance of a Class mediator using XML configuration specified
  *
- * <class name="class-name">
- *   <property name="string" (value="literal" | expression="xpath")/>*
- * </class>
+ * <pre>
+ * &lt;class name="class-name"&gt;
+ *   &lt;property name="string" (value="literal" | expression="xpath")/&gt;*
+ * &lt;/class&gt;
+ * </pre>
  */
 public class ClassMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/DropMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/DropMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/DropMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/DropMediatorFactory.java Tue May 23 03:46:18 2006
@@ -26,7 +26,9 @@
 /**
  * This creates a drop mediator instance
  *
- * <drop/>
+ * <pre>
+ * &lt;drop/&gt;
+ * </pre>
  */
 public class DropMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FaultMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FaultMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FaultMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FaultMediatorFactory.java Tue May 23 03:46:18 2006
@@ -35,13 +35,15 @@
 /**
  * Creates a fault mediator instance
  *
- * <makefault [version="soap11|soap12"]>
- *   <code (value="literal" | expression="xpath")/>
- *   <reason (value="literal" | expression="xpath")>
- *   <node>?
- *   <role>?
- *   <detail>?
- * </makefault>
+ * <pre>
+ * &lt;makefault [version="soap11|soap12"]&gt;
+ *   &lt;code (value="literal" | expression="xpath")/&gt;
+ *   &lt;reason (value="literal" | expression="xpath")&gt;
+ *   &lt;node&gt;?
+ *   &lt;role&gt;?
+ *   &lt;detail&gt;?
+ * &lt;/makefault&gt;
+ * </pre>
  */
 public class FaultMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FilterMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FilterMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FilterMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/FilterMediatorFactory.java Tue May 23 03:46:18 2006
@@ -35,9 +35,11 @@
 /**
  * Creates a filter mediator instance
  *
- * <filter (source="xpath" regex="string") | xpath="xpath">
+ * <pre>
+ * &lt;filter (source="xpath" regex="string") | xpath="xpath"&gt;
  *   mediator+
- * </filter>
+ * &lt;/filter&gt;
+ * </pre>
  */
 public class FilterMediatorFactory extends AbstractListMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/HeaderMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/HeaderMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/HeaderMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/HeaderMediatorFactory.java Tue May 23 03:46:18 2006
@@ -33,10 +33,14 @@
  * This builds a Header Mediator parsing the XML configuration supplied
  *
  * Set header
- *   <header name="qname" (value="literal" | expression="xpath")/>
+ *   <pre>
+ *      &lt;header name="qname" (value="literal" | expression="xpath")/&gt;
+ *   </pre>
  *
  * Remove header
- *   <header name="qname" action="remove"/>
+ *   <pre>
+ *      &lt;header name="qname" action="remove"/&gt;
+ *   </pre>
  */
 public class HeaderMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/InMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/InMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/InMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/InMediatorFactory.java Tue May 23 03:46:18 2006
@@ -24,9 +24,11 @@
 /**
  * Creates an In mediator instance
  *
- * <in>
+ * <pre>
+ * &lt;in&gt;
  *    mediator+
- * </in>
+ * &lt;/in&gt;
+ * </pre>
  */
 public class InMediatorFactory extends AbstractListMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/LogMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/LogMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/LogMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/LogMediatorFactory.java Tue May 23 03:46:18 2006
@@ -35,9 +35,11 @@
 /**
  * Created a Log mediator that logs messages using commons-logging.
  *
- * <log [level="simple|headers|full|custom"]>
- *      <property> *
- * </log>
+ * <pre>
+ * &lt;log [level="simple|headers|full|custom"]&gt;
+ *      &lt;property&gt; *
+ * &lt;/log&gt;
+ * </pre>
  */
 public class LogMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/MediatorPropertyFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/MediatorPropertyFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/MediatorPropertyFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/MediatorPropertyFactory.java Tue May 23 03:46:18 2006
@@ -34,9 +34,11 @@
  * A utility class capable of creating instances of MediatorProperty objects by reading
  * through a given XML configuration
  *
- * <element>
- *    <property name="string" (value="literal" | expression="xpath")/>*
- * </element>
+ * <pre>
+ * &lt;element&gt;
+ *    &lt;property name="string" (value="literal" | expression="xpath")/&gt;*
+ * &lt;/element&gt;
+ * </pre>
  */
 public class MediatorPropertyFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/OutMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/OutMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/OutMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/OutMediatorFactory.java Tue May 23 03:46:18 2006
@@ -24,9 +24,11 @@
 /**
  * Creates an Out mediator instance
  *
- * <out>
+ * <pre>
+ * &lt;out&gt;
  *    mediator+
- * </out>
+ * &lt;/out&gt;
+ * </pre>
  */
 public class OutMediatorFactory extends AbstractListMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/PropertyMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/PropertyMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/PropertyMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/PropertyMediatorFactory.java Tue May 23 03:46:18 2006
@@ -31,7 +31,9 @@
 /**
  * Creates a set-property mediator through the supplied XML configuration
  *
- * <set-property name="string" (value="literal" | expression="xpath")/>
+ * <pre>
+ * &lt;set-property name="string" (value="literal" | expression="xpath")/&gt;
+ * </pre>
  */
 public class PropertyMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SendMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SendMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SendMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SendMediatorFactory.java Tue May 23 03:46:18 2006
@@ -37,32 +37,44 @@
  *
  * //TODO support endpoints, failover and loadbalacing
  *
- * The <send> element is used to send messages out of Synapse to some endpoint. In the simplest case,
+ * The &lt;send&gt; element is used to send messages out of Synapse to some endpoint. In the simplest case,
  * the place to send the message to is implicit in the message (via a property of the message itself)-
  * that is indicated by the following
- *  <send/>
+ * <pre>
+ *  &lt;send/&gt;
+ * </pre>
  *
  * If the message is to be sent to one or more endpoints, then the following is used:
- *  <send>
+ * <pre>
+ *  &lt;send&gt;
  *   (endpointref | endpoint)+
- *  </send>
+ *  &lt;/send&gt;
+ * </pre>
  * where the endpointref token refers to the following:
- * <endpoint ref="name"/>
+ * <pre>
+ * &lt;endpoint ref="name"/&gt;
+ * </pre>
  * and the endpoint token refers to an anonymous endpoint defined inline:
- *  <endpoint address="url"/>
+ * <pre>
+ *  &lt;endpoint address="url"/&gt;
+ * </pre>
  * If the message is to be sent to an endpoint selected by load balancing across a set of endpoints,
  * then it is indicated by the following:
- * <send>
- *   <load-balance algorithm="uri">
+ * <pre>
+ * &lt;send&gt;
+ *   &lt;load-balance algorithm="uri"&gt;
  *     (endpointref | endpoint)+
- *   </load-balance>
- * </send>
+ *   &lt;/load-balance&gt;
+ * &lt;/send&gt;
+ * </pre>
  * Similarly, if the message is to be sent to an endpoint with failover semantics, then it is indicated by the following:
- * <send>
- *   <failover>
+ * <pre>
+ * &lt;send&gt;
+ *   &lt;failover&gt;
  *     (endpointref | endpoint)+
- *   </failover>
- * </send>
+ *   &lt;/failover&gt;
+ * &lt;/send&gt;
+ * </pre>
  */
 public class SendMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SequenceMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SequenceMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SequenceMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SequenceMediatorFactory.java Tue May 23 03:46:18 2006
@@ -28,13 +28,17 @@
 /**
  * Builds an instance of a Sequence mediator through the Synapse configuration. It follows the following
  *
- * <sequence name="string">
+ * <pre>
+ * &lt;sequence name="string"&gt;
  *   mediator+
- * </sequence>
+ * &lt;/sequence&gt;
+ * </pre>
  *
  * OR
  *
- * <sequence ref="name"/>
+ * <pre>
+ * &lt;sequence ref="name"/&gt;
+ * </pre>
  */
 public class SequenceMediatorFactory extends AbstractListMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SwitchMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SwitchMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SwitchMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SwitchMediatorFactory.java Tue May 23 03:46:18 2006
@@ -33,14 +33,16 @@
 /**
  * Constructs a Switch mediator instance from the given XML configuration
  *
- * <switch source="xpath">
- *   <case regex="string">
+ * <pre>
+ * &lt;switch source="xpath"&gt;
+ *   &lt;case regex="string"&gt;
  *     mediator+
- *   </case>+
- *   <default>
+ *   &lt;/case&gt;+
+ *   &lt;default&gt;
  *     mediator+
- *   </default>?
- * </switch>
+ *   &lt;/default&gt;?
+ * &lt;/switch&gt;
+ * </pre>
  */
 public class SwitchMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SynapseMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SynapseMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SynapseMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/SynapseMediatorFactory.java Tue May 23 03:46:18 2006
@@ -26,9 +26,11 @@
 /**
  * Builds the main mediator (@see SynapseConfiguration) of the Synapse instance
  *
- * <rules>
+ * <pre>
+ * &lt;rules&gt;
  *   mediator+
- * <rules>
+ * &lt;rules&gt;
+ * </pre>
  */
 public class SynapseMediatorFactory extends AbstractListMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/TransformMediatorFactory.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/TransformMediatorFactory.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/TransformMediatorFactory.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/TransformMediatorFactory.java Tue May 23 03:46:18 2006
@@ -33,9 +33,11 @@
 /**
  * Creates a transform mediator from the given XML
  *
- * <transform xslt|xquery="url" [source="xpath"]>
- *   <property name="string" (value="literal" | expression="xpath")/>*
- * </transform>
+ * <pre>
+ * &lt;transform xslt|xquery="url" [source="xpath"]&gt;
+ *   &lt;property name="string" (value="literal" | expression="xpath")/&gt;*
+ * &lt;/transform&gt;
+ * </pre>
  */
 public class TransformMediatorFactory extends AbstractMediatorFactory {
 

Modified: incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/XMLConfigurationBuilder.java
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/XMLConfigurationBuilder.java?rev=408867&r1=408866&r2=408867&view=diff
==============================================================================
--- incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/XMLConfigurationBuilder.java (original)
+++ incubator/synapse/trunk/java/modules/core/src/org/apache/synapse/config/xml/XMLConfigurationBuilder.java Tue May 23 03:46:18 2006
@@ -100,7 +100,9 @@
     }
 
     /**
-     * <set-property name="string" value="string"/>
+     * <pre>
+     * &lt;set-property name="string" value="string"/&gt;
+     * </pre>
      * @param elem
      */
     private void defineProperty(SynapseConfiguration config, OMElement elem) {
@@ -113,9 +115,11 @@
     }
 
     /**
-     * <sequence name="string>
+     * <pre>
+     * &lt;sequence name="string&gt;
      *    Mediator+
-     * </sequence>
+     * &lt;/sequence&gt;
+     * </pre>
      * @param ele
      */
     private void defineSequence(SynapseConfiguration config, OMElement ele) {
@@ -126,10 +130,12 @@
     /**
      * Create an endpoint definition digesting an XML fragment
      *
-     * <endpoint name="string" [address="url"]>
+     * <pre>
+     * &lt;endpoint name="string" [address="url"]&gt;
      *    .. extensibility ..
-     * </endpoint>
-     * @param ele the <endpoint> element
+     * &lt;/endpoint&gt;
+     * </pre>
+     * @param ele the &lt;endpoint&gt; element
      */
     private void defineEndpoint(SynapseConfiguration config, OMElement ele) {
 
@@ -161,7 +167,9 @@
      * the key.
      *
      * e.g. The Spring configuration extension is as follows
-     * <configuration name="string" src="string"/>
+     * <pre>
+     * &lt;configuration name="string" src="string"/&gt;
+     * </pre>
      *
      * @param elem the XML element defining the configuration
      */



---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org