This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-ognl.git
The following commit(s) were added to refs/heads/master by this push:
new 49dbf30 Javadoc
49dbf30 is described below
commit 49dbf305adf4ce25541174e2cca41b559f3571da
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:40 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/ognl/ASTAnd.java | 6 +-
.../java/org/apache/commons/ognl/ASTConst.java | 2 +-
.../org/apache/commons/ognl/ElementsAccessor.java | 2 +-
.../org/apache/commons/ognl/MethodAccessor.java | 12 +--
src/main/java/org/apache/commons/ognl/Ognl.java | 86 +++++++++++-----------
.../org/apache/commons/ognl/OgnlException.java | 6 +-
src/main/java/org/apache/commons/ognl/OgnlOps.java | 30 ++++----
.../java/org/apache/commons/ognl/OgnlRuntime.java | 6 +-
.../org/apache/commons/ognl/PropertyAccessor.java | 10 +--
9 files changed, 80 insertions(+), 80 deletions(-)
diff --git a/src/main/java/org/apache/commons/ognl/ASTAnd.java
b/src/main/java/org/apache/commons/ognl/ASTAnd.java
index b36906e..892881e 100644
--- a/src/main/java/org/apache/commons/ognl/ASTAnd.java
+++ b/src/main/java/org/apache/commons/ognl/ASTAnd.java
@@ -36,7 +36,7 @@ public class ASTAnd
/**
* TODO: Javadoc
*
- * @param id the id
+ * @param id The id
*/
public ASTAnd( int id )
{
@@ -46,8 +46,8 @@ public class ASTAnd
/**
* TODO: Javadoc
*
- * @param p the parser
- * @param id the id
+ * @param p The parser
+ * @param id The id
*/
public ASTAnd( OgnlParser p, int id )
{
diff --git a/src/main/java/org/apache/commons/ognl/ASTConst.java
b/src/main/java/org/apache/commons/ognl/ASTConst.java
index 0524f24..01f528c 100644
--- a/src/main/java/org/apache/commons/ognl/ASTConst.java
+++ b/src/main/java/org/apache/commons/ognl/ASTConst.java
@@ -45,7 +45,7 @@ public class ASTConst
/**
* Called from parser actions.
*
- * @param value the value to set
+ * @param value The value to set
*/
public void setValue( Object value )
{
diff --git a/src/main/java/org/apache/commons/ognl/ElementsAccessor.java
b/src/main/java/org/apache/commons/ognl/ElementsAccessor.java
index ba5a32f..16b928c 100644
--- a/src/main/java/org/apache/commons/ognl/ElementsAccessor.java
+++ b/src/main/java/org/apache/commons/ognl/ElementsAccessor.java
@@ -35,7 +35,7 @@ public interface ElementsAccessor
/**
* Returns an iterator over the elements of the given target object.
*
- * @param target the object to get the elements of
+ * @param target The object to get the elements of
* @return An iterator over the elements of the given object
* @throws OgnlException if there is an error getting the given object's
elements
*/
diff --git a/src/main/java/org/apache/commons/ognl/MethodAccessor.java
b/src/main/java/org/apache/commons/ognl/MethodAccessor.java
index bc95ce7..0b152d9 100644
--- a/src/main/java/org/apache/commons/ognl/MethodAccessor.java
+++ b/src/main/java/org/apache/commons/ognl/MethodAccessor.java
@@ -32,9 +32,9 @@ public interface MethodAccessor
* Calls the static method named with the arguments given on the class
given.
*
* @param context expression context in which the method should be called
- * @param targetClass the object in which the method exists
- * @param methodName the name of the method
- * @param args the arguments to the method
+ * @param targetClass The object in which the method exists
+ * @param methodName The name of the method
+ * @param args The arguments to the method
* @return result of calling the method
* @throws OgnlException if there is an error calling the method
*/
@@ -45,9 +45,9 @@ public interface MethodAccessor
* Calls the method named with the arguments given.
*
* @param context expression context in which the method should be called
- * @param target the object in which the method exists
- * @param methodName the name of the method
- * @param args the arguments to the method
+ * @param target The object in which the method exists
+ * @param methodName The name of the method
+ * @param args The arguments to the method
* @return result of calling the method
* @throws OgnlException if there is an error calling the method
*/
diff --git a/src/main/java/org/apache/commons/ognl/Ognl.java
b/src/main/java/org/apache/commons/ognl/Ognl.java
index 4962fbc..8da27d5 100644
--- a/src/main/java/org/apache/commons/ognl/Ognl.java
+++ b/src/main/java/org/apache/commons/ognl/Ognl.java
@@ -98,7 +98,7 @@ public abstract class Ognl
* Parses the given OGNL expression and returns a tree representation of
the expression that can be used by
* <code>Ognl</code> static methods.
*
- * @param expression the OGNL expression to be parsed
+ * @param expression The OGNL expression to be parsed
* @return A tree representation of the expression
* @throws ExpressionSyntaxException if the expression is malformed
* @throws OgnlException if there is a pathological environmental problem
@@ -145,7 +145,7 @@ public abstract class Ognl
/**
* Creates and returns a new standard naming context for evaluating an
OGNL expression.
*
- * @param root the root of the object graph
+ * @param root The root of the object graph
* @return A new Map with the keys <code>root</code> and
<code>context</code> set appropriately
*/
public static Map<String, Object> createDefaultContext( Object root )
@@ -199,8 +199,8 @@ public abstract class Ognl
* Appends the standard naming context for evaluating an OGNL expression
into the context given so that cached maps
* can be used as a context.
*
- * @param root the root of the object graph
- * @param context the context to which OGNL context will be added.
+ * @param root The root of the object graph
+ * @param context The context to which OGNL context will be added.
* @return Context Map with the keys <code>root</code> and
<code>context</code> set appropriately
*/
public static Map<String, Object> addDefaultContext( Object root,
Map<String, Object> context )
@@ -243,7 +243,7 @@ public abstract class Ognl
* Appends the standard naming context for evaluating an OGNL expression
into the context given so that cached maps
* can be used as a context.
*
- * @param root the root of the object graph
+ * @param root The root of the object graph
* @param classResolver The class loading resolver that should be used to
resolve class references.
* @param converter The type converter to be used by default.
* @param memberAccess Definition for handling private/protected access.
@@ -390,9 +390,9 @@ public abstract class Ognl
* Evaluates the given OGNL expression tree to extract a value from the
given root object. The default context is
* set for the given context and root via <code>addDefaultContext()</code>.
*
- * @param tree the OGNL expression tree to evaluate, as returned by
parseExpression()
- * @param context the naming context for the evaluation
- * @param root the root object for the OGNL expression
+ * @param tree The OGNL expression tree to evaluate, as returned by
parseExpression()
+ * @param context The naming context for the evaluation
+ * @param root The root object for the OGNL expression
* @return the result of evaluating the expression
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
@@ -409,10 +409,10 @@ public abstract class Ognl
* Evaluates the given OGNL expression tree to extract a value from the
given root object. The default context is
* set for the given context and root via <code>addDefaultContext()</code>.
*
- * @param tree the OGNL expression tree to evaluate, as returned by
parseExpression()
- * @param context the naming context for the evaluation
- * @param root the root object for the OGNL expression
- * @param resultType the converted type of the resultant object, using the
context's type converter
+ * @param tree The OGNL expression tree to evaluate, as returned by
parseExpression()
+ * @param context The naming context for the evaluation
+ * @param root The root object for the OGNL expression
+ * @param resultType The converted type of the resultant object, using the
context's type converter
* @return the result of evaluating the expression
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
@@ -480,9 +480,9 @@ public abstract class Ognl
*
* @see #parseExpression(String)
* @see #getValue(Object,Object)
- * @param expression the OGNL expression to be parsed
- * @param context the naming context for the evaluation
- * @param root the root object for the OGNL expression
+ * @param expression The OGNL expression to be parsed
+ * @param context The naming context for the evaluation
+ * @param root The root object for the OGNL expression
* @return the result of evaluating the expression
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
@@ -500,10 +500,10 @@ public abstract class Ognl
*
* @see #parseExpression(String)
* @see #getValue(Object,Object)
- * @param expression the OGNL expression to be parsed
- * @param context the naming context for the evaluation
- * @param root the root object for the OGNL expression
- * @param resultType the converted type of the resultant object, using the
context's type converter
+ * @param expression The OGNL expression to be parsed
+ * @param context The naming context for the evaluation
+ * @param root The root object for the OGNL expression
+ * @param resultType The converted type of the resultant object, using the
context's type converter
* @return the result of evaluating the expression
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
@@ -519,8 +519,8 @@ public abstract class Ognl
/**
* Evaluates the given OGNL expression tree to extract a value from the
given root object.
*
- * @param tree the OGNL expression tree to evaluate, as returned by
parseExpression()
- * @param root the root object for the OGNL expression
+ * @param tree The OGNL expression tree to evaluate, as returned by
parseExpression()
+ * @param root The root object for the OGNL expression
* @return the result of evaluating the expression
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
@@ -536,9 +536,9 @@ public abstract class Ognl
/**
* Evaluates the given OGNL expression tree to extract a value from the
given root object.
*
- * @param tree the OGNL expression tree to evaluate, as returned by
parseExpression()
- * @param root the root object for the OGNL expression
- * @param resultType the converted type of the resultant object, using the
context's type converter
+ * @param tree The OGNL expression tree to evaluate, as returned by
parseExpression()
+ * @param root The root object for the OGNL expression
+ * @param resultType The converted type of the resultant object, using the
context's type converter
* @return the result of evaluating the expression
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
@@ -556,8 +556,8 @@ public abstract class Ognl
*
* @see #parseExpression(String)
* @see #getValue(Object,Object)
- * @param expression the OGNL expression to be parsed
- * @param root the root object for the OGNL expression
+ * @param expression The OGNL expression to be parsed
+ * @param root The root object for the OGNL expression
* @return the result of evaluating the expression
* @throws ExpressionSyntaxException if the expression is malformed
* @throws MethodFailedException if the expression called a method which
failed
@@ -576,9 +576,9 @@ public abstract class Ognl
*
* @see #parseExpression(String)
* @see #getValue(Object,Object)
- * @param expression the OGNL expression to be parsed
- * @param root the root object for the OGNL expression
- * @param resultType the converted type of the resultant object, using the
context's type converter
+ * @param expression The OGNL expression to be parsed
+ * @param root The root object for the OGNL expression
+ * @param resultType The converted type of the resultant object, using the
context's type converter
* @return the result of evaluating the expression
* @throws ExpressionSyntaxException if the expression is malformed
* @throws MethodFailedException if the expression called a method which
failed
@@ -596,10 +596,10 @@ public abstract class Ognl
* Evaluates the given OGNL expression tree to insert a value into the
object graph rooted at the given root object.
* The default context is set for the given context and root via
<code>addDefaultContext()</code>.
*
- * @param tree the OGNL expression tree to evaluate, as returned by
parseExpression()
- * @param context the naming context for the evaluation
- * @param root the root object for the OGNL expression
- * @param value the value to insert into the object graph
+ * @param tree The OGNL expression tree to evaluate, as returned by
parseExpression()
+ * @param context The naming context for the evaluation
+ * @param root The root object for the OGNL expression
+ * @param value The value to insert into the object graph
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
* @throws InappropriateExpressionException if the expression can't be
used in this context
@@ -637,10 +637,10 @@ public abstract class Ognl
* Evaluates the given OGNL expression to insert a value into the object
graph rooted at the given root object given
* the context.
*
- * @param expression the OGNL expression to be parsed
- * @param root the root object for the OGNL expression
- * @param context the naming context for the evaluation
- * @param value the value to insert into the object graph
+ * @param expression The OGNL expression to be parsed
+ * @param root The root object for the OGNL expression
+ * @param context The naming context for the evaluation
+ * @param value The value to insert into the object graph
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
* @throws InappropriateExpressionException if the expression can't be
used in this context
@@ -655,9 +655,9 @@ public abstract class Ognl
/**
* Evaluates the given OGNL expression tree to insert a value into the
object graph rooted at the given root object.
*
- * @param tree the OGNL expression tree to evaluate, as returned by
parseExpression()
- * @param root the root object for the OGNL expression
- * @param value the value to insert into the object graph
+ * @param tree The OGNL expression tree to evaluate, as returned by
parseExpression()
+ * @param root The root object for the OGNL expression
+ * @param value The value to insert into the object graph
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
* @throws InappropriateExpressionException if the expression can't be
used in this context
@@ -674,9 +674,9 @@ public abstract class Ognl
*
* @see #parseExpression(String)
* @see #setValue(Object,Object,Object)
- * @param expression the OGNL expression to be parsed
- * @param root the root object for the OGNL expression
- * @param value the value to insert into the object graph
+ * @param expression The OGNL expression to be parsed
+ * @param root The root object for the OGNL expression
+ * @param value The value to insert into the object graph
* @throws ExpressionSyntaxException if the expression is malformed
* @throws MethodFailedException if the expression called a method which
failed
* @throws NoSuchPropertyException if the expression referred to a
nonexistent property
diff --git a/src/main/java/org/apache/commons/ognl/OgnlException.java
b/src/main/java/org/apache/commons/ognl/OgnlException.java
index 4e5caaf..fb5315c 100644
--- a/src/main/java/org/apache/commons/ognl/OgnlException.java
+++ b/src/main/java/org/apache/commons/ognl/OgnlException.java
@@ -67,7 +67,7 @@ public class OgnlException
/**
* Constructs an OgnlException with the given message but no encapsulated
exception.
*
- * @param msg the exception's detail message
+ * @param msg The exception's detail message
*/
public OgnlException( String msg )
{
@@ -77,8 +77,8 @@ public class OgnlException
/**
* Constructs an OgnlException with the given message and encapsulated
exception.
*
- * @param msg the exception's detail message
- * @param reason the encapsulated exception
+ * @param msg The exception's detail message
+ * @param reason The encapsulated exception
*/
public OgnlException( String msg, Throwable reason )
{
diff --git a/src/main/java/org/apache/commons/ognl/OgnlOps.java
b/src/main/java/org/apache/commons/ognl/OgnlOps.java
index 95e395d..c210138 100644
--- a/src/main/java/org/apache/commons/ognl/OgnlOps.java
+++ b/src/main/java/org/apache/commons/ognl/OgnlOps.java
@@ -172,7 +172,7 @@ public abstract class OgnlOps
* Evaluates the given object as a boolean: if it is a Boolean object,
it's easy; if it's a Number or a Character,
* returns true for non-zero objects; and otherwise returns true for
non-null objects.
*
- * @param value an object to interpret as a boolean
+ * @param value An object to interpret as a boolean
* @return The boolean value implied by the given object
*/
public static boolean booleanValue( Object value )
@@ -201,7 +201,7 @@ public abstract class OgnlOps
/**
* Evaluates the given object as a long integer.
*
- * @param value an object to interpret as a long integer
+ * @param value An object to interpret as a long integer
* @return The long integer value implied by the given object
* @throws NumberFormatException if the given object can't be understood
as a long integer
*/
@@ -230,7 +230,7 @@ public abstract class OgnlOps
/**
* Evaluates the given object as a double-precision floating-point number.
*
- * @param value an object to interpret as a double
+ * @param value An object to interpret as a double
* @return The double value implied by the given object
* @throws NumberFormatException if the given object can't be understood
as a double
*/
@@ -261,7 +261,7 @@ public abstract class OgnlOps
/**
* Evaluates the given object as a BigInteger.
*
- * @param value an object to interpret as a BigInteger
+ * @param value An object to interpret as a BigInteger
* @return The BigInteger value implied by the given object
* @throws NumberFormatException if the given object can't be understood
as a BigInteger
*/
@@ -298,7 +298,7 @@ public abstract class OgnlOps
/**
* Evaluates the given object as a BigDecimal.
*
- * @param value an object to interpret as a BigDecimal
+ * @param value An object to interpret as a BigDecimal
* @return The BigDecimal value implied by the given object
* @throws NumberFormatException if the given object can't be understood
as a BigDecimal
*/
@@ -331,7 +331,7 @@ public abstract class OgnlOps
/**
* Evaluates the given object as a String and trims it if the trim flag is
true.
*
- * @param value an object to interpret as a String
+ * @param value An object to interpret as a String
* @param trim if true trims the result
* @return The String value implied by the given object as returned by the
toString() method, or "null" if the
* object is null.
@@ -358,7 +358,7 @@ public abstract class OgnlOps
/**
* Evaluates the given object as a String.
*
- * @param value an object to interpret as a String
+ * @param value An object to interpret as a String
* @return The String value implied by the given object as returned by the
toString() method, or "null" if the
* object is null.
*/
@@ -370,7 +370,7 @@ public abstract class OgnlOps
/**
* Returns a constant from the NumericTypes interface that represents the
numeric type of the given object.
*
- * @param value an object that needs to be interpreted as a number
+ * @param value An object that needs to be interpreted as a number
* @return The appropriate constant from the NumericTypes interface
*/
public static int getNumericType( Object value )
@@ -598,7 +598,7 @@ public abstract class OgnlOps
* Returns the value converted numerically to the given class type This
method also detects when arrays are being
* converted and converts the components of one array to the type of the
other.
*
- * @param value an object to be converted to the given type
+ * @param value An object to be converted to the given type
* @param toType class type to be converted to
* @return converted value of the type given, or value if the value cannot
be converted to the given type.
*/
@@ -819,7 +819,7 @@ public abstract class OgnlOps
* two given objects.
*
* @param v1 one argument to a numeric operator
- * @param v2 the other argument
+ * @param v2 The other argument
* @return The appropriate constant from the NumericTypes interface
*/
public static int getNumericType( Object v1, Object v2 )
@@ -892,7 +892,7 @@ public abstract class OgnlOps
* either numeric or not, on the two given objects.
*
* @param v1 one argument to an operator
- * @param v2 the other argument
+ * @param v2 The other argument
* @param canBeNonNumeric whether the operator can be interpreted as
non-numeric
* @return The appropriate constant from the NumericTypes interface
*/
@@ -905,8 +905,8 @@ public abstract class OgnlOps
* Returns a new Number object of an appropriate type to hold the given
integer value. The type of the returned
* object is consistent with the given type argument, which is a constant
from the NumericTypes interface.
*
- * @param type the nominal numeric type of the result, a constant from the
NumericTypes interface
- * @param value the integer value to convert to a Number object
+ * @param type The nominal numeric type of the result, a constant from the
NumericTypes interface
+ * @param value The integer value to convert to a Number object
* @return A Number object with the given value, of type implied by the
type argument
*/
public static Number newInteger( int type, long value )
@@ -949,8 +949,8 @@ public abstract class OgnlOps
* is always either Float or Double, and is only Float if the given type
tag (a constant from the NumericTypes
* interface) is FLOAT.
*
- * @param type the nominal numeric type of the result, a constant from the
NumericTypes interface
- * @param value the real value to convert to a Number object
+ * @param type The nominal numeric type of the result, a constant from the
NumericTypes interface
+ * @param value The real value to convert to a Number object
* @return A Number object with the given value, of type implied by the
type argument
*/
public static Number newReal( int type, double value )
diff --git a/src/main/java/org/apache/commons/ognl/OgnlRuntime.java
b/src/main/java/org/apache/commons/ognl/OgnlRuntime.java
index bd3ddc5..1fa492e 100644
--- a/src/main/java/org/apache/commons/ognl/OgnlRuntime.java
+++ b/src/main/java/org/apache/commons/ognl/OgnlRuntime.java
@@ -494,7 +494,7 @@ public class OgnlRuntime
* standard primitive wrapper classes and exchanging for them their
underlying primitive class objects. Other
* classes are passed through unchanged.
*
- * @param arg an object that is being passed to a method
+ * @param arg An object that is being passed to a method
* @return The class to use to look up the method
*/
public static Class<?> getArgClass( Object arg )
@@ -1434,8 +1434,8 @@ public class OgnlRuntime
* This method returns a PropertyDescriptor for the given class and
property name using a Map lookup (using
* getPropertyDescriptorsMap()).
*
- * @param targetClass a target class.
- * @param propertyName a property name.
+ * @param targetClass A target class.
+ * @param propertyName A property name.
* @return The PropertyDescriptor for the given targetClass and
propertyName.
* @throws java.beans.IntrospectionException
* @throws OgnlException
diff --git a/src/main/java/org/apache/commons/ognl/PropertyAccessor.java
b/src/main/java/org/apache/commons/ognl/PropertyAccessor.java
index 83390e8..c9ab55a 100644
--- a/src/main/java/org/apache/commons/ognl/PropertyAccessor.java
+++ b/src/main/java/org/apache/commons/ognl/PropertyAccessor.java
@@ -42,8 +42,8 @@ public interface PropertyAccessor
* Extracts and returns the property of the given name from the given
target object.
*
* @param context The current execution context.
- * @param target the object to get the property from
- * @param name the name of the property to get.
+ * @param target The object to get the property from
+ * @param name The name of the property to get.
* @return The current value of the given property in the given object
* @throws OgnlException if there is an error locating the property in the
given object
*/
@@ -54,9 +54,9 @@ public interface PropertyAccessor
* Sets the value of the property of the given name in the given target
object.
*
* @param context The current execution context.
- * @param target the object to set the property in
- * @param name the name of the property to set
- * @param value the new value for the property.
+ * @param target The object to set the property in
+ * @param name The name of the property to set
+ * @param value The new value for the property.
* @throws OgnlException if there is an error setting the property in the
given object
*/
void setProperty( Map<String, Object> context, Object target, Object name,
Object value )
