This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/commons-xml.git
The following commit(s) were added to refs/heads/main by this push:
new 2d638e1 Javadoc
2d638e1 is described below
commit 2d638e101f3436b5ffe1518b62abb586f7642cab
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:09:24 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/xml/Resolvers.java | 2 +-
.../java/org/apache/commons/xml/SAXParserHardener.java | 2 +-
src/main/java/org/apache/commons/xml/XmlFactories.java | 16 ++++++++--------
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/xml/Resolvers.java
b/src/main/java/org/apache/commons/xml/Resolvers.java
index c807427..082a35a 100644
--- a/src/main/java/org/apache/commons/xml/Resolvers.java
+++ b/src/main/java/org/apache/commons/xml/Resolvers.java
@@ -111,7 +111,7 @@ public final InputSource resolveEntity(final String name,
final String publicId,
* @param publicId the public identifier, or {@code null} if none.
* @param baseURI the base URI for relative resolution, or {@code
null}.
* @param systemId the system identifier of the unresolved entity.
- * @return an {@link InputSource} to permit the lookup, or {@code
null} to skip it silently; the default implementation never returns normally.
+ * @return An {@link InputSource} to permit the lookup, or {@code
null} to skip it silently; the default implementation never returns normally.
* @throws SAXException to deny the lookup (the default behavior).
* @throws IOException if a subclass opens a stream that fails.
*/
diff --git a/src/main/java/org/apache/commons/xml/SAXParserHardener.java
b/src/main/java/org/apache/commons/xml/SAXParserHardener.java
index fa3143b..9491d20 100644
--- a/src/main/java/org/apache/commons/xml/SAXParserHardener.java
+++ b/src/main/java/org/apache/commons/xml/SAXParserHardener.java
@@ -154,7 +154,7 @@ static SAXParserFactory harden(final SAXParserFactory
factory) {
* Hardens an existing {@link XMLReader}.
*
* @param reader the reader to harden; never {@code null}.
- * @return a hardened reader.
+ * @return A hardened reader.
* @throws IllegalStateException if a required hardening setting cannot be
applied to the underlying implementation.
*/
static XMLReader hardenReader(final XMLReader reader) {
diff --git a/src/main/java/org/apache/commons/xml/XmlFactories.java
b/src/main/java/org/apache/commons/xml/XmlFactories.java
index af5630a..aeb3aeb 100644
--- a/src/main/java/org/apache/commons/xml/XmlFactories.java
+++ b/src/main/java/org/apache/commons/xml/XmlFactories.java
@@ -82,7 +82,7 @@ public final class XmlFactories {
* <p>The reader is namespace-aware.</p>
*
* @param source the source to harden; never {@code null}.
- * @return a hardened source.
+ * @return A hardened source.
* @throws TransformerConfigurationException if a hardened reader cannot
be obtained.
*/
public static Source harden(final Source source) throws
TransformerConfigurationException {
@@ -104,7 +104,7 @@ public static Source harden(final Source source) throws
TransformerConfiguration
* Hardens an existing {@link XMLReader}.
*
* @param reader the reader to harden; never {@code null}.
- * @return a hardened reader.
+ * @return A hardened reader.
* @throws IllegalStateException if a required hardening setting cannot be
applied to the underlying implementation.
*/
public static XMLReader harden(final XMLReader reader) {
@@ -120,7 +120,7 @@ public static XMLReader harden(final XMLReader reader) {
* To permit specific trusted resources, install an {@link
org.xml.sax.EntityResolver EntityResolver} on the
* {@link DocumentBuilder} that allow-lists them; any href the resolver
does not explicitly allow stays blocked.</p>
*
- * @return a hardened factory.
+ * @return A hardened factory.
* @throws IllegalStateException if a required hardening setting cannot be
applied to the underlying implementation.
*/
public static DocumentBuilderFactory newDocumentBuilderFactory() {
@@ -137,7 +137,7 @@ public static DocumentBuilderFactory
newDocumentBuilderFactory() {
* {@link org.xml.sax.XMLReader} that allow-lists them; any href the
resolver does not explicitly allow stays
* blocked.</p>
*
- * @return a hardened factory.
+ * @return A hardened factory.
* @throws IllegalStateException if a required hardening setting cannot be
applied to the underlying implementation.
*/
public static SAXParserFactory newSAXParserFactory() {
@@ -157,7 +157,7 @@ public static SAXParserFactory newSAXParserFactory() {
* <p>The same guarantees apply to {@link javax.xml.validation.Validator}
and {@link javax.xml.validation.ValidatorHandler} instances produced from the
* resulting {@link javax.xml.validation.Schema}.</p>
*
- * @return a hardened factory.
+ * @return A hardened factory.
*/
public static SchemaFactory newSchemaFactory() {
return new
HardeningSchemaFactory(SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI));
@@ -172,7 +172,7 @@ public static SchemaFactory newSchemaFactory() {
* <p>The guarantees apply to every parser the factory creates internally,
both for stylesheet compilation and for source-document reading at
* {@code Transformer.transform(Source, Result)} time.</p>
*
- * @return a hardened factory.
+ * @return A hardened factory.
* @throws IllegalStateException if a required hardening setting cannot be
applied to the underlying implementation.
*/
public static TransformerFactory newTransformerFactory() {
@@ -184,7 +184,7 @@ public static TransformerFactory newTransformerFactory() {
*
* <p>The three universal guarantees on {@link XmlFactories} apply; StAX
exposes no additional vectors beyond them.</p>
*
- * @return a hardened factory.
+ * @return A hardened factory.
* @throws IllegalStateException if a required hardening setting cannot be
applied to the underlying implementation.
*/
public static XMLInputFactory newXMLInputFactory() {
@@ -197,7 +197,7 @@ public static XMLInputFactory newXMLInputFactory() {
* <p>Beyond the three universal guarantees on {@link XmlFactories},
URI-fetching XPath 3.1+ functions ({@code doc()}, {@code collection()},
* {@code unparsed-text()}) are not resolved.</p>
*
- * @return a hardened factory.
+ * @return A hardened factory.
* @throws IllegalStateException if a required hardening setting cannot be
applied to the underlying implementation.
*/
public static XPathFactory newXPathFactory() {
