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 f4b66bba Javadoc
f4b66bba is described below
commit f4b66bbade5834b62c9e91f07cdb3724f1c60174
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:51:05 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/jxpath/BasicVariables.java | 2 +-
src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java | 2 +-
src/main/java/org/apache/commons/jxpath/JXPathContext.java | 2 +-
src/main/java/org/apache/commons/jxpath/ri/axes/RootContext.java | 2 +-
src/main/java/org/apache/commons/jxpath/ri/model/NodePointer.java | 4 ++--
.../java/org/apache/commons/jxpath/ri/parser/SimpleCharStream.java | 4 ++--
src/main/java/org/apache/commons/jxpath/util/ClassLoaderUtil.java | 6 +++---
src/main/java/org/apache/commons/jxpath/util/TypeUtils.java | 2 +-
src/main/java/org/apache/commons/jxpath/util/ValueUtils.java | 2 +-
9 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/main/java/org/apache/commons/jxpath/BasicVariables.java
b/src/main/java/org/apache/commons/jxpath/BasicVariables.java
index c3c8e87a..66ed985a 100644
--- a/src/main/java/org/apache/commons/jxpath/BasicVariables.java
+++ b/src/main/java/org/apache/commons/jxpath/BasicVariables.java
@@ -53,7 +53,7 @@ public class BasicVariables implements Variables {
* Returns the value of the variable if it is defined, otherwise, throws
IllegalArgumentException
*
* @param varName is a variable name without the "$" sign
- * @return the value of the variable
+ * @return The value of the variable
*/
@Override
public Object getVariable(final String varName) {
diff --git a/src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java
b/src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java
index 86fbdb56..500e6fc2 100644
--- a/src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java
+++ b/src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java
@@ -97,7 +97,7 @@ public class JXPathBasicBeanInfo implements JXPathBeanInfo {
/**
* Gets the DynamicPropertyHandler class for a dynamic class.
*
- * @return the DynamicPropertyHandler class for a dynamic class.
+ * @return The DynamicPropertyHandler class for a dynamic class.
*/
@Override
public Class getDynamicPropertyHandlerClass() {
diff --git a/src/main/java/org/apache/commons/jxpath/JXPathContext.java
b/src/main/java/org/apache/commons/jxpath/JXPathContext.java
index 68495a7f..e4c208fb 100644
--- a/src/main/java/org/apache/commons/jxpath/JXPathContext.java
+++ b/src/main/java/org/apache/commons/jxpath/JXPathContext.java
@@ -848,7 +848,7 @@ public abstract class JXPathContext {
* its textual contents.
*
* @param xpath the xpath to be evaluated
- * @return the found object
+ * @return The found object
*/
public Object selectSingleNode(final String xpath) {
final Pointer pointer = getPointer(xpath);
diff --git a/src/main/java/org/apache/commons/jxpath/ri/axes/RootContext.java
b/src/main/java/org/apache/commons/jxpath/ri/axes/RootContext.java
index 9aa6c1cd..7c2a9c11 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/axes/RootContext.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/axes/RootContext.java
@@ -162,7 +162,7 @@ public class RootContext extends EvalContext {
* Sets the next registered value.
*
* @param value Object
- * @return the id that can reclaim value.
+ * @return The id that can reclaim value.
*/
public int setRegisteredValue(final Object value) {
if (registers == null) {
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 3a80f287..e6e58819 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
@@ -493,7 +493,7 @@ public abstract class NodePointer implements Pointer {
* If the pointer represents a collection, the index identifies an element
of that collection. The default value of {@code index} is
* {@code WHOLE_COLLECTION}, which just means that the pointer is not
indexed at all. Note: the index on NodePointer starts with 0, not 1.
*
- * @return the index.
+ * @return The index.
*/
public int getIndex() {
return index;
@@ -502,7 +502,7 @@ public abstract class NodePointer implements Pointer {
/**
* If the pointer represents a collection (or collection element), returns
the length of the collection. Otherwise returns 1 (even if the value is null).
*
- * @return the length.
+ * @return The length.
*/
public abstract int getLength();
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/parser/SimpleCharStream.java
b/src/main/java/org/apache/commons/jxpath/ri/parser/SimpleCharStream.java
index 60e6fdc1..09d755a5 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/parser/SimpleCharStream.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/parser/SimpleCharStream.java
@@ -205,7 +205,7 @@ public class SimpleCharStream {
}
/**
- * @return the end column.
+ * @return The end column.
* @see #getEndColumn
* @deprecated
*/
@@ -230,7 +230,7 @@ public class SimpleCharStream {
}
/**
- * @return the line number.
+ * @return The line number.
* @see #getEndLine
* @deprecated
*/
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 39e9e797..e559322b 100644
--- a/src/main/java/org/apache/commons/jxpath/util/ClassLoaderUtil.java
+++ b/src/main/java/org/apache/commons/jxpath/util/ClassLoaderUtil.java
@@ -69,7 +69,7 @@ public final class ClassLoaderUtil {
* @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}
+ * @return The class represented by {@code className} using the {@code
classLoader}
* @throws ClassNotFoundException if the class is not found
*/
@SuppressWarnings("unchecked") // assume the call site knows what it's
doing.
@@ -91,7 +91,7 @@ public final class ClassLoaderUtil {
* @param <T> The expected class type.
* @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
+ * @return The class represented by {@code className} using the current
thread's context class loader
* @throws ClassNotFoundException if the class is not found
*/
public static <T> Class<T> getClass(final String className, final boolean
initialize) throws ClassNotFoundException {
@@ -111,7 +111,7 @@ public final class ClassLoaderUtil {
* Converts a class name to a JLS style class name.
*
* @param className the class name
- * @return the converted name
+ * @return The converted name
*/
private static String toCanonicalName(String className) {
Objects.requireNonNull(className, "className");
diff --git a/src/main/java/org/apache/commons/jxpath/util/TypeUtils.java
b/src/main/java/org/apache/commons/jxpath/util/TypeUtils.java
index fd7e1a4e..5231607a 100644
--- a/src/main/java/org/apache/commons/jxpath/util/TypeUtils.java
+++ b/src/main/java/org/apache/commons/jxpath/util/TypeUtils.java
@@ -81,7 +81,7 @@ public class TypeUtils {
* Return the appropriate wrapper type for the specified class.
*
* @param p Class for which to retrieve a wrapper class.
- * @return the wrapper if {@code p} is primitive, else {@code p}.
+ * @return The wrapper if {@code p} is primitive, else {@code p}.
* @since JXPath 1.3
*/
public static Class wrapPrimitive(final Class p) {
diff --git a/src/main/java/org/apache/commons/jxpath/util/ValueUtils.java
b/src/main/java/org/apache/commons/jxpath/util/ValueUtils.java
index e498da7d..49dbd2a9 100644
--- a/src/main/java/org/apache/commons/jxpath/util/ValueUtils.java
+++ b/src/main/java/org/apache/commons/jxpath/util/ValueUtils.java
@@ -407,7 +407,7 @@ public class ValueUtils {
*
* @param collection to edit
* @param index int
- * @return the resulting collection
+ * @return The resulting collection
*/
public static Object remove(Object collection, final int index) {
collection = getValue(collection);