svn commit: r943069 - /synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/

[su...@apache.org]

Author: supun
Date: Tue May 11 09:56:23 2010
New Revision: 943069

URL: http://svn.apache.org/viewvc?rev=943069&view=rev
Log:
improving the doc comments

Modified:
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AbstractEvaluatorSerializer.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndSerializer.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionSerializer.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualSerializer.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializer.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializerFinder.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchSerializer.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotSerializer.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrSerializer.java

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AbstractEvaluatorSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AbstractEvaluatorSerializer.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AbstractEvaluatorSerializer.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AbstractEvaluatorSerializer.java Tue May 11 09:56:23 2010
@@ -10,7 +10,7 @@ import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 /**
- * Provide common methods for serializers
+ * Provide common methods for {@link EvaluatorSerializer} implementations
  */
 public abstract class AbstractEvaluatorSerializer implements EvaluatorSerializer {
     protected static Log log;

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java Tue May 11 09:56:23 2010
@@ -31,8 +31,8 @@ import java.util.List;
 import java.util.ArrayList;
 
 /**
- * <p>This factory creates a <code>AndEvaluator</code>. This factory expects the
- * following XML configuration to create the AndEvaluator.</p>
+ * <p>This factory creates a {@link AndEvaluator}. This factory expects the
+ * following XML configuration.</p>
  * <pre>
  * &lt;and&gt;
  *     two or more evaluators

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndSerializer.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndSerializer.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndSerializer.java Tue May 11 09:56:23 2010
@@ -27,6 +27,10 @@ import org.apache.synapse.commons.evalua
 
 import javax.xml.namespace.QName;
 
+/**
+ * Serialize the {@link AndEvaluator} to the XML configuration defined in
+ * the {@link AndFactory}. 
+ */
 public class AndSerializer extends AbstractEvaluatorSerializer {    
     public OMElement serialize(OMElement parent, Evaluator evaluator) throws EvaluatorException {        
         if (!(evaluator instanceof AndEvaluator)) {           

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java Tue May 11 09:56:23 2010
@@ -31,7 +31,7 @@ import org.apache.commons.logging.Log;
 import javax.xml.namespace.QName;
 
 /**
- * This factory creates a <code>Condition</code> using the following XML configuration.</p>
+ * This factory creates a {@link Condition} using the following XML configuration.</p>
  * <pre>
  * &lt;condition priority=&quot;priority value as an integer&quot;&gt;
  *           one evaluator, this evaluator can contain other evaluators

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionSerializer.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionSerializer.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionSerializer.java Tue May 11 09:56:23 2010
@@ -31,6 +31,10 @@ import org.apache.synapse.commons.evalua
 
 import javax.xml.namespace.QName;
 
+/**
+ * Serialize the {@link Condition} to the XML configuration defined in
+ * the {@link ConditionFactory}. 
+ */
 public class ConditionSerializer {
     private static Log log = LogFactory.getLog(ConditionSerializer.class);
 

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java Tue May 11 09:56:23 2010
@@ -31,7 +31,7 @@ import org.apache.commons.logging.LogFac
 import javax.xml.namespace.QName;
 
 /**
- * <p> This factory creates a <code>EqualEvaluator</code>. This factory expects the
+ * <p> This factory creates a {@link EqualEvaluator}. This factory expects the
  * following XML configuration.</p>
  * <pre>
  * &lt;equal type=&quot;header | param | url&quot; source=&quot;&quot; value=&quot;&quot;/&gt;

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualSerializer.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualSerializer.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualSerializer.java Tue May 11 09:56:23 2010
@@ -24,6 +24,10 @@ import org.apache.synapse.commons.evalua
 
 import javax.xml.namespace.QName;
 
+/**
+ * Serialize the {@link EqualEvaluator} to the XML configuration defined in
+ * the {@link EqualFactory}. 
+ */
 public class EqualSerializer extends AbstractEvaluatorSerializer{
     public OMElement serialize(OMElement parent, Evaluator evaluator) throws EvaluatorException {
         if (!(evaluator instanceof EqualEvaluator)) {

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java Tue May 11 09:56:23 2010
@@ -30,9 +30,8 @@ import java.util.Map;
 import java.util.HashMap;
 
 /**
- * Factories for Evaluators are found using the evaluator name. This class stores
- * information about Evaluator Factories and their corresponding names. This class
- * is a Singleton class.
+ * Factories for creating Evaluators are found using the evaluator name. This class stores
+ * information about Evaluator Factories and their corresponding names. This is a Singleton class.
  */
 public class EvaluatorFactoryFinder {
     private static final Log log = LogFactory.getLog(EvaluatorFactoryFinder.class);

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializer.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializer.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializer.java Tue May 11 09:56:23 2010
@@ -23,6 +23,10 @@ import org.apache.axiom.om.OMElement;
 import org.apache.synapse.commons.evaluators.Evaluator;
 import org.apache.synapse.commons.evaluators.EvaluatorException;
 
+/**
+ * This interface should be implemented by the classes to serialize the {@link Evaluator}
+ * object model in to XML configuration.
+ */
 public interface EvaluatorSerializer {
 
     /**

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializerFinder.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializerFinder.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializerFinder.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorSerializerFinder.java Tue May 11 09:56:23 2010
@@ -22,6 +22,11 @@ package org.apache.synapse.commons.evalu
 import java.util.Map;
 import java.util.HashMap;
 
+/**
+ * {@link EvaluatorSerializer}s for serializing Evaluators are found using the evaluator name.
+ * This class stores information about Evaluator Serializers and their corresponding names. This
+ * is a Singleton.
+ */
 public class EvaluatorSerializerFinder {
     private static final EvaluatorSerializerFinder finder = new EvaluatorSerializerFinder();
 

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java Tue May 11 09:56:23 2010
@@ -33,7 +33,7 @@ import javax.xml.namespace.QName;
 import java.util.regex.Pattern;
 
 /**
- * This Factory creates a <code>MatchEvaluator</code> using the following XML configuration.</p>
+ * This Factory creates a {@link MatchEvaluator} using the following XML configuration.</p>
  *
  * <pre>
  * &lt;match type=&quot;header | param | url&quot; source=&quot;&quot; regex=&quot;&quot;/&gt;

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchSerializer.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchSerializer.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchSerializer.java Tue May 11 09:56:23 2010
@@ -8,6 +8,10 @@ import org.apache.synapse.commons.evalua
 
 import javax.xml.namespace.QName;
 
+/**
+ * Serialize the {@link MatchEvaluator} to the XML configuration defined in
+ * the {@link MatchFactory}. 
+ */
 public class MatchSerializer extends AbstractEvaluatorSerializer {
 
     public OMElement serialize(OMElement parent, Evaluator evaluator) throws EvaluatorException {

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java Tue May 11 09:56:23 2010
@@ -28,7 +28,7 @@ import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 /**
- * This Factory creates a <code>NotEvaluator</code> from the following XML configuration.</p>   
+ * This Factory creates a {@link NotEvaluator} from the following XML configuration.</p>   
  *
  * <pre>
  * &lt;not&gt;

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotSerializer.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotSerializer.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotSerializer.java Tue May 11 09:56:23 2010
@@ -27,6 +27,10 @@ import org.apache.synapse.commons.evalua
 
 import javax.xml.namespace.QName;
 
+/**
+ * Serialize the {@link NotEvaluator} to the XML configuration defined in
+ * the {@link NotFactory}. 
+ */
 public class NotSerializer extends AbstractEvaluatorSerializer {
 
     public OMElement serialize(OMElement parent, Evaluator evaluator) throws EvaluatorException {

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java Tue May 11 09:56:23 2010
@@ -32,7 +32,7 @@ import java.util.List;
 import java.util.ArrayList;
 
 /**
- * This factory creates a <code>OrFactory</code> using the following XML configuration.</p>
+ * This factory creates a {@link OrFactory} using the following XML configuration.</p>
  *
  * <pre>
  * &lt;or&gt;

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrSerializer.java?rev=943069&r1=943068&r2=943069&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrSerializer.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrSerializer.java Tue May 11 09:56:23 2010
@@ -27,6 +27,10 @@ import org.apache.synapse.commons.evalua
 
 import javax.xml.namespace.QName;
 
+/**
+ * Serialize the {@link OrEvaluator} to the XML configuration defined in
+ * the {@link OrFactory}. 
+ */
 public class OrSerializer extends AbstractEvaluatorSerializer {
     public OMElement serialize(OMElement parent, Evaluator evaluator) throws EvaluatorException {
         if (!(evaluator instanceof OrEvaluator)) {