This is an automated email from the ASF dual-hosted git repository.
ggregory 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 541a1960 Use a code comment, not Javadoc inside a method
541a1960 is described below
commit 541a1960e2d9e6893009eedb4ca74d79ef38d023
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jan 4 15:06:00 2026 -0500
Use a code comment, not Javadoc inside a method
---
src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java | 1 +
src/main/java/org/apache/commons/jxpath/JXPathContext.java | 7 +++++++
src/main/java/org/apache/commons/jxpath/ri/EvalContext.java | 2 ++
.../java/org/apache/commons/jxpath/ri/compiler/CoreOperation.java | 7 +++++++
.../java/org/apache/commons/jxpath/ri/compiler/Expression.java | 3 ++-
src/main/java/org/apache/commons/jxpath/ri/model/NodePointer.java | 2 ++
.../org/apache/commons/jxpath/ri/model/beans/PropertyPointer.java | 1 +
.../org/apache/commons/jxpath/ri/model/dom/DOMNodePointer.java | 2 ++
.../org/apache/commons/jxpath/ri/model/jdom/JDOMNodePointer.java | 2 ++
.../java/org/apache/commons/jxpath/ri/parser/ParseException.java | 5 +++++
src/main/java/org/apache/commons/jxpath/ri/parser/Token.java | 4 ++++
.../java/org/apache/commons/jxpath/ri/parser/TokenMgrError.java | 4 ++++
src/main/java/org/apache/commons/jxpath/servlet/Constants.java | 4 ++++
.../java/org/apache/commons/jxpath/util/ReverseComparator.java | 1 +
src/main/java/org/apache/commons/jxpath/xml/DocumentContainer.java | 1 +
src/test/java/org/apache/commons/jxpath/BasicNodeSetTest.java | 1 +
src/test/java/org/apache/commons/jxpath/TestBean.java | 6 ++++++
.../java/org/apache/commons/jxpath/ri/model/MixedModelTest.java | 1 +
18 files changed, 53 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java
b/src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java
index 0c6e0af7..86fbdb56 100644
--- a/src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java
+++ b/src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java
@@ -36,6 +36,7 @@ public class JXPathBasicBeanInfo implements JXPathBeanInfo {
private static final long serialVersionUID = -3863803443111484155L;
private static final Comparator<PropertyDescriptor>
PROPERTY_DESCRIPTOR_COMPARATOR =
Comparator.comparing(PropertyDescriptor::getName);
+
/**
* Whether objects of this class are treated as atomic objects which have
no properties of their own.
*/
diff --git a/src/main/java/org/apache/commons/jxpath/JXPathContext.java
b/src/main/java/org/apache/commons/jxpath/JXPathContext.java
index c4d20174..4823698b 100644
--- a/src/main/java/org/apache/commons/jxpath/JXPathContext.java
+++ b/src/main/java/org/apache/commons/jxpath/JXPathContext.java
@@ -460,18 +460,25 @@ public abstract class JXPathContext {
/** Parent context */
protected JXPathContext parentContext;
+
/** Context bean */
protected Object contextBean;
+
/** Variables */
protected Variables vars;
+
/** Functions */
protected Functions functions;
+
/** AbstractFactory */
protected AbstractFactory factory;
+
/** IdentityManager */
protected IdentityManager idManager;
+
/** KeyManager */
protected KeyManager keyManager;
+
/** Decimal format map */
protected HashMap<String, DecimalFormatSymbols> decimalFormats;
private Locale locale;
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 5ddaf32c..e28891e0 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/EvalContext.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/EvalContext.java
@@ -44,8 +44,10 @@ public abstract class EvalContext implements
ExpressionContext, Iterator {
/** Parent context */
protected EvalContext parentContext;
+
/** Root context */
protected RootContext rootContext;
+
/** Position */
protected int position;
private boolean startedSetIteration;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/compiler/CoreOperation.java
b/src/main/java/org/apache/commons/jxpath/ri/compiler/CoreOperation.java
index df0ae3cc..137c2242 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/compiler/CoreOperation.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/compiler/CoreOperation.java
@@ -26,18 +26,25 @@ public abstract class CoreOperation extends Operation {
/** Or precedence */
protected static final int OR_PRECEDENCE = 0;
+
/** And precedence */
protected static final int AND_PRECEDENCE = 1;
+
/** Compare precedence */
protected static final int COMPARE_PRECEDENCE = 2;
+
/** Relational expression precedence */
protected static final int RELATIONAL_EXPR_PRECEDENCE = 3;
+
/** Add/subtract precedence */
protected static final int ADD_PRECEDENCE = 4;
+
/** Multiply/divide/mod precedence */
protected static final int MULTIPLY_PRECEDENCE = 5;
+
/** Negate precedence */
protected static final int NEGATE_PRECEDENCE = 6;
+
/** Union precedence */
protected static final int UNION_PRECEDENCE = 7;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/compiler/Expression.java
b/src/main/java/org/apache/commons/jxpath/ri/compiler/Expression.java
index 256987f4..0b0aaffa 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/compiler/Expression.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/compiler/Expression.java
@@ -43,7 +43,6 @@ public abstract class Expression {
private final QName qname;
private final Locale locale;
- // to what method does the following comment refer?
/**
* Constructs a new PointerIterator
*
@@ -117,8 +116,10 @@ public abstract class Expression {
/** Zero */
protected static final Double ZERO = Double.valueOf(0);
+
/** One */
protected static final Double ONE = Double.valueOf(1);
+
/** NaN */
protected static final Double NOT_A_NUMBER = Double.valueOf(Double.NaN);
private boolean contextDependencyKnown;
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 60ac779e..3a80f287 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
@@ -44,8 +44,10 @@ public abstract class NodePointer implements Pointer {
/** Serialization version */
private static final long serialVersionUID = 8117201322861007777L;
+
/** Whole collection index. */
public static final int WHOLE_COLLECTION = Integer.MIN_VALUE;
+
/** Constant to indicate unknown namespace */
public static final String UNKNOWN_NAMESPACE = "<<unknown namespace>>";
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/beans/PropertyPointer.java
b/src/main/java/org/apache/commons/jxpath/ri/model/beans/PropertyPointer.java
index 114e51a5..5d689de7 100644
---
a/src/main/java/org/apache/commons/jxpath/ri/model/beans/PropertyPointer.java
+++
b/src/main/java/org/apache/commons/jxpath/ri/model/beans/PropertyPointer.java
@@ -31,6 +31,7 @@ import org.apache.commons.jxpath.util.ValueUtils;
public abstract class PropertyPointer extends NodePointer {
private static final long serialVersionUID = 1L;
+
/**
* Marks a property as unspecified.
*/
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 43375e25..8c2118f3 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
@@ -52,8 +52,10 @@ import org.w3c.dom.ProcessingInstruction;
public class DOMNodePointer extends NodePointer {
private static final long serialVersionUID = -8751046933894857319L;
+
/** XML namespace URI */
public static final String XML_NAMESPACE_URI =
"http://www.w3.org/XML/1998/namespace";;
+
/** XMLNS namespace URI */
public static final String XMLNS_NAMESPACE_URI =
"http://www.w3.org/2000/xmlns/";;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNodePointer.java
b/src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNodePointer.java
index 96e7d117..d85f8b7d 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNodePointer.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNodePointer.java
@@ -48,8 +48,10 @@ import org.jdom.Text;
public class JDOMNodePointer extends NodePointer {
private static final long serialVersionUID = -6346532297491082651L;
+
/** XML ns uri */
public static final String XML_NAMESPACE_URI =
"http://www.w3.org/XML/1998/namespace";;
+
/** XMLNS ns uri */
public static final String XMLNS_NAMESPACE_URI =
"http://www.w3.org/2000/xmlns/";;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/parser/ParseException.java
b/src/main/java/org/apache/commons/jxpath/ri/parser/ParseException.java
index 9c534493..981b4cdb 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/parser/ParseException.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/parser/ParseException.java
@@ -32,25 +32,30 @@ public class ParseException extends Exception {
*
*/
private static final long serialVersionUID = 1L;
+
/**
* This variable determines which constructor was used to create this
object and thereby affects the semantics of the "getMessage" method (see below).
*/
protected boolean specialConstructor;
+
/**
* This is the last token that has been consumed successfully. If this
object has been created due to a parse error, the token followng this token will
* (therefore) be the first error token.
*/
public Token currentToken;
+
/**
* Each entry in this array is an array of integers. Each array of
integers represents a sequence of tokens (by their ordinal values) that is
expected at
* this point of the parse.
*/
public int[][] expectedTokenSequences;
+
/**
* This is a reference to the "tokenImage" array of the generated parser
within which the parse error occurred. This array is defined in the generated
* ...Constants interface.
*/
public String[] tokenImage;
+
/**
* The end of line string for this machine.
*/
diff --git a/src/main/java/org/apache/commons/jxpath/ri/parser/Token.java
b/src/main/java/org/apache/commons/jxpath/ri/parser/Token.java
index 9a2deec5..622f3a74 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/parser/Token.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/parser/Token.java
@@ -49,21 +49,25 @@ public class Token {
* ...Constants.java.
*/
public int kind;
+
/**
* beginLine and beginColumn describe the position of the first character
of this token; endLine and endColumn describe the position of the last character
* of this token.
*/
public int beginLine, beginColumn, endLine, endColumn;
+
/**
* The string image of the token.
*/
public String image;
+
/**
* A reference to the next regular (non-special) token from the input
stream. If this is the last token from the input stream, or if the token
manager has
* not read tokens beyond this one, this field is set to null. This is
true only if this token is also a regular token. Otherwise, see below for a
* description of the contents of this field.
*/
public Token next;
+
/**
* This field is used to access special tokens that occur prior to this
token, but after the immediately preceding regular (non-special) token. If
there are
* no such special tokens, this field is set to null. When there are more
than one such special token, this field refers to the last of these special
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 30d3addb..81af1228 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
@@ -30,18 +30,22 @@ public class TokenMgrError extends Error {
*
*/
private static final long serialVersionUID = 1L;
+
/**
* Lexical error occurred.
*/
static final int LEXICAL_ERROR = 0;
+
/**
* An attempt wass made to create a second instance of a static token
manager.
*/
static final int STATIC_LEXER_ERROR = 1;
+
/**
* Tried to change to an invalid lexical state.
*/
static final int INVALID_LEXICAL_STATE = 2;
+
/**
* Detected (and bailed out of) an infinite loop in the token manager.
*/
diff --git a/src/main/java/org/apache/commons/jxpath/servlet/Constants.java
b/src/main/java/org/apache/commons/jxpath/servlet/Constants.java
index 126fbc7d..9541f673 100644
--- a/src/main/java/org/apache/commons/jxpath/servlet/Constants.java
+++ b/src/main/java/org/apache/commons/jxpath/servlet/Constants.java
@@ -26,18 +26,22 @@ public final class Constants {
* Variable name for {@link javax.servlet.ServletContext}.
*/
public static final String APPLICATION_SCOPE = "application";
+
/**
* Variable name for {@link javax.servlet.http.HttpSession}.
*/
public static final String SESSION_SCOPE = "session";
+
/**
* Variable name for {@link javax.servlet.ServletRequest}.
*/
public static final String REQUEST_SCOPE = "request";
+
/**
* Variable name for {@link javax.servlet.jsp.PageContext}.
*/
public static final String PAGE_SCOPE = "page";
+
/**
* Attribute name used in page context, requst, session, and servlet
context to store the corresponding {@link
org.apache.commons.jxpath.JXPathContext}.
*/
diff --git
a/src/main/java/org/apache/commons/jxpath/util/ReverseComparator.java
b/src/main/java/org/apache/commons/jxpath/util/ReverseComparator.java
index 9b70b03e..ac3a1bf8 100644
--- a/src/main/java/org/apache/commons/jxpath/util/ReverseComparator.java
+++ b/src/main/java/org/apache/commons/jxpath/util/ReverseComparator.java
@@ -26,6 +26,7 @@ import java.util.Comparator;
public final class ReverseComparator implements Comparator, Serializable {
private static final long serialVersionUID = -2795475743948616649L;
+
/**
* Singleton reverse comparator instance.
*/
diff --git a/src/main/java/org/apache/commons/jxpath/xml/DocumentContainer.java
b/src/main/java/org/apache/commons/jxpath/xml/DocumentContainer.java
index d87fa62a..0832de07 100644
--- a/src/main/java/org/apache/commons/jxpath/xml/DocumentContainer.java
+++ b/src/main/java/org/apache/commons/jxpath/xml/DocumentContainer.java
@@ -35,6 +35,7 @@ public class DocumentContainer extends XMLParser2 implements
Container {
/** DOM constant */
public static final String MODEL_DOM = "DOM";
+
/** JDOM constant */
public static final String MODEL_JDOM = "JDOM";
private static final long serialVersionUID = -8713290334113427066L;
diff --git a/src/test/java/org/apache/commons/jxpath/BasicNodeSetTest.java
b/src/test/java/org/apache/commons/jxpath/BasicNodeSetTest.java
index 88ec65f8..bedb39b7 100644
--- a/src/test/java/org/apache/commons/jxpath/BasicNodeSetTest.java
+++ b/src/test/java/org/apache/commons/jxpath/BasicNodeSetTest.java
@@ -33,6 +33,7 @@ class BasicNodeSetTest extends AbstractJXPathTest {
/** JXPathContext */
protected JXPathContext context;
+
/** BasicNodeSet */
protected BasicNodeSet nodeSet;
diff --git a/src/test/java/org/apache/commons/jxpath/TestBean.java
b/src/test/java/org/apache/commons/jxpath/TestBean.java
index 66823e3e..18161c6a 100644
--- a/src/test/java/org/apache/commons/jxpath/TestBean.java
+++ b/src/test/java/org/apache/commons/jxpath/TestBean.java
@@ -41,19 +41,23 @@ public class TestBean {
beans[1] = new NestedTestBean("Name 2");
beans[1].setInt(3);
}
+
/**
* A boolean property.
*/
private boolean bool = false;
private int integer = 1;
+
/**
* A read-only array of integers
*/
private int[] array = { 1, 2, 3, 4 };
+
/**
* A heterogeneous list: String, Integer, NestedTestBean
*/
private ArrayList list;
+
/**
* A Map
*/
@@ -63,11 +67,13 @@ public class TestBean {
map.put("Key1", "Value 1");
map.put("Key2", new NestedTestBean("Name 6"));
}
+
/**
* A nested read-only java bean
*/
private NestedTestBean nestedBean = new NestedTestBean("Name 0");
private final NestedTestBean object = new NestedTestBean("Name 5");
+
/**
* A heterogeneous set: String, Integer, NestedTestBean
*/
diff --git
a/src/test/java/org/apache/commons/jxpath/ri/model/MixedModelTest.java
b/src/test/java/org/apache/commons/jxpath/ri/model/MixedModelTest.java
index 3e442b07..21e8ab9a 100644
--- a/src/test/java/org/apache/commons/jxpath/ri/model/MixedModelTest.java
+++ b/src/test/java/org/apache/commons/jxpath/ri/model/MixedModelTest.java
@@ -232,6 +232,7 @@ class MixedModelTest extends AbstractJXPathTest {
@Test
void testListList() {
+
/**
* @todo: what is this supposed to do? Should we stick to XPath, in
which case [1] is simply ignored, or Java, in which case it is supposed to
extract
* the first element from the list?
