Author: henrib
Date: Fri Aug 5 12:55:16 2016
New Revision: 1755315
URL: http://svn.apache.org/viewvc?rev=1755315&view=rev
Log:
JEXL:
Javadoc fixes
Modified:
commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlException.java
commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlOperator.java
Modified:
commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlException.java
URL:
http://svn.apache.org/viewvc/commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlException.java?rev=1755315&r1=1755314&r2=1755315&view=diff
==============================================================================
---
commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlException.java
(original)
+++
commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlException.java
Fri Aug 5 12:55:16 2016
@@ -678,7 +678,7 @@ public class JexlException extends Runti
/**
* Detailed info message about this error.
* Format is "debug![begin,end]: string \n msg" where:
- * <ul></ul>
+ *
* - debug is the debugging information if it exists (@link
JexlEngine.setDebug)
* - begin, end are character offsets in the string for the precise
location of the error
* - string is the string representation of the offending expression
Modified:
commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlOperator.java
URL:
http://svn.apache.org/viewvc/commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlOperator.java?rev=1755315&r1=1755314&r2=1755315&view=diff
==============================================================================
---
commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlOperator.java
(original)
+++
commons/proper/jexl/trunk/src/main/java/org/apache/commons/jexl3/JexlOperator.java
Fri Aug 5 12:55:16 2016
@@ -36,196 +36,225 @@ package org.apache.commons.jexl3;
public enum JexlOperator {
/**
- * <strong>Syntax:</strong> <code>x + y</code>
+ * Add operator.
+ * <br><strong>Syntax:</strong> <code>x + y</code>
* <br><strong>Method:</strong> <code>T add(L x, R y);</code>.
* @see JexlArithmetic#add
*/
ADD("+", "add", 2),
/**
- * <strong>Syntax:</strong> <code>x - y</code>
+ * Subtract operator.
+ * <br><strong>Syntax:</strong> <code>x - y</code>
* <br><strong>Method:</strong> <code>T subtract(L x, R y);</code>.
* @see JexlArithmetic#subtract
*/
SUBTRACT("-", "subtract", 2),
/**
- * <strong>Syntax:</strong> <code>x * y</code>
+ * Multiply operator.
+ * <br><strong>Syntax:</strong> <code>x * y</code>
* <br><strong>Method:</strong> <code>T multiply(L x, R y);</code>.
* @see JexlArithmetic#multiply
*/
MULTIPLY("*", "multiply", 2),
/**
- * <strong>Syntax:</strong> <code>x / y</code>
+ * Divide operator.
+ * <br><strong>Syntax:</strong> <code>x / y</code>
* <br><strong>Method:</strong> <code>T divide(L x, R y);</code>.
* @see JexlArithmetic#divide
*/
DIVIDE("/", "divide", 2),
/**
- * <strong>Syntax:</strong> <code>x % y</code>
+ * Modulo operator.
+ * <br><strong>Syntax:</strong> <code>x % y</code>
* <br><strong>Method:</strong> <code>T mod(L x, R y);</code>.
* @see JexlArithmetic#mod
*/
MOD("%", "mod", 2),
/**
- * <strong>Syntax:</strong> <code>x & y</code>
+ * Bitwise-and operator.
+ * <br><strong>Syntax:</strong> <code>x & y</code>
* <br><strong>Method:</strong> <code>T and(L x, R y);</code>.
* @see JexlArithmetic#and
*/
AND("&", "and", 2),
/**
- * <strong>Syntax:</strong> <code>x | y</code>
+ * Bitwise-or operator.
+ * <br><strong>Syntax:</strong> <code>x | y</code>
* <br><strong>Method:</strong> <code>T or(L x, R y);</code>.
* @see JexlArithmetic#or
*/
OR("|", "or", 2),
/**
- * <strong>Syntax:</strong> <code>x ^ y</code>
+ * Bitwise-xor operator.
+ * <br><strong>Syntax:</strong> <code>x ^ y</code>
* <br><strong>Method:</strong> <code>T xor(L x, R y);</code>.
* @see JexlArithmetic#xor
*/
XOR("^", "xor", 2),
/**
- * <strong>Syntax:</strong> <code>x == y</code>
+ * Equals operator.
+ * <br><strong>Syntax:</strong> <code>x == y</code>
* <br><strong>Method:</strong> <code>boolean equals(L x, R y);</code>.
* @see JexlArithmetic#equals
*/
EQ("==", "equals", 2),
/**
- * <strong>Syntax:</strong> <code>x < y</code>
+ * Less-than operator.
+ * <br><strong>Syntax:</strong> <code>x < y</code>
* <br><strong>Method:</strong> <code>boolean lessThan(L x, R y);</code>.
* @see JexlArithmetic#lessThan
*/
LT("<", "lessThan", 2),
/**
- * <strong>Syntax:</strong> <code>x <= y</code>
+ * Less-than-or-equal operator.
+ * <br><strong>Syntax:</strong> <code>x <= y</code>
* <br><strong>Method:</strong> <code>boolean lessThanOrEqual(L x, R
y);</code>.
* @see JexlArithmetic#lessThanOrEqual
*/
LTE("<=", "lessThanOrEqual", 2),
/**
- * <strong>Syntax:</strong> <code>x > y</code>
+ * Greater-than operator.
+ * <br><strong>Syntax:</strong> <code>x > y</code>
* <br><strong>Method:</strong> <code>boolean greaterThan(L x, R
y);</code>.
* @see JexlArithmetic#greaterThan
*/
GT(">", "greaterThan", 2),
/**
- * <strong>Syntax:</strong> <code>x >= y</code>
+ * Greater-than-or-equal operator.
+ * <br><strong>Syntax:</strong> <code>x >= y</code>
* <br><strong>Method:</strong> <code>boolean greaterThanOrEqual(L x, R
y);</code>.
* @see JexlArithmetic#greaterThanOrEqual
*/
GTE(">=", "greaterThanOrEqual", 2),
/**
- * <strong>Syntax:</strong> <code>x =~ y</code>
+ * Contains operator.
+ * <br><strong>Syntax:</strong> <code>x =~ y</code>
* <br><strong>Method:</strong> <code>boolean contains(L x, R y);</code>.
* @see JexlArithmetic#contains
*/
CONTAINS("=~", "contains", 2),
/**
- * <strong>Syntax:</strong> <code>x =^ y</code>
+ * Starts-with operator.
+ * <br><strong>Syntax:</strong> <code>x =^ y</code>
* <br><strong>Method:</strong> <code>boolean startsWith(L x, R y);</code>.
* @see JexlArithmetic#startsWith
*/
STARTSWITH("=^", "startsWith", 2),
/**
- * <strong>Syntax:</strong> <code>x =$ y</code>
+ * Ends-with operator.
+ * <br><strong>Syntax:</strong> <code>x =$ y</code>
* <br><strong>Method:</strong> <code>boolean endsWith(L x, R y);</code>.
* @see JexlArithmetic#endsWith
*/
ENDSWITH("=$", "endsWith", 2),
/**
- * <strong>Syntax:</strong> <code>!x</code>
+ * Not operator.
+ * <br><strong>Syntax:</strong> <code>!x</code>
* <br><strong>Method:</strong> <code>T not(L x);</code>.
* @see JexlArithmetic#not
*/
NOT("!", "not", 1),
/**
- * <strong>Syntax:</strong> <code>~x</code>
+ * Complement operator.
+ * <br><strong>Syntax:</strong> <code>~x</code>
* <br><strong>Method:</strong> <code>T complement(L x);</code>.
* @see JexlArithmetic#complement
*/
COMPLEMENT("~", "complement", 1),
/**
- * <strong>Syntax:</strong> <code>-x</code>
+ * Negate operator.
+ * <br><strong>Syntax:</strong> <code>-x</code>
* <br><strong>Method:</strong> <code>T negate(L x);</code>.
* @see JexlArithmetic#negate
*/
NEGATE("-", "negate", 1),
/**
- * <strong>Syntax:</strong> <code>empty x</code> or <code>empty(x)</code>
+ * Empty operator.
+ * <br><strong>Syntax:</strong> <code>empty x</code> or
<code>empty(x)</code>
* <br><strong>Method:</strong> <code>boolean isEmpty(L x);</code>.
* @see JexlArithmetic#isEmpty
*/
EMPTY("empty", "empty", 1),
/**
- * <strong>Syntax:</strong> <code>size x</code> or <code>size(x)</code>
+ * Size operator.
+ * <br><strong>Syntax:</strong> <code>size x</code> or <code>size(x)</code>
* <br><strong>Method:</strong> <code>int size(L x);</code>.
* @see JexlArithmetic#size
*/
SIZE("size", "size", 1),
/**
- * <strong>Syntax:</strong> <code>x += y</code>
+ * Self-add operator.
+ * <br><strong>Syntax:</strong> <code>x += y</code>
* <br><strong>Method:</strong> <code>T selfAdd(L x, R y);</code>.
*/
SELF_ADD("+=", "selfAdd", ADD),
/**
- * <strong>Syntax:</strong> <code>x -= y</code>
+ * Self-subtract operator.
+ * <br><strong>Syntax:</strong> <code>x -= y</code>
* <br><strong>Method:</strong> <code>T selfSubtract(L x, R y);</code>.
*/
SELF_SUBTRACT("-=", "selfSubtract", SUBTRACT),
/**
- * <strong>Syntax:</strong> <code>x *= y</code>
+ * Self-multiply operator.
+ * <br><strong>Syntax:</strong> <code>x *= y</code>
* <br><strong>Method:</strong> <code>T selfMultiply(L x, R y);</code>.
*/
SELF_MULTIPLY("*=", "selfMultiply", MULTIPLY),
/**
- * <strong>Syntax:</strong> <code>x /= y</code>
+ * Self-divide operator.
+ * <br><strong>Syntax:</strong> <code>x /= y</code>
* <br><strong>Method:</strong> <code>T selfDivide(L x, R y);</code>.
*/
SELF_DIVIDE("/=", "selfDivide", DIVIDE),
/**
- * <strong>Syntax:</strong> <code>x %= y</code>
+ * Self-modulo operator.
+ * <br><strong>Syntax:</strong> <code>x %= y</code>
* <br><strong>Method:</strong> <code>T selfMod(L x, R y);</code>.
*/
SELF_MOD("%=", "selfMod", MOD),
/**
- * <strong>Syntax:</strong> <code>x &= y</code>
+ * Self-and operator.
+ * <br><strong>Syntax:</strong> <code>x &= y</code>
* <br><strong>Method:</strong> <code>T selfAnd(L x, R y);</code>.
*/
SELF_AND("&=", "selfAnd", AND),
/**
- * <strong>Syntax:</strong> <code>x |= y</code>
+ * Self-or operator.
+ * <br><strong>Syntax:</strong> <code>x |= y</code>
* <br><strong>Method:</strong> <code>T selfOr(L x, R y);</code>.
*/
SELF_OR("|=", "selfOr", OR),
/**
- * <strong>Syntax:</strong> <code>x ^= y</code>
+ * Self-xor operator.
+ * <br><strong>Syntax:</strong> <code>x ^= y</code>
* <br><strong>Method:</strong> <code>T selfXor(L x, R y);</code>.
*/
SELF_XOR("^=", "selfXor", XOR),
@@ -239,38 +268,37 @@ public enum JexlOperator {
/**
* Property get operator as in: x.y.
- * <strong>Syntax:</strong> <code>x.y</code>
+ * <br><strong>Syntax:</strong> <code>x.y</code>
* <br><strong>Method:</strong> <code>Object propertyGet(L x, R y);</code>.
*/
PROPERTY_GET(".", "propertyGet", 2),
/**
* Property set operator as in: x.y = z.
- * <strong>Syntax:</strong> <code>x.y = z</code>
+ * <br><strong>Syntax:</strong> <code>x.y = z</code>
* <br><strong>Method:</strong> <code>void propertySet(L x, R y, V
z);</code>.
*/
PROPERTY_SET(".=", "propertySet", 3),
/**
* Array get operator as in: x[y].
- * <strong>Syntax:</strong> <code>x.y</code>
- * <br><strong>Method:</strong> <code>Object arrayyGet(L x, R y);</code>.
+ * <br><strong>Syntax:</strong> <code>x.y</code>
+ * <br><strong>Method:</strong> <code>Object arrayGet(L x, R y);</code>.
*/
ARRAY_GET("[]", "arrayGet", 2),
/**
* Array set operator as in: x[y] = z.
- * <strong>Syntax:</strong> <code>x[y] = z</code>
+ * <br><strong>Syntax:</strong> <code>x[y] = z</code>
* <br><strong>Method:</strong> <code>void arraySet(L x, R y, V z);</code>.
*/
ARRAY_SET("[]=", "arraySet", 3),
/**
* Iterator generator as in for(var x : y).
- * <strong>Syntax:</strong> <code>for(var x : y){...} </code>
- * <br><strong>Method:</strong> <code>Iterator<Object> forEach(R
y);</code>.
- *
* If the returned Iterator is AutoCloseable, close will be called after
the last execution of the loop block.
+ * <br><strong>Syntax:</strong> <code>for(var x : y){...} </code>
+ * <br><strong>Method:</strong> <code>Iterator<Object> forEach(R
y);</code>.
*/
FOR_EACH("for(...)", "forEach", 1);
