Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 68EAC1743E for ; Thu, 4 Jun 2015 12:38:54 +0000 (UTC) Received: (qmail 46001 invoked by uid 500); 4 Jun 2015 12:38:54 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 45926 invoked by uid 500); 4 Jun 2015 12:38:54 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 45917 invoked by uid 99); 4 Jun 2015 12:38:54 -0000 Received: from eris.apache.org (HELO hades.apache.org) (140.211.11.105) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 04 Jun 2015 12:38:54 +0000 Received: from hades.apache.org (localhost [127.0.0.1]) by hades.apache.org (ASF Mail Server at hades.apache.org) with ESMTP id 1ED62AC006E for ; Thu, 4 Jun 2015 12:38:54 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1683534 - in /commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2: ./ internal/ internal/introspection/ introspection/ parser/ scripting/ Date: Thu, 04 Jun 2015 12:38:53 -0000 To: commits@commons.apache.org From: sebb@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20150604123854.1ED62AC006E@hades.apache.org> Author: sebb Date: Thu Jun 4 12:38:53 2015 New Revision: 1683534 URL: http://svn.apache.org/r1683534 Log: JEXL-153 - Javadoc 8 fixes Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/ExpressionImpl.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlArithmetic.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlEngine.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/UnifiedJEXL.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/Introspector.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/IntrospectorBase.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/MethodKey.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/introspection/Sandbox.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/parser/Parser.jjt commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngine.java commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngineFactory.java Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/ExpressionImpl.java URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/ExpressionImpl.java?rev=1683534&r1=1683533&r2=1683534&view=diff ============================================================================== --- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/ExpressionImpl.java (original) +++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/ExpressionImpl.java Thu Jun 4 12:38:53 2015 @@ -32,7 +32,7 @@ public class ExpressionImpl implements E /** The engine for this expression. */ protected final JexlEngine jexl; /** - * Original expression stripped from leading & trailing spaces. + * Original expression stripped from leading & trailing spaces. */ protected final String expression; /** @@ -171,4 +171,4 @@ public class ExpressionImpl implements E }; } -} \ No newline at end of file +} Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlArithmetic.java URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlArithmetic.java?rev=1683534&r1=1683533&r2=1683534&view=diff ============================================================================== --- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlArithmetic.java (original) +++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlArithmetic.java Thu Jun 4 12:38:53 2015 @@ -26,6 +26,7 @@ import java.math.MathContext; * Perform arithmetic. *

* All arithmetic operators (+, - , *, /, %) follow the same rules regarding their arguments. + *

*
    *
  1. If both are null, result is 0
    2. *
  2. If either is a BigDecimal, coerce both to BigDecimal and and perform operation
    3. @@ -39,7 +40,6 @@ import java.math.MathContext; *
* * - *

* Note that the only exception throw by JexlArithmetic is ArithmeticException. * @since 2.0 */ @@ -713,7 +713,7 @@ public class JexlArithmetic { * Performs a bitwise and. * @param left the left operand * @param right the right operator - * @return left & right + * @return left & right */ public Object bitwiseAnd(Object left, Object right) { long l = toLong(left); @@ -760,7 +760,7 @@ public class JexlArithmetic { * @param left the left operand * @param right the right operator * @param operator the operator - * @return -1 if left < right; +1 if left > > right; 0 if left == right + * @return -1 if left < right; +1 if left > right; 0 if left == right * @throws ArithmeticException if either left or right is null */ protected int compare(Object left, Object right, String operator) { @@ -870,7 +870,7 @@ public class JexlArithmetic { } /** - * Test if left <= right. + * Test if left ≤ right. * * @param left first value * @param right second value @@ -1140,4 +1140,4 @@ public class JexlArithmetic { } } -} \ No newline at end of file +} Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlEngine.java URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlEngine.java?rev=1683534&r1=1683533&r2=1683534&view=diff ============================================================================== --- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlEngine.java (original) +++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/JexlEngine.java Thu Jun 4 12:38:53 2015 @@ -53,14 +53,14 @@ import org.apache.commons.jexl2.parser.A /** *

* Creates and evaluates Expression and Script objects. - * Determines the behavior of Expressions & Scripts during their evaluation with respect to: + * Determines the behavior of Expressions & Scripts during their evaluation with respect to: + *

*
    *
  • Introspection, see {@link Uberspect}
    • - *
  • Arithmetic & comparison, see {@link JexlArithmetic}
    • + *
  • Arithmetic & comparison, see {@link JexlArithmetic}
    • *
  • Error reporting
    • *
  • Logging
    • *
- *

*

The setSilent and setLenient methods allow to fine-tune an engine instance behavior * according to various error control needs. The lenient/strict flag tells the engine when and if null as operand is * considered an error, the silent/verbose flag tells the engine what to do with the error @@ -68,7 +68,7 @@ import org.apache.commons.jexl2.parser.A *

*
    *
  • When "silent" & "lenient": - *

    0 & null should be indicators of "default" values so that even in an case of error, + *

    0 & null should be indicators of "default" values so that even in an case of error, * something meaningfull can still be inferred; may be convenient for configurations. *

    *
    • @@ -84,7 +84,7 @@ import org.apache.commons.jexl2.parser.A * *
  • When "verbose" & "strict": *

    The finest error control grain is obtained; it is the closest to Java code - - * still augmented by "script" capabilities regarding automated conversions & type matching. + * still augmented by "script" capabilities regarding automated conversions & type matching. *

    *
    • *
@@ -878,7 +878,7 @@ public class JexlEngine { * Creates a cache. * @param the key type * @param the value type - * @param cacheSize the cache size, must be > 0 + * @param cacheSize the cache size, must be > 0 * @return a Map usable as a cache bounded to the given size */ protected Map createCache(final int cacheSize) { @@ -1335,7 +1335,7 @@ public class JexlEngine { } /** - * Trims the expression from front & ending spaces. + * Trims the expression from front & ending spaces. * @param str expression to clean * @return trimmed expression ending in a semi-colon */ Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/UnifiedJEXL.java URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/UnifiedJEXL.java?rev=1683534&r1=1683533&r2=1683534&view=diff ============================================================================== --- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/UnifiedJEXL.java (original) +++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/UnifiedJEXL.java Thu Jun 4 12:38:53 2015 @@ -38,21 +38,21 @@ import org.apache.commons.jexl2.parser.S * and facilitate the implementation of expression evaluation. *

* An expression can mix immediate, deferred and nested sub-expressions as well as string constants; + *

*
    *
  • The "immediate" syntax is of the form "...${jexl-expr}..."
    • *
  • The "deferred" syntax is of the form "...#{jexl-expr}..."
    • *
  • The "nested" syntax is of the form "...#{...${jexl-expr0}...}..."
    • *
  • The "composite" syntax is of the form "...${jexl-expr0}... #{jexl-expr1}..."
    • *
- *

*

- * Deferred & immediate expression carry different intentions: + * Deferred & immediate expression carry different intentions: + *

*
    *
  • An immediate expression indicate that evaluation is intended to be performed close to * the definition/parsing point.
    • *
  • A deferred expression indicate that evaluation is intended to occur at a later stage.
    • *
- *

*

* For instance: "Hello ${name}, now is #{time}" is a composite "deferred" expression since one * of its subexpressions is deferred. Furthermore, this (composite) expression intent is @@ -62,14 +62,14 @@ import org.apache.commons.jexl2.parser.S *

* The API reflects this feature in 2 methods, prepare and evaluate. The prepare method * will evaluate the immediate subexpression and return an expression that contains only - * the deferred subexpressions (& constants), a prepared expression. Such a prepared expression + * the deferred subexpressions (& constants), a prepared expression. Such a prepared expression * is suitable for a later phase evaluation that may occur with a different JexlContext. * Note that it is valid to call evaluate without prepare in which case the same JexlContext * is used for the 2 evaluation phases. *

*

* In the most common use-case where deferred expressions are to be kept around as properties of objects, - * one should parse & prepare an expression before storing it and evaluate it each time + * one should parse & prepare an expression before storing it and evaluate it each time * the property storing it is accessed. *

*

@@ -339,7 +339,7 @@ public final class UnifiedJEXL { *

* In effect, this binds the result of the immediate sub-expressions evaluation in the * context, allowing to differ evaluation of the remaining (deferred) expression within another context. - * This only has an effect to nested & composite expressions that contain differed & immediate sub-expressions. + * This only has an effect to nested & composite expressions that contain differed & immediate sub-expressions. *

*

* If the underlying JEXL engine is silent, errors will be logged through its logger as warning. @@ -409,7 +409,7 @@ public final class UnifiedJEXL { * Prepares a sub-expression for interpretation. * @param interpreter a JEXL interpreter * @return a prepared expression - * @throws JexlException (only for nested & composite) + * @throws JexlException (only for nested & composite) */ protected Expression prepare(Interpreter interpreter) { return this; @@ -419,7 +419,7 @@ public final class UnifiedJEXL { * Intreprets a sub-expression. * @param interpreter a JEXL interpreter * @return the result of interpretation - * @throws JexlException (only for nested & composite) + * @throws JexlException (only for nested & composite) */ protected abstract Object evaluate(Interpreter interpreter); } @@ -734,7 +734,7 @@ public final class UnifiedJEXL { } /** Creates a a {@link UnifiedJEXL.Expression} from an expression string. - * Uses & fills up the expression cache if any. + * Uses & fills up the expression cache if any. *

* If the underlying JEXL engine is silent, errors will be logged through its logger as warnings. *

@@ -1010,20 +1010,23 @@ public final class UnifiedJEXL { * evaluation and their output gathered through a writer. * It is thus possible to use looping or conditional construct "around" expressions generating output. *

- * For instance: - * 

+     * 
For instance:
+     * 

+     * 
      * $$ for(var x : [1, 3, 5, 42, 169]) {
      * $$   if (x == 42) {
      * Life, the universe, and everything
-     * $$   } else if (x > 42) {
+     * $$   } else if (x > 42) {
      * The value $(x} is over fourty-two
      * $$   } else {
      * The value ${x} is under fourty-two
      * $$   }
      * $$ }
      * 

+     * 

      * Will evaluate as:
-     * 
+     * 

+     * 
      * The value 1 is under fourty-two
      * The value 3 is under fourty-two
      * The value 5 is under fourty-two
@@ -1033,10 +1036,10 @@ public final class UnifiedJEXL {
      * 

      * During evaluation, the template context exposes its writer as '$jexl' which is safe to use in this case.
      * This allows writing directly through the writer without adding new-lines as in:
-     * 
+     * 

+     * 
      * $$ for(var cell : cells) { $jexl.print(cell); $jexl.print(';') }
      * 

-     * 

      * 

      * A template is expanded as one JEXL script and a list of UnifiedJEXL expressions; each UnifiedJEXL expression
      * being replace in the script by a call to jexl:print(expr) (the expr is in fact the expr number in the template).
@@ -1461,4 +1464,4 @@ public final class UnifiedJEXL {
     public Template createTemplate(String source) {
         return new Template("$$", new StringReader(source), (String[]) null);
     }
-}
\ No newline at end of file
+}

Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/Introspector.java
URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/Introspector.java?rev=1683534&r1=1683533&r2=1683534&view=diff
==============================================================================
--- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/Introspector.java (original)
+++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/Introspector.java Thu Jun  4 12:38:53 2015
@@ -28,11 +28,11 @@ import org.apache.commons.logging.Log;
 
 /**
  *  Default introspection services.
- *  
Finding methods as well as property getters & setters.

+ *  
Finding methods as well as property getters & setters.

  * @since 1.0
  */
 public class Introspector {
-    /** The logger to use for all warnings & errors. */
+    /** The logger to use for all warnings & errors. */
     protected final Log rlog;
     /** The soft reference to the introspector currently in use. */
     private volatile SoftReference ref;

Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/IntrospectorBase.java
URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/IntrospectorBase.java?rev=1683534&r1=1683533&r2=1683534&view=diff
==============================================================================
--- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/IntrospectorBase.java (original)
+++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/IntrospectorBase.java Thu Jun  4 12:38:53 2015
@@ -31,7 +31,7 @@ import org.apache.commons.logging.Log;
  * This basic function of this class is to return a Method object for a
  * particular class given the name of a method and the parameters to the method
  * in the form of an Object[]
- * 

+ * 

  * The first time the Introspector sees a class it creates a class method map
  * for the class in question. Basically the class method map is a Hastable where
  * Method objects are keyed by a concatenation of the method name and the names
@@ -324,4 +324,4 @@ public class IntrospectorBase {
             return classMap;
         }
     }
-}
\ No newline at end of file
+}

Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/MethodKey.java
URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/MethodKey.java?rev=1683534&r1=1683533&r2=1683534&view=diff
==============================================================================
--- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/MethodKey.java (original)
+++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/internal/introspection/MethodKey.java Thu Jun  4 12:38:53 2015
@@ -40,7 +40,7 @@ import java.util.Arrays;
  * 

  * A key can be constructed either from arguments (array of objects) or from parameters
  * (array of class).
- * Roughly 3x faster than string key to access the map & uses less memory.
+ * Roughly 3x faster than string key to access the map & uses less memory.
  */
 public final class MethodKey {
     /** The hash code. */

Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/introspection/Sandbox.java
URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/introspection/Sandbox.java?rev=1683534&r1=1683533&r2=1683534&view=diff
==============================================================================
--- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/introspection/Sandbox.java (original)
+++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/introspection/Sandbox.java Thu Jun  4 12:38:53 2015
@@ -26,6 +26,7 @@ import java.util.Set;
  * through "whitelists" and "blacklists".
  * 

  * A whitelist explicitly allows methods/properties for a class;
+ * 

  * 
    
  * 
  • 
  * If a whitelist is empty and thus does not contain any names, all properties/methods are allowed for its class.
@@ -34,9 +35,9 @@ import java.util.Set;
  * If it is not empty, the only allowed properties/methods are the ones contained.
  * 
    • 
  * 

- * 

  * 

  * A blacklist explicitly forbids methods/properties for a class;
+ * 

  * 
    
  * 
  • 
  * If a blacklist is empty and thus does not contain any names, all properties/methods are forbidden for its class.
@@ -47,12 +48,12 @@ import java.util.Set;
  * 

  * 

  * Permissions are composed of three lists, read, write, execute, each being "white" or "black":
+ * 

  * 
    
  * 
  • read controls readable properties 
    • 
  * 
  • write controls writeable properties
    • 
  * 
  • execute controls executable methods and constructor
    • 
  * 

- * 

  * @since 2.1
  */
 public final class Sandbox {

Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/parser/Parser.jjt
URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/parser/Parser.jjt?rev=1683534&r1=1683533&r2=1683534&view=diff
==============================================================================
--- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/parser/Parser.jjt (original)
+++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/parser/Parser.jjt Thu Jun  4 12:38:53 2015
@@ -62,7 +62,7 @@ PARSER_END(Parser)
 
 
 /***************************************
- *     Skip & Number literal tokens
+ *     Skip & Number literal tokens
  ***************************************/
 
 <*> SKIP : /* WHITE SPACE */
@@ -145,7 +145,7 @@ PARSER_END(Parser)
 }
 
 /***************************************
- *     Identifier & String tokens
+ *     Identifier & String tokens
  ***************************************/
 
 <*> TOKEN : /* IDENTIFIERS */
@@ -275,7 +275,7 @@ void LValueVar() #Reference : {}
 }
 
 /***************************************
- *      Conditional & relational
+ *      Conditional & relational
  ***************************************/
 
 void ConditionalExpression() #void : {}
@@ -398,7 +398,7 @@ void UnaryExpression() #void : {}
 
 
 /***************************************
- *      Identifier & Literals
+ *      Identifier & Literals
  ***************************************/
 
 void Identifier(boolean top) :
@@ -501,7 +501,7 @@ void MapEntry() : {}
 
 
 /***************************************
- *      Functions & Methods
+ *      Functions & Methods
  ***************************************/
 
 void EmptyFunction() : {}

Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngine.java
URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngine.java?rev=1683534&r1=1683533&r2=1683534&view=diff
==============================================================================
--- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngine.java (original)
+++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngine.java Thu Jun  4 12:38:53 2015
@@ -95,6 +95,7 @@ public class JexlScriptEngine extends Ab
      * Those properties are allways bound to the default engine scope context.
      * 

      * The following properties are defined:
+     * 

      * 
    
      * 
  • in - refers to the engine scope reader that defaults to reading System.err
    • 
      * 
  • out - refers the engine scope writer that defaults to writing in System.out
    • 
@@ -102,7 +103,6 @@ public class JexlScriptEngine extends Ab
      * 
  • logger - the JexlScriptEngine logger
    • 
      * 
  • System - the System.class
    • 
      * 

-     * 

      * @since 2.0
      */
     public class JexlScriptObject {

Modified: commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngineFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngineFactory.java?rev=1683534&r1=1683533&r2=1683534&view=diff
==============================================================================
--- commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngineFactory.java (original)
+++ commons/proper/jexl/branches/2.0/src/main/java/org/apache/commons/jexl2/scripting/JexlScriptEngineFactory.java Thu Jun  4 12:38:53 2015
@@ -29,9 +29,9 @@ import org.apache.commons.jexl2.parser.S
 /**
  * Implements the Jexl ScriptEngineFactory for JSF-223.
  * 

- * Supports the following:
- * Language short names: "JEXL", "Jexl", "jexl", "JEXL2", "Jexl2", "jexl2" 

- * File Extensions: ".jexl", ".jexl2"

+ * Supports the following:

+ * Language short names: "JEXL", "Jexl", "jexl", "JEXL2", "Jexl2", "jexl2" 

+ * File Extensions: ".jexl", ".jexl2"

  * "jexl2" etc. were added for engineVersion="2.0".
  * 

  *