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-jxpath.git
The following commit(s) were added to refs/heads/master by this push:
new 8f8e3ce2 Javadoc
8f8e3ce2 is described below
commit 8f8e3ce286256be213a4b6225d590b875bec8b04
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:31 2026 -0400
Javadoc
---
.../org/apache/commons/jxpath/JXPathContext.java | 8 +++---
.../commons/jxpath/XMLDocumentContainer.java | 2 +-
.../jxpath/functions/ConstructorFunction.java | 2 +-
.../org/apache/commons/jxpath/ri/EvalContext.java | 2 +-
.../commons/jxpath/ri/NamespaceResolver.java | 6 ++---
.../java/org/apache/commons/jxpath/ri/Parser.java | 2 +-
.../jxpath/ri/compiler/CoreOperationNegate.java | 2 +-
.../apache/commons/jxpath/ri/compiler/Path.java | 4 +--
.../commons/jxpath/ri/model/NodeIterator.java | 2 +-
.../commons/jxpath/ri/model/NodePointer.java | 30 +++++++++++-----------
.../jxpath/ri/model/VariablePointerFactory.java | 2 +-
.../ri/model/beans/PropertyOwnerPointer.java | 2 +-
.../jxpath/ri/model/dom/DOMNodePointer.java | 2 +-
.../ri/model/jdom/JDOMNamespaceIterator.java | 4 +--
.../commons/jxpath/ri/parser/TokenMgrError.java | 2 +-
.../commons/jxpath/util/ClassLoaderUtil.java | 8 +++---
.../commons/jxpath/util/MethodLookupUtils.java | 4 +--
.../commons/jxpath/util/ClassLoaderUtilTest.java | 4 +--
18 files changed, 44 insertions(+), 44 deletions(-)
diff --git a/src/main/java/org/apache/commons/jxpath/JXPathContext.java
b/src/main/java/org/apache/commons/jxpath/JXPathContext.java
index 0571b4b6..66b272a1 100644
--- a/src/main/java/org/apache/commons/jxpath/JXPathContext.java
+++ b/src/main/java/org/apache/commons/jxpath/JXPathContext.java
@@ -723,7 +723,7 @@ public abstract class JXPathContext {
/**
* Gets the prefix associated with the specifed namespace URI.
*
- * @param namespaceURI the ns URI to check.
+ * @param namespaceURI The ns URI to check.
* @return String prefix
* @since JXPath 1.3
*/
@@ -829,7 +829,7 @@ public abstract class JXPathContext {
/**
* Finds all nodes that match the specified XPath.
*
- * @param xpath the xpath to be evaluated
+ * @param xpath The xpath to be evaluated
* @return A list of found objects
*/
public List selectNodes(final String xpath) {
@@ -847,7 +847,7 @@ public abstract class JXPathContext {
* result as {@code getValue()} on object models like JavaBeans, but a
different result for DOM/JDOM etc., because it returns the Node itself, rather
than
* its textual contents.
*
- * @param xpath the xpath to be evaluated
+ * @param xpath The xpath to be evaluated
* @return The found object
*/
public Object selectSingleNode(final String xpath) {
@@ -859,7 +859,7 @@ public abstract class JXPathContext {
* Sets {@link DecimalFormatSymbols} for a given name. The
DecimalFormatSymbols can be referenced as the third, optional argument in the
invocation of
* {@code format-number (number,format,decimal-format-name)} function. By
default, JXPath uses the symbols for the current locale.
*
- * @param name the format name or null for default format.
+ * @param name The format name or null for default format.
* @param symbols DecimalFormatSymbols
*/
public synchronized void setDecimalFormatSymbols(final String name, final
DecimalFormatSymbols symbols) {
diff --git a/src/main/java/org/apache/commons/jxpath/XMLDocumentContainer.java
b/src/main/java/org/apache/commons/jxpath/XMLDocumentContainer.java
index 04da18a1..4ae2b3ae 100644
--- a/src/main/java/org/apache/commons/jxpath/XMLDocumentContainer.java
+++ b/src/main/java/org/apache/commons/jxpath/XMLDocumentContainer.java
@@ -67,7 +67,7 @@ public class XMLDocumentContainer implements Container {
/**
* Constructs a new XMLDocumentContainer.
*
- * @param xmlURL a URL for an XML file. Use
getClass().getResource(resourceName) to load XML from a resource file.
+ * @param xmlURL A URL for an XML file. Use
getClass().getResource(resourceName) to load XML from a resource file.
*/
public XMLDocumentContainer(final URL xmlURL) {
this.xmlURL = xmlURL;
diff --git
a/src/main/java/org/apache/commons/jxpath/functions/ConstructorFunction.java
b/src/main/java/org/apache/commons/jxpath/functions/ConstructorFunction.java
index 7cebb891..49edaf18 100644
--- a/src/main/java/org/apache/commons/jxpath/functions/ConstructorFunction.java
+++ b/src/main/java/org/apache/commons/jxpath/functions/ConstructorFunction.java
@@ -36,7 +36,7 @@ public class ConstructorFunction implements Function {
/**
* Constructs a new ConstructorFunction.
*
- * @param constructor the constructor to call.
+ * @param constructor The constructor to call.
*/
public ConstructorFunction(final Constructor constructor) {
this.constructor = constructor;
diff --git a/src/main/java/org/apache/commons/jxpath/ri/EvalContext.java
b/src/main/java/org/apache/commons/jxpath/ri/EvalContext.java
index e28891e0..6e49e3d9 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/EvalContext.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/EvalContext.java
@@ -356,7 +356,7 @@ public abstract class EvalContext implements
ExpressionContext, Iterator {
/**
* Sort a list of pointers based on document order.
*
- * @param l the list to sort.
+ * @param l The list to sort.
*/
protected void sortPointers(final List l) {
switch (getDocumentOrder()) {
diff --git a/src/main/java/org/apache/commons/jxpath/ri/NamespaceResolver.java
b/src/main/java/org/apache/commons/jxpath/ri/NamespaceResolver.java
index ddba003d..66ab5060 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/NamespaceResolver.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/NamespaceResolver.java
@@ -119,7 +119,7 @@ public class NamespaceResolver implements Cloneable,
Serializable {
/**
* Gets the nearest prefix found that matches an externally-registered
namespace.
*
- * @param namespaceURI the ns URI to check.
+ * @param namespaceURI The ns URI to check.
* @return String prefix if found.
* @since JXPath 1.3
*/
@@ -155,7 +155,7 @@ public class NamespaceResolver implements Cloneable,
Serializable {
/**
* Gets the prefix associated with the specifed namespace URI.
*
- * @param namespaceURI the ns URI to check.
+ * @param namespaceURI The ns URI to check.
* @return String prefix
*/
public synchronized String getPrefix(final String namespaceURI) {
@@ -199,7 +199,7 @@ public class NamespaceResolver implements Cloneable,
Serializable {
/**
* Register a namespace for the expression context.
*
- * @param pointer the Pointer to set.
+ * @param pointer The Pointer to set.
*/
public synchronized void setNamespaceContextPointer(final NodePointer
pointer) {
this.pointer = pointer;
diff --git a/src/main/java/org/apache/commons/jxpath/ri/Parser.java
b/src/main/java/org/apache/commons/jxpath/ri/Parser.java
index d9761260..c2ef482b 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/Parser.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/Parser.java
@@ -63,7 +63,7 @@ public class Parser {
* Parses the XPath expression. Throws a JXPathException in case of a
syntax error.
*
* @param expression to parse
- * @param compiler the compiler
+ * @param compiler The compiler
* @return parsed Object
*/
public static Object parseExpression(final String expression, final
Compiler compiler) {
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/compiler/CoreOperationNegate.java
b/src/main/java/org/apache/commons/jxpath/ri/compiler/CoreOperationNegate.java
index 9abe9b87..5df1b50b 100644
---
a/src/main/java/org/apache/commons/jxpath/ri/compiler/CoreOperationNegate.java
+++
b/src/main/java/org/apache/commons/jxpath/ri/compiler/CoreOperationNegate.java
@@ -28,7 +28,7 @@ public class CoreOperationNegate extends CoreOperation {
/**
* Constructs a new CoreOperationNegate.
*
- * @param arg the Expression to negate
+ * @param arg The Expression to negate
*/
public CoreOperationNegate(final Expression arg) {
super(new Expression[] { arg });
diff --git a/src/main/java/org/apache/commons/jxpath/ri/compiler/Path.java
b/src/main/java/org/apache/commons/jxpath/ri/compiler/Path.java
index 948eb271..7e0eead1 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/compiler/Path.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/compiler/Path.java
@@ -56,7 +56,7 @@ public abstract class Path extends Expression {
/**
* Tests whether the elements of the specified array are "basic"
predicates.
*
- * @param predicates the Expression[] to check
+ * @param predicates The Expression[] to check
* @return boolean
*/
protected boolean areBasicPredicates(final Expression[] predicates) {
@@ -231,7 +231,7 @@ public abstract class Path extends Expression {
* A Step is "simple" if it takes one of these forms: ".", "/foo", "@bar",
"/foo[3]". If there are predicates, they should be context independent for the
* step to still be considered simple.
*
- * @param step the step to check
+ * @param step The step to check
* @return boolean
*/
protected boolean isSimpleStep(final Step step) {
diff --git a/src/main/java/org/apache/commons/jxpath/ri/model/NodeIterator.java
b/src/main/java/org/apache/commons/jxpath/ri/model/NodeIterator.java
index 65250470..1b65878c 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/NodeIterator.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/NodeIterator.java
@@ -39,7 +39,7 @@ public interface NodeIterator {
/**
* Sets the new current position.
*
- * @param position the position to set
+ * @param position The position to set
* @return {@code true} if there is a node at {@code position}.
*/
boolean setPosition(int position);
diff --git a/src/main/java/org/apache/commons/jxpath/ri/model/NodePointer.java
b/src/main/java/org/apache/commons/jxpath/ri/model/NodePointer.java
index e6e58819..f01020b5 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/NodePointer.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/NodePointer.java
@@ -220,7 +220,7 @@ public abstract class NodePointer implements Pointer {
* Returns a NodeIterator that iterates over all attributes of the current
node matching the supplied node name (could have a wildcard). May return null if
* the object does not support the attributes.
*
- * @param qname the attribute name to test
+ * @param qname The attribute name to test
* @return NodeIterator
*/
public NodeIterator attributeIterator(final QName qname) {
@@ -233,7 +233,7 @@ public abstract class NodePointer implements Pointer {
*
* @param test NodeTest to filter children
* @param reverse specified iteration direction
- * @param startWith the NodePointer to start with
+ * @param startWith The NodePointer to start with
* @return NodeIterator
*/
public NodeIterator childIterator(final NodeTest test, final boolean
reverse, final NodePointer startWith) {
@@ -337,8 +337,8 @@ public abstract class NodePointer implements Pointer {
/**
* Called to create a non-existing attribute
*
- * @param context the owning JXPathCOntext
- * @param qName the QName at which an attribute should be created
+ * @param context The owning JXPathCOntext
+ * @param qName The QName at which an attribute should be created
* @return created NodePointer
*/
public NodePointer createAttribute(final JXPathContext context, final
QName qName) {
@@ -349,8 +349,8 @@ public abstract class NodePointer implements Pointer {
* Called by a child pointer when it needs to create a parent object for a
non-existent collection element. It may have to expand the collection, then
* create an element object and return a new pointer describing the newly
created element.
*
- * @param context the owning JXPathCOntext
- * @param qName the QName at which a child should be created
+ * @param context The owning JXPathCOntext
+ * @param qName The QName at which a child should be created
* @param index child index.
* @return created NodePointer
*/
@@ -363,8 +363,8 @@ public abstract class NodePointer implements Pointer {
* Called by a child pointer if that child needs to assign the value
supplied in the createPath(context, value) call to a non-existent node. This
method may
* have to expand the collection in order to assign the element.
*
- * @param context the owning JXPathCOntext
- * @param qName the QName at which a child should be created
+ * @param context The owning JXPathCOntext
+ * @param qName The QName at which a child should be created
* @param index child index.
* @param value node value to set
* @return created NodePointer
@@ -378,7 +378,7 @@ public abstract class NodePointer implements Pointer {
* Called by a child pointer when it needs to create a parent object. Must
create an object described by this pointer and return a new pointer that
properly
* describes the new object.
*
- * @param context the owning JXPathContext
+ * @param context The owning JXPathContext
* @return created NodePointer
*/
public NodePointer createPath(final JXPathContext context) {
@@ -388,8 +388,8 @@ public abstract class NodePointer implements Pointer {
/**
* Called directly by JXPathContext. Must create path and set value.
*
- * @param context the owning JXPathContext
- * @param value the new value to set
+ * @param context The owning JXPathContext
+ * @param value The new value to set
* @return created NodePointer
*/
public NodePointer createPath(final JXPathContext context, final Object
value) {
@@ -735,7 +735,7 @@ public abstract class NodePointer implements Pointer {
/**
* Returns true if the supplied prefix represents the default namespace in
the context of the current node.
*
- * @param prefix the prefix to check
+ * @param prefix The prefix to check
* @return {@code true} if prefix is default
*/
protected boolean isDefaultNamespace(final String prefix) {
@@ -834,7 +834,7 @@ public abstract class NodePointer implements Pointer {
/**
* Sets the exceptionHandler of this NodePointer.
*
- * @param exceptionHandler the ExceptionHandler to set
+ * @param exceptionHandler The ExceptionHandler to set
*/
public void setExceptionHandler(final ExceptionHandler exceptionHandler) {
this.exceptionHandler = exceptionHandler;
@@ -861,7 +861,7 @@ public abstract class NodePointer implements Pointer {
/**
* Converts the value to the required type and changes the corresponding
object to that value.
*
- * @param value the value to set
+ * @param value The value to set
*/
@Override
public abstract void setValue(Object value);
@@ -869,7 +869,7 @@ public abstract class NodePointer implements Pointer {
/**
* Checks if this Pointer matches the supplied NodeTest.
*
- * @param test the NodeTest to execute
+ * @param test The NodeTest to execute
* @return true if a match
*/
public boolean testNode(final NodeTest test) {
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/VariablePointerFactory.java
b/src/main/java/org/apache/commons/jxpath/ri/model/VariablePointerFactory.java
index 12f6e87a..70540fcd 100644
---
a/src/main/java/org/apache/commons/jxpath/ri/model/VariablePointerFactory.java
+++
b/src/main/java/org/apache/commons/jxpath/ri/model/VariablePointerFactory.java
@@ -62,7 +62,7 @@ public class VariablePointerFactory implements
NodePointerFactory {
/**
* VariableContextWrapper factory method.
*
- * @param context the JXPathContext to wrap.
+ * @param context The JXPathContext to wrap.
* @return VariableContextWrapper.
*/
public static VariableContextWrapper contextWrapper(final JXPathContext
context) {
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/beans/PropertyOwnerPointer.java
b/src/main/java/org/apache/commons/jxpath/ri/model/beans/PropertyOwnerPointer.java
index c98331a2..caadb911 100644
---
a/src/main/java/org/apache/commons/jxpath/ri/model/beans/PropertyOwnerPointer.java
+++
b/src/main/java/org/apache/commons/jxpath/ri/model/beans/PropertyOwnerPointer.java
@@ -132,7 +132,7 @@ public abstract class PropertyOwnerPointer extends
NodePointer {
/**
* Tests whether {@code name} is a valid child name for this
PropertyOwnerPointer.
*
- * @param qName the QName to test
+ * @param qName The QName to test
* @return {@code true} if {@code QName} is a valid property name.
* @since JXPath 1.3
*/
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/dom/DOMNodePointer.java
b/src/main/java/org/apache/commons/jxpath/ri/model/dom/DOMNodePointer.java
index 8c2118f3..81938f33 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/dom/DOMNodePointer.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/dom/DOMNodePointer.java
@@ -145,7 +145,7 @@ public class DOMNodePointer extends NodePointer {
/**
* Gets any prefix from the specified node.
*
- * @param node the node to check
+ * @param node The node to check
* @return String xml prefix
*/
public static String getPrefix(final Node node) {
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNamespaceIterator.java
b/src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNamespaceIterator.java
index 318d147d..0aa31dd6 100644
---
a/src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNamespaceIterator.java
+++
b/src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNamespaceIterator.java
@@ -41,7 +41,7 @@ public class JDOMNamespaceIterator implements NodeIterator {
/**
* Constructs a new JDOMNamespaceIterator.
*
- * @param parent the parent NodePointer.
+ * @param parent The parent NodePointer.
*/
public JDOMNamespaceIterator(final NodePointer parent) {
this.parent = parent;
@@ -59,7 +59,7 @@ public class JDOMNamespaceIterator implements NodeIterator {
/**
* Collect the namespaces from a JDOM Element.
*
- * @param element the source Element
+ * @param element The source Element
*/
private void collectNamespaces(final Element element) {
Namespace ns = element.getNamespace();
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/parser/TokenMgrError.java
b/src/main/java/org/apache/commons/jxpath/ri/parser/TokenMgrError.java
index 81af1228..d22afa4e 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/parser/TokenMgrError.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/parser/TokenMgrError.java
@@ -111,7 +111,7 @@ public class TokenMgrError extends Error {
* @param errorLine line number when the error occurred
* @param errorColumn column number when the error occurred
* @param errorAfter prefix that was seen before this error occurred
- * @param curChar the offending character
+ * @param curChar The offending character
* @return TODO
*/
protected static String LexicalError(final boolean EOFSeen, final int
lexState, final int errorLine, final int errorColumn, final String errorAfter,
diff --git a/src/main/java/org/apache/commons/jxpath/util/ClassLoaderUtil.java
b/src/main/java/org/apache/commons/jxpath/util/ClassLoaderUtil.java
index e559322b..b20b848a 100644
--- a/src/main/java/org/apache/commons/jxpath/util/ClassLoaderUtil.java
+++ b/src/main/java/org/apache/commons/jxpath/util/ClassLoaderUtil.java
@@ -66,8 +66,8 @@ public final class ClassLoaderUtil {
* well as "{@code [Ljava.lang.String;}".
*
* @param <T> The expected class type.
- * @param classLoader the class loader to use to load the class
- * @param className the class name
+ * @param classLoader The class loader to use to load the class
+ * @param className The class name
* @param initialize whether the class must be initialized
* @return The class represented by {@code className} using the {@code
classLoader}
* @throws ClassNotFoundException if the class is not found
@@ -89,7 +89,7 @@ public final class ClassLoaderUtil {
* "{@code java.lang.String[]}" as well as "{@code [Ljava.lang.String;}".
*
* @param <T> The expected class type.
- * @param className the class name
+ * @param className The class name
* @param initialize whether the class must be initialized
* @return The class represented by {@code className} using the current
thread's context class loader
* @throws ClassNotFoundException if the class is not found
@@ -110,7 +110,7 @@ public final class ClassLoaderUtil {
/**
* Converts a class name to a JLS style class name.
*
- * @param className the class name
+ * @param className The class name
* @return The converted name
*/
private static String toCanonicalName(String className) {
diff --git
a/src/main/java/org/apache/commons/jxpath/util/MethodLookupUtils.java
b/src/main/java/org/apache/commons/jxpath/util/MethodLookupUtils.java
index c14159a6..f617afee 100644
--- a/src/main/java/org/apache/commons/jxpath/util/MethodLookupUtils.java
+++ b/src/main/java/org/apache/commons/jxpath/util/MethodLookupUtils.java
@@ -37,7 +37,7 @@ public class MethodLookupUtils {
/**
* Look up a constructor.
*
- * @param targetClass the class constructed
+ * @param targetClass The class constructed
* @param parameters arguments
* @return Constructor found if any.
*/
@@ -157,7 +157,7 @@ public class MethodLookupUtils {
/**
* Look up a static method.
*
- * @param targetClass the owning class
+ * @param targetClass The owning class
* @param name method name
* @param parameters method parameters
* @return Method found if any
diff --git
a/src/test/java/org/apache/commons/jxpath/util/ClassLoaderUtilTest.java
b/src/test/java/org/apache/commons/jxpath/util/ClassLoaderUtilTest.java
index 220e2a0f..c05186f9 100644
--- a/src/test/java/org/apache/commons/jxpath/util/ClassLoaderUtilTest.java
+++ b/src/test/java/org/apache/commons/jxpath/util/ClassLoaderUtilTest.java
@@ -103,8 +103,8 @@ public class ClassLoaderUtilTest {
/**
* Loads this class through the given class loader and then invokes the
indicated no argument static method of the class.
*
- * @param cl the class loader under which to invoke the method.
- * @param methodName the name of the static no argument method on this
class to invoke.
+ * @param cl The class loader under which to invoke the method.
+ * @param methodName The name of the static no argument method on this
class to invoke.
* @throws ReflectiveOperationException on test failures.
*/
private void executeTestMethodUnderClassLoader(final ClassLoader cl, final
String methodName) throws ReflectiveOperationException {
