Prepare for the next release candidate

Author: garydgregory

CONTRIBUTING.md

@@ -6,7 +6,7 @@
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at
 
-      http://www.apache.org/licenses/LICENSE-2.0
+      https://www.apache.org/licenses/LICENSE-2.0
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
@@ -41,37 +41,40 @@
 Contributing to Apache Commons JXPath
 ======================
 
-You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to
-the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
-follow so that we can have a chance of keeping on top of things.
+Have you found a bug or have an idea for a cool new feature? Contributing code is a great way to give something back to the open-source community.
+Before you dig right into the code, we need contributors to follow a few guidelines to have a chance of keeping on top of things.
 
 Getting Started
 ---------------
 
 + Make sure you have a [JIRA account](https://issues.apache.org/jira/).
-+ Make sure you have a [GitHub account](https://github.com/signup/free).
++ Make sure you have a [GitHub account](https://github.com/signup/free). This is not essential, but makes providing patches much easier.
 + If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons JXPath's scope.
 + Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
   + Clearly describe the issue including steps to reproduce when it is a bug.
   + Make sure you fill in the earliest version that you know has the issue.
 + Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-),
-[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository.
+[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. If you don't have a GitHub account, you can still clone the Commons repository.
 
 Making Changes
 --------------
 
 + Create a _topic branch_ for your isolated work.
   * Usually you should base your branch from the `master` branch.
-  * A good topic branch name can be the JIRA bug id plus a keyword, for example, `JXPATH-123-InputStream`.
+  * A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `JXPATH-123-InputStream`.
   * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
 + Make commits of logical units.
   * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
-  * For example, `[JXPATH-123] Close input stream earlier`
+  * For example, `[JXPATH-123] Close input stream sooner`
 + Respect the original code style:
   + Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing.
   + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first.
-+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
-+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
++ Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible but is a best-practice.
+Unit tests are typically in the `src/test/java` directory.
++ Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself.
++ Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
++ Each commit in the pull request should have a meaningful subject line and body. Note that commits might be squashed by a maintainer on merge.
+
 
 Making Trivial Changes
 ----------------------
@@ -103,12 +106,11 @@ Additional Resources
 --------------------
 
 + [Contributing patches](https://commons.apache.org/patches.html)
-+ [Apache Commons JXpath JIRA project page][jira]
++ [Apache Commons JXPath JIRA project page][jira]
 + [Contributor License Agreement][cla]
 + [General GitHub documentation](https://help.github.com/)
 + [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/)
 + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.net`
 
 [cla]:https://www.apache.org/licenses/#clas
 [jira]:https://issues.apache.org/jira/browse/JXPATH

NOTICE.txt

@@ -2,4 +2,4 @@ Apache Commons JXPath
 Copyright 2001-2025 The Apache Software Foundation
 
 This product includes software developed at
-The Apache Software Foundation (http://www.apache.org/).
+The Apache Software Foundation (https://www.apache.org/).

README.md

@@ -6,7 +6,7 @@
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at
 
-      http://www.apache.org/licenses/LICENSE-2.0
+      https://www.apache.org/licenses/LICENSE-2.0
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
@@ -25,7 +25,7 @@
  | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
  +======================================================================+
  |                                                                      |
- | 1) Re-generate using: mvn commons:readme-md                          |
+ | 1) Re-generate using: mvn commons-build:readme-md                    |
  |                                                                      |
  | 2) Set the following properties in the component's pom:              |
  |    - commons.componentid (required, alphabetic, lower case)          |
@@ -45,18 +45,21 @@ Apache Commons JXPath
 
 [![Java CI](https://github.com/apache/commons-jxpath/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-jxpath/actions/workflows/maven.yml)
 [![Maven Central](https://img.shields.io/maven-central/v/commons-jxpath/commons-jxpath?label=Maven%20Central)](https://search.maven.org/artifact/commons-jxpath/commons-jxpath)
+[![Javadocs](https://javadoc.io/badge/commons-jxpath/commons-jxpath/1.4.0.svg)](https://javadoc.io/doc/commons-jxpath/commons-jxpath/1.4.0)
+[![CodeQL](https://github.com/apache/commons-jxpath/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-jxpath/actions/workflows/codeql-analysis.yml)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-jxpath/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-jxpath)
 
 A Java-based implementation of XPath 1.0 that, in addition to XML processing, can inspect/modify Java object graphs (the library's explicit purpose) and even mixed Java/XML structures.
 
 Documentation
 -------------
 
 More information can be found on the [Apache Commons JXPath homepage](https://commons.apache.org/proper/commons-jxpath).
-The [Javadoc](https://commons.apache.org/proper/commons-jxpath/javadocs/api-release) can be browsed.
+The [Javadoc](https://commons.apache.org/proper/commons-jxpath/apidocs) can be browsed.
 Questions related to the usage of Apache Commons JXPath should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html).
 
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
 You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-jxpath/download_jxpath.cgi).
 
 Alternatively, you can pull it from the central Maven repositories:
@@ -65,39 +68,52 @@ Alternatively, you can pull it from the central Maven repositories:
 <dependency>
   <groupId>commons-jxpath</groupId>
   <artifactId>commons-jxpath</artifactId>
-  <version>1.3</version>
+  <version>1.4.0</version>
 </dependency>
 ```
 
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
+
 Contributing
 ------------
 
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
 There are some guidelines which will make applying PRs easier for us:
 + No tabs! Please use spaces for indentation.
-+ Respect the code style.
++ Respect the existing code style for each file.
 + Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
-+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
++ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
++ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`
 
 If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
 You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
 
 License
 -------
-This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
 
 See the `NOTICE.txt` file for required notices and attributions.
 
-Donations
----------
-You like Apache Commons JXPath? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+Donating
+--------
+You like Apache Commons JXPath? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.
 
 Additional Resources
 --------------------
 
 + [Apache Commons Homepage](https://commons.apache.org/)
 + [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/JXPATH)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
 + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
 
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)

RELEASE-NOTES.txt

@@ -0,0 +1,112 @@
+Apache Commons JXPath 1.4.0 Release Notes
+-----------------------------------------
+
+The Apache Commons JXPath team is pleased to announce the release of Apache Commons JXPath 1.4.0.
+
+Introduction
+------------
+
+A Java-based implementation of XPath 1.0 that, in addition to XML processing, can inspect/modify Java object graphs (the library's explicit purpose) and even mixed Java/XML structures.
+
+New features and bug fixes.
+
+New features
+------------
+
+o JXPATH-123:  XPath function "ends-with" is not implemented (although "starts-with" is). 
+
+Fixed Bugs
+----------
+
+o JXPATH-172:  Clarify Javadoc of JXPathContext#getPointer. Thanks to Michele Vivoda. 
+o JXPATH-113:  NullPointerException in ChildContext when document only contains an empty root node. Thanks to Michele Vivoda. 
+o JXPATH-160:  ValueUtils.getValue throws exception with set and index above size. Thanks to Stefan Albrecht, Michele Vivoda, Uwe Barthel. 
+o JXPATH-162:  Concurrency problem for JXPathContextFactory.factoryImplName static field. Thanks to Uwe Barthel. 
+o JXPATH-141:  FunctionLibrary Multithreading issue. 
+o JXPATH-131:  Bean exception handling. Thanks to Gabriel Buades Rubio. 
+o JXPATH-128:  JXPath support for LazyDynaBean is broken. Thanks to Gabriel Buades Rubio. 
+o JXPATH-129:  MethodLookupUtils#matchType uses TypeUtils#canConvert which causes "Ambiguous method call" exception. 
+o JXPATH-153:  Wrong entry IMPORT-PACKAGE in the file MANIFEST.MF for jdom and commons-beanutils. 
+o JXPATH-153:  Change dynamic class loading to consult context class loader. Thanks to John Trimble. 
+o JXPATH-152:  Concurrent access on hashmap of JXPathIntrospector. 
+o          Fix possible NPE in PackageFunctions.getFunction(String, String, Object[]). 
+o          JDOMNodePointer.compareChildNodePointers() now throws IllegalStateException instead of RuntimeException. Thanks to Gary Gregory. 
+o          ValueUtils.setValue() now throws IllegalArgumentException instead of RuntimeException. Thanks to Gary Gregory. 
+o          ClassLoaderUtil.toCanonicalName() now calls Objects.requireNonNull() instead of throwing a RuntimeException. Thanks to Gary Gregory. 
+o          XMLDocumentContainer.XMLDocumentContainer(Source) now calls Objects.requireNonNull() instead of throwing a RuntimeException. Thanks to Gary Gregory. 
+o          [StepSecurity] CI: Harden GitHub Actions #66. Thanks to step-security-bot, Gary Gregory. 
+o          Add missing Javadoc. Thanks to Gary Gregory. 
+o          Fix PMD UnnecessaryFullyQualifiedName. Thanks to Gary Gregory. 
+o          Add generics to JXPathContext.iterate(String). Thanks to Gary Gregory. 
+o          Add generics to JXPathContext.iteratePointers(String). Thanks to Gary Gregory. 
+o          Add generics to JXPathContext.decimalFormats. Thanks to Gary Gregory. 
+o          Migrate tests to JUnit5 #214. Thanks to strangelookingnerd. 
+o          Replace try-catch constructs in tests with assertThrows #215. Thanks to strangelookingnerd, Gary Gregory. 
+o          Use generics internally. Thanks to Gary Gregory. 
+o          NodeSet.getPointers() is now typed with generics. Thanks to Gary Gregory. 
+o          ServletContextHandler.collectPropertyNames(HashSet, Object) is now typed with generics. Thanks to Gary Gregory. 
+o          Deprecate ClassLoaderUtil.ClassLoaderUtil(). Thanks to Gary Gregory. 
+o          Deprecate MethodLookupUtils.MethodLookupUtils(). Thanks to Gary Gregory. 
+o          Deprecate KeyManagerUtils.KeyManagerUtils(). Thanks to Gary Gregory. 
+o          Deprecate TypeUtils.TypeUtils(). Thanks to Gary Gregory. 
+o          Deprecate ValueUtils.ValueUtils(). Thanks to Gary Gregory. 
+o          PageScopeContext.getAttributeNames() is now typed with generics. Thanks to Gary Gregory. 
+o          Functions.getUsedNamespaces() is now typed with generics. Thanks to Gary Gregory. 
+o          JXPathException now reuses its superclass' Throwable cause. Thanks to Gary Gregory. 
+o          Bump JXPathException serialVersionUID from 4306409701468017766L to 2L. Thanks to Gary Gregory. 
+o          JXPathContextFactoryConfigurationError now reuses its superclass' Throwable cause. Thanks to Gary Gregory. 
+o          Bump JXPathContextFactoryConfigurationError serialVersionUID from 1L to 2L. Thanks to Gary Gregory. 
+o          Deprecate SimplePathInterpreter.SimplePathInterpreter(). Thanks to Gary Gregory. 
+o          Deprecate JXPathServletContexts.JXPathServletContexts(). Thanks to Gary Gregory. 
+o          Deprecate JXPathIntrospector.JXPathIntrospector(). Thanks to Gary Gregory. 
+o          Deprecate InfoSetUtil.InfoSetUtil(). Thanks to Gary Gregory. 
+o          Deprecate Constants.Constants(). Thanks to Gary Gregory. 
+o          Deprecate Parser.Parser(). Thanks to Gary Gregory. 
+o          JXPathException.JXPathException(Throwable) now remembers its Throwable cause argument. Thanks to Gary Gregory. 
+o          Make the private DOMNodePointer.id field final. Thanks to Gary Gregory. 
+o          Make the private NullPointer.id field final. Thanks to Gary Gregory. 
+o          Make the private NullPointer.qname field final. Thanks to Gary Gregory. 
+o          Make the private JDOMNodePointer.id field final. Thanks to Gary Gregory. 
+o          ExpressionContext.getContextNodeList() now uses generics. Thanks to Gary Gregory. 
+o          BasicTypeConverter.unmodifiableCollection(Collection) now uses generics. Thanks to Gary Gregory. 
+o          Fix PMD AvoidDecimalLiteralsInBigDecimalConstructor in org.apache.commons.jxpath.util.BasicTypeConverter.allocateNumber(Class, double). Thanks to Gary Gregory. PMD. 
+o          org.apache.commons.jxpath.ri.JXPathContextReferenceImpl.iteratePointers(String) now uses generics. Thanks to Gary Gregory. 
+o          org.apache.commons.jxpath.ri.JXPathContextReferenceImpl.iteratePointers(String, Expression) now uses generics. Thanks to Gary Gregory. 
+o          org.apache.commons.jxpath.CompiledExpression.iteratePointers(JXPathContext) now uses generics. Thanks to Gary Gregory. 
+o          org.apache.commons.jxpath.JXPathCompiledExpression.iteratePointers(JXPathContext) now uses generics. Thanks to Gary Gregory. 
+o          org.apache.commons.jxpath.util.ClassLoaderUtil.getClass(ClassLoader, String) now uses generics. Thanks to Gary Gregory. 
+o          org.apache.commons.jxpath.util.ClassLoaderUtil.getClass(ClassLoader, String, boolean) now uses generics. Thanks to Gary Gregory. 
+o          org.apache.commons.jxpath.util.ClassLoaderUtil.getClass(String) now uses generics. Thanks to Gary Gregory. 
+o          org.apache.commons.jxpath.util.ClassLoaderUtil.getClass(String, boolean) now uses generics. Thanks to Gary Gregory. 
+
+Changes
+-------
+
+o          Bump commons-parent from 54 to 81 #45, #49, #64, #110, #121, #403, #167, #173, #176, #181, #185, #188, #196. Thanks to Dependabot, Gary Gregory. 
+o JXPATH-184:  Bump Java to 8. Thanks to britter, Gary Gregory. 
+o          Bump JUnit 3.8.1 to 4.13.2. Thanks to britter, Gary Gregory. 
+o          Bump commons-logging from 1.1.1 to 1.3.5 #34, #129, #147, #160, #174. Thanks to Dependabot, Gary Gregory. 
+o          Bump commons-beanutils from 1.8.2 to 1.10.1 #24. Thanks to Dependabot, Gary Gregory. 
+o          Bump taglist-maven-plugin from 2.2 to 3.0.0 #32. Thanks to Dependabot. 
+o          Bump servlet-api from 2.4 to 2.5 #29. Thanks to Dependabot. 
+o          Bump JDOM from jdom:jdom 1.0 to org.jdom:jdom 1.1.3. Thanks to Dependabot. 
+o          Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.2.1 #161, #194. Thanks to Dependabot. 
+
+Removed
+-------
+
+o          Remove obsolete Apache RAT file. Thanks to Gary Gregory. o          Remove obsolete Apache Ant files. Thanks to Gary Gregory. o          Remove obsolete src/conf/MANIFEST.MF file. Thanks to Gary Gregory. o          Remove obsolete maven-surefire-plugin configuration. Configuration is done in the parent POM. Thanks to Gary Gregory. o          Remove obsolete maven-assembly-plugin configuration. Configuration is done in the parent POM. Thanks to Gary Gregory. o          Remove obsolete STATUS.html files. Thanks to Gary Gregory. o          Remove unused package-private class org.apache.commons.jxpath.util.BasicTypeConverter.ValueNodeSet. Thanks to Gary Gregory. 
+Historical list of changes: https://commons.apache.org/proper/commons-jxpath/changes.html
+
+For complete information on Apache Commons JXPath, including instructions on how to submit bug reports,
+patches, or suggestions for improvement, see the Apache Commons JXPath website:
+
+https://commons.apache.org/proper/commons-jxpath/
+
+Download page: https://commons.apache.org/proper/commons-jxpath/download_io.cgi
+
+Have fun!
+-Apache Commons Team
+
+------------------------------------------------------------------------------
+