svn commit: r923569 - in /synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators: AndEvaluator.java EqualEvaluator.java EvaluatorConstants.java MatchEvaluator.java NotEvaluator.java OrEvaluator.java Parser.java

[su...@apache.org]

Author: supun
Date: Tue Mar 16 03:39:19 2010
New Revision: 923569

URL: http://svn.apache.org/viewvc?rev=923569&view=rev
Log:
improving java docs

Modified:
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorConstants.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Parser.java

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java?rev=923569&r1=923568&r2=923569&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java Tue Mar 16 03:39:19 2010
@@ -22,11 +22,11 @@ package org.apache.synapse.commons.evalu
 /**
  * This encapsulates two or more boolean conditions. This acts as the "and"
  * boolean operator.   
- *
- * Syntax:
- * <and>
+ * <pre>
+ * &lt;and&gt;
  *     two or more evaluators
- * <and>
+ * &lt;and&gt;
+ * </pre>
  */
 public class AndEvaluator implements Evaluator {
     private Evaluator[] evaluators;

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java?rev=923569&r1=923568&r2=923569&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java Tue Mar 16 03:39:19 2010
@@ -26,11 +26,10 @@ import java.io.UnsupportedEncodingExcept
 
 /**
  * Try to see weather a part of the HTTP request is equal to the value provided.
- *
- * If the values are equal retun true 
- *
- * Syntax:
- * <equal type="header | param | url" source="" value=""/>
+ * If the values are equal retun true
+ * <pre>
+ * &lt;equal type=&quot;header | param | url&quot; source=&quot;&quot; value=&quot;&quot;/&gt;
+ * </pre>
  */
 public class EqualEvaluator implements Evaluator {
     private Log log = LogFactory.getLog(EqualEvaluator.class);

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorConstants.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorConstants.java?rev=923569&r1=923568&r2=923569&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorConstants.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorConstants.java Tue Mar 16 03:39:19 2010
@@ -23,20 +23,22 @@ package org.apache.synapse.commons.evalu
  * Constants used through out the evaluators
  */
 public class EvaluatorConstants {
-    public static final String PRIORITY = "priority";    
-    public static final String VALUE = "value";
     public static final String AND = "and";
     public static final String OR = "or";
     public static final String NOT = "not";
     public static final String MATCH = "match";
     public static final String EQUAL = "equal";
+
     public static final String TYPE = "type";
     public static final String HEADER = "header";
     public static final String PARAM = "param";
     public static final String URL = "url";
     public static final String SOURCE = "source";
     public static final String REGEX = "regex";
+    public static final String VALUE = "value";
+
+    public static final String CONDITIONS = "conditions";
     public static final String CONDITION = "condition";
+    public static final String PRIORITY = "priority";
     public static final String DEFAULT_PRIORITY = "defaultPriority";
-    public static final String CONDITIONS = "conditions";
 }

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java?rev=923569&r1=923568&r2=923569&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java Tue Mar 16 03:39:19 2010
@@ -29,8 +29,9 @@ import java.io.UnsupportedEncodingExcept
 /**
  * This evaluator uses regular expressions to match a given HTTP request.
  *
- * syntax:
- * <match type="header | param | url" source="" regex=""/>
+ * <pre>
+ * &lt;match type=&quot;header | param | url&quot; source=&quot;&quot; regex=&quot;&quot;/&gt;
+ * </pre>
  *
  * The source is used to extract the HTTP header or URL param
  */

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java?rev=923569&r1=923568&r2=923569&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java Tue Mar 16 03:39:19 2010
@@ -22,10 +22,11 @@ package org.apache.synapse.commons.evalu
 /**
  * This encapsulates boolean condition. This acts as not boolean operator.   
  *
- * Syntax:
- * <not>
+ * <pre>
+ * &lt;not&gt;
  *     one evaluator
- * </not>
+ * &lt;/not&gt;
+ * </pre>
  */
 public class NotEvaluator implements Evaluator {
     private Evaluator evaluator;

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java?rev=923569&r1=923568&r2=923569&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java Tue Mar 16 03:39:19 2010
@@ -23,10 +23,11 @@ package org.apache.synapse.commons.evalu
  * This encapsulates two or more boolean conditions. This acts as the "or"
  * boolean operator.
  *
- * Syntax:
- * <or>
+ * <pre>
+ * &lt;or&gt;
  *     two or more evaluators
- * </or>
+ * &lt;/or&gt;
+ * </pre>
  */
 public class OrEvaluator implements Evaluator {
     private Evaluator[] evaluators;

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Parser.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Parser.java?rev=923569&r1=923568&r2=923569&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Parser.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Parser.java Tue Mar 16 03:39:19 2010
@@ -29,18 +29,19 @@ import java.util.List;
 import java.util.ArrayList;
 
 /**
- * This class is used to parse a Given HTTP request against a set of rules.
- *
+ * This class is used to parse a Given HTTP request against a set of rules.</p>
+ * <p>
  * A Rule has a priority. If a HTTP request matches the Rule, parser returns
- * the priority corresponding to that rule.
- *
- * Here is the syntax of the configuration used to building the parser
- *
- * <conditions [defualtPriority = "int"]>
- *     <condition priority = "">
- *        <and/> | <or> | <not> | <match> | <equal>
- *     </condition>
- * </conditions>
+ * the priority corresponding to that rule.</p>
+ * <p>
+ * Here is the syntax of the configuration used to building the parser</p>
+ * <pre>
+ * &lt;conditions [defualtPriority = &quot;int&quot;]&gt;
+ *     &lt;condition priority = &quot;&quot;&gt;
+ *        &lt;and/&gt; | &lt;or&gt; | &lt;not&gt; | &lt;match&gt; | &lt;equal&gt;
+ *     &lt;/condition&gt;
+ * &lt;/conditions&gt;
+ * </pre>
  */
 public class Parser {
     private Log log = LogFactory.getLog(Parser.class);