You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/09/02 14:48:41 UTC
(commons-secure-xml) branch main updated (92724fb -> 7602db1)
This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/commons-secure-xml.git
from 92724fb Javadoc
new 8fc0beb Normalize Javadoc `@throws`.
new 7602db1 Normalize Javadoc `@param`.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../xml/secure/FallbackIgnoreEntityResolver2.java | 4 ++--
.../commons/xml/secure/FallbackIgnoreURIResolver.java | 6 +++---
.../commons/xml/secure/SecureDocumentBuilder.java | 4 ++--
.../xml/secure/SecureDocumentBuilderFactory.java | 6 +++---
.../org/apache/commons/xml/secure/SecureException.java | 18 +++++++++---------
.../org/apache/commons/xml/secure/SecureSAXParser.java | 4 ++--
.../commons/xml/secure/SecureSAXParserFactory.java | 12 ++++++------
.../org/apache/commons/xml/secure/SecureSchema.java | 4 ++--
.../apache/commons/xml/secure/SecureSchemaFactory.java | 16 ++++++++--------
.../org/apache/commons/xml/secure/SecureTemplates.java | 8 ++++----
.../commons/xml/secure/SecureTemplatesHandler.java | 8 ++++----
.../apache/commons/xml/secure/SecureTransformer.java | 8 ++++----
.../commons/xml/secure/SecureTransformerFactory.java | 18 +++++++++---------
.../commons/xml/secure/SecureTransformerHandler.java | 8 ++++----
.../org/apache/commons/xml/secure/SecureValidator.java | 4 ++--
.../commons/xml/secure/SecureValidatorHandler.java | 4 ++--
.../org/apache/commons/xml/secure/SecureXMLFilter.java | 4 ++--
.../commons/xml/secure/SecureXMLInputFactory.java | 6 +++---
.../org/apache/commons/xml/secure/SecureXMLReader.java | 4 ++--
.../org/apache/commons/xml/secure/SecureXPath.java | 8 ++++----
.../commons/xml/secure/SecureXPathExpression.java | 4 ++--
.../apache/commons/xml/secure/SecureXPathFactory.java | 10 +++++-----
.../xml/secure/SecureDocumentBuilderFactoryTest.java | 2 +-
.../commons/xml/secure/SecureSAXParserFactoryTest.java | 6 +++---
24 files changed, 88 insertions(+), 88 deletions(-)
(commons-secure-xml) 02/02: Normalize Javadoc `@param`.
Posted by gg...@apache.org.
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-secure-xml.git
commit 7602db167924c02376e2e367835178180d70b927
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Sep 2 10:48:33 2026 -0400
Normalize Javadoc `@param`.
---
.../commons/xml/secure/FallbackIgnoreURIResolver.java | 6 +++---
.../commons/xml/secure/SecureDocumentBuilder.java | 2 +-
.../xml/secure/SecureDocumentBuilderFactory.java | 4 ++--
.../org/apache/commons/xml/secure/SecureException.java | 18 +++++++++---------
.../org/apache/commons/xml/secure/SecureSAXParser.java | 2 +-
.../commons/xml/secure/SecureSAXParserFactory.java | 8 ++++----
.../org/apache/commons/xml/secure/SecureSchema.java | 2 +-
.../apache/commons/xml/secure/SecureSchemaFactory.java | 12 ++++++------
.../org/apache/commons/xml/secure/SecureTemplates.java | 6 +++---
.../commons/xml/secure/SecureTemplatesHandler.java | 6 +++---
.../apache/commons/xml/secure/SecureTransformer.java | 6 +++---
.../commons/xml/secure/SecureTransformerFactory.java | 8 ++++----
.../commons/xml/secure/SecureTransformerHandler.java | 6 +++---
.../org/apache/commons/xml/secure/SecureValidator.java | 2 +-
.../commons/xml/secure/SecureValidatorHandler.java | 2 +-
.../org/apache/commons/xml/secure/SecureXMLFilter.java | 4 ++--
.../commons/xml/secure/SecureXMLInputFactory.java | 4 ++--
.../org/apache/commons/xml/secure/SecureXMLReader.java | 2 +-
.../org/apache/commons/xml/secure/SecureXPath.java | 2 +-
.../commons/xml/secure/SecureXPathExpression.java | 2 +-
.../apache/commons/xml/secure/SecureXPathFactory.java | 8 ++++----
.../xml/secure/SecureDocumentBuilderFactoryTest.java | 2 +-
.../commons/xml/secure/SecureSAXParserFactoryTest.java | 6 +++---
23 files changed, 60 insertions(+), 60 deletions(-)
diff --git a/src/main/java/org/apache/commons/xml/secure/FallbackIgnoreURIResolver.java b/src/main/java/org/apache/commons/xml/secure/FallbackIgnoreURIResolver.java
index 1e67c38..1b16c5c 100644
--- a/src/main/java/org/apache/commons/xml/secure/FallbackIgnoreURIResolver.java
+++ b/src/main/java/org/apache/commons/xml/secure/FallbackIgnoreURIResolver.java
@@ -61,7 +61,7 @@ final class FallbackIgnoreURIResolver implements URIResolver {
* received cannot surface in another resolution.
* </p>
*
- * @param factory the factory to create the document builder with.
+ * @param factory The factory to create the document builder with.
* @return a new empty document.
* @throws IllegalStateException Thrown if the factory cannot supply a {@link javax.xml.parsers.DocumentBuilder} satisfying its configuration.
*/
@@ -89,8 +89,8 @@ private static Document newEmptyDocument(final DocumentBuilderFactory factory) {
/**
* Constructs a new resolver.
*
- * @param delegate the resolver to delegate resolution to; may be {@code null}.
- * @param emptySource the empty-{@link Source} supplier for the ignore outcome, or {@code null} for the default empty DOM document.
+ * @param delegate The resolver to delegate resolution to; may be {@code null}.
+ * @param emptySource The empty-{@link Source} supplier for the ignore outcome, or {@code null} for the default empty DOM document.
* @param overrideDefaultParser whether the opted-in rewrite should use the pluggable parser lookup instead of the platform's built-in parser, read at each resolution.
*/
FallbackIgnoreURIResolver(final URIResolver delegate, final Supplier<Source> emptySource, final BooleanSupplier overrideDefaultParser) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java b/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java
index 53b0628..b794fcc 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java
@@ -46,7 +46,7 @@ final class SecureDocumentBuilder extends DocumentBuilder {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureDocumentBuilder(final DocumentBuilder delegate) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java
index 19db08b..71b5c28 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java
@@ -61,7 +61,7 @@ private static final class Wrapper extends DocumentBuilderFactory {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final DocumentBuilderFactory delegate) {
@@ -186,7 +186,7 @@ public void setXIncludeAware(final boolean state) {
/**
* Enables namespace awareness on the given factory; the {@code NSInstance} counterpart of each factory method routes its result through here.
*
- * @param factory the factory to configure; never {@code null}.
+ * @param factory The factory to configure; never {@code null}.
* @return The given factory, namespace-aware.
*/
private static DocumentBuilderFactory makeNSAware(final DocumentBuilderFactory factory) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureException.java b/src/main/java/org/apache/commons/xml/secure/SecureException.java
index bcfae3c..2d89913 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureException.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureException.java
@@ -47,9 +47,9 @@ final class SecureException extends IllegalStateException {
/**
* Builds the standard exception for a rejected secure setting.
- * @param name the name of the feature, attribute or property that could not be set.
- * @param target the factory, parser, validator or reader that rejected the setting; its concrete class names the offending implementation.
- * @param cause the original checked or unchecked exception from the JAXP implementation.
+ * @param name The name of the feature, attribute or property that could not be set.
+ * @param target The factory, parser, validator or reader that rejected the setting; its concrete class names the offending implementation.
+ * @param cause The original checked or unchecked exception from the JAXP implementation.
*
* @return the exception to throw.
*/
@@ -60,11 +60,11 @@ static SecureException featureFailed(final String name, final Object target, fin
/**
* Builds the standard "forbidden" message shared by every resolver floor when {@link #throwOnUnresolved()} rejects an unresolved reference.
*
- * @param type the resource kind, or {@code null} if not applicable.
- * @param namespace the namespace (or, for Woodstox, the entity name), or {@code null}.
- * @param publicId the public identifier, or {@code null} if none.
- * @param systemId the system identifier of the denied resource.
- * @param baseURI the base URI for relative resolution, or {@code null}.
+ * @param type The resource kind, or {@code null} if not applicable.
+ * @param namespace The namespace (or, for Woodstox, the entity name), or {@code null}.
+ * @param publicId The public identifier, or {@code null} if none.
+ * @param systemId The system identifier of the denied resource.
+ * @param baseURI The base URI for relative resolution, or {@code null}.
* @return the message naming the denied lookup and the enabling property.
*/
static String forbidden(final String type, final String namespace, final String publicId, final String systemId, final String baseURI) {
@@ -78,7 +78,7 @@ static String forbidden(final String type, final String namespace, final String
* <p>Every supported implementation provides a reader as a routine capability, so the wrapped {@code ParserConfigurationException} or
* {@code SAXException} signals a broken environment, not a per-parse condition — hence unchecked.</p>
*
- * @param cause the original checked exception from the JAXP implementation.
+ * @param cause The original checked exception from the JAXP implementation.
* @return the exception to throw.
*/
static SecureException readerFailed(final Throwable cause) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java b/src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java
index abd2bed..38d1603 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java
@@ -50,7 +50,7 @@ final class SecureSAXParser extends SAXParser {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureSAXParser(final SAXParser delegate) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java
index d166f17..a3776a2 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java
@@ -94,7 +94,7 @@ private static final class Wrapper extends SAXParserFactory {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final SAXParserFactory delegate) {
@@ -179,7 +179,7 @@ public void setXIncludeAware(final boolean state) {
/**
* Enables namespace awareness on the given factory; the {@code NSInstance} counterpart of each factory method routes its result through here.
*
- * @param factory the factory to configure; never {@code null}.
+ * @param factory The factory to configure; never {@code null}.
* @return The given factory, namespace-aware.
*/
private static SAXParserFactory makeNSAware(final SAXParserFactory factory) {
@@ -336,7 +336,7 @@ static XMLReader newXMLReader(final boolean overrideDefaultParser) {
* chain its own resolver onto the floor to allow-list resources, but cannot remove it.</li>
* </ul>
*
- * @param factory the factory to secure; never {@code null}.
+ * @param factory The factory to secure; never {@code null}.
* @return a secure factory.
*/
static SAXParserFactory secure(final SAXParserFactory factory) {
@@ -355,7 +355,7 @@ static SAXParserFactory secure(final SAXParserFactory factory) {
* as-is. Used by the TrAX and schema wrappers to route every source they parse through the secure SAX path.
* </p>
*
- * @param source the source to secure; never {@code null}.
+ * @param source The source to secure; never {@code null}.
* @param overrideDefaultParser whether {@value #OVERRIDE_DEFAULT_PARSER} on the originating factory asks to override the JDK's default parser.
* @return a secure source.
* @throws IllegalStateException Thrown if the underlying implementation cannot provide a secure reader.
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureSchema.java b/src/main/java/org/apache/commons/xml/secure/SecureSchema.java
index 2a908a5..1d39a54 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureSchema.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureSchema.java
@@ -41,7 +41,7 @@ final class SecureSchema extends Schema {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @param overrideDefaultParser whether the produced Validators' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java
index 97539ca..7635ee6 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java
@@ -96,7 +96,7 @@ private static final class Wrapper extends SchemaFactory {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final SchemaFactory delegate) {
@@ -167,7 +167,7 @@ private boolean overrideDefaultParser() {
/**
* Secures every schema source through {@link SecureSAXParserFactory#secure(Source, boolean)}.
*
- * @param schemas the schema sources to secure; must not be {@code null}.
+ * @param schemas The schema sources to secure; must not be {@code null}.
* @return a new array of secure sources.
* @throws IllegalStateException Thrown if the underlying implementation cannot provide a secure reader.
* @throws FactoryConfigurationError Thrown from a factory in case of a {@link java.util.ServiceConfigurationError service
@@ -272,7 +272,7 @@ public static SchemaFactory newInstance(final String schemaLanguage, final Strin
* and instance documents is secured separately, through {@link SecureSAXParserFactory#secure(javax.xml.transform.Source, boolean)}; the factory carries
* {@code FEATURE_SECURE_PROCESSING} for the one limit that reader cannot supply, the loader's content-model expansion.</p>
*
- * @param factory the factory to secure; never {@code null}.
+ * @param factory The factory to secure; never {@code null}.
* @return a secure factory.
*/
static SchemaFactory secure(final SchemaFactory factory) {
@@ -282,9 +282,9 @@ static SchemaFactory secure(final SchemaFactory factory) {
/**
* Sets a feature on the delegate, failing closed: an implementation that cannot accept it yields no factory rather than an unsecured one.
*
- * @param factory the factory to configure; never {@code null}.
- * @param feature the feature name.
- * @param value the value to set.
+ * @param factory The factory to configure; never {@code null}.
+ * @param feature The feature name.
+ * @param value The value to set.
* @throws SecureException Thrown if the implementation rejects the feature.
*/
private static void setFeature(final SchemaFactory factory, final String feature, final boolean value) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTemplates.java b/src/main/java/org/apache/commons/xml/secure/SecureTemplates.java
index 755e809..c276c0c 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTemplates.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTemplates.java
@@ -60,9 +60,9 @@ final class SecureTemplates implements Templates {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
- * @param uriResolver the compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
- * @param emptySource the empty-{@link Source} supplier for the produced Transformers.
+ * @param delegate The delegate to wrap; must not be {@code null}.
+ * @param uriResolver The compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
+ * @param emptySource The empty-{@link Source} supplier for the produced Transformers.
* @param overrideDefaultParser whether the produced Transformers' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java b/src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java
index a71e747..3b686d6 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java
@@ -59,9 +59,9 @@ final class SecureTemplatesHandler implements TemplatesHandler {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
- * @param uriResolver the compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
- * @param emptySource the empty-{@link Source} supplier for the produced Templates; may be {@code null} for the default empty DOM document.
+ * @param delegate The delegate to wrap; must not be {@code null}.
+ * @param uriResolver The compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
+ * @param emptySource The empty-{@link Source} supplier for the produced Templates; may be {@code null} for the default empty DOM document.
* @param overrideDefaultParser whether the produced Templates' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTransformer.java b/src/main/java/org/apache/commons/xml/secure/SecureTransformer.java
index 0bcd49e..1ec40d5 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTransformer.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTransformer.java
@@ -59,9 +59,9 @@ final class SecureTransformer extends Transformer {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
- * @param uriResolver the compile-time URIResolver snapshot to seed the floor with; may be {@code null}.
- * @param emptySource the empty-{@link Source} supplier for the produced Transformers; {@code null} for the default empty DOM document.
+ * @param delegate The delegate to wrap; must not be {@code null}.
+ * @param uriResolver The compile-time URIResolver snapshot to seed the floor with; may be {@code null}.
+ * @param emptySource The empty-{@link Source} supplier for the produced Transformers; {@code null} for the default empty DOM document.
* @param overrideDefaultParser whether the source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTransformerFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureTransformerFactory.java
index 51fe807..b55a68f 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTransformerFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTransformerFactory.java
@@ -167,7 +167,7 @@ private static Templates unwrap(final Templates templates) {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final SAXTransformerFactory delegate) {
@@ -177,8 +177,8 @@ private Wrapper(final SAXTransformerFactory delegate) {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
- * @param emptySource the empty-{@link Source} supplier for the resolver floor, threaded onto every produced Templates/Transformer; {@code null} means the
+ * @param delegate The delegate to wrap; must not be {@code null}.
+ * @param emptySource The empty-{@link Source} supplier for the resolver floor, threaded onto every produced Templates/Transformer; {@code null} means the
* default empty DOM.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
@@ -482,7 +482,7 @@ public static TransformerFactory newInstance(final String factoryClassName, fina
* {@link org.apache.commons.xml.secure}-secured reader instead.</li>
* </ul>
*
- * @param factory the factory to secure; never {@code null}.
+ * @param factory The factory to secure; never {@code null}.
* @return a secure factory.
*/
static TransformerFactory secure(final TransformerFactory factory) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTransformerHandler.java b/src/main/java/org/apache/commons/xml/secure/SecureTransformerHandler.java
index 88b5a59..f90cb53 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTransformerHandler.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTransformerHandler.java
@@ -51,9 +51,9 @@ final class SecureTransformerHandler implements TransformerHandler {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
- * @param uriResolver the compile-time URIResolver snapshot to restore onto the live transformer; may be {@code null}.
- * @param emptySource the empty-{@link Source} supplier for the produced Transformer's floor; {@code null} means the default empty DOM.
+ * @param delegate The delegate to wrap; must not be {@code null}.
+ * @param uriResolver The compile-time URIResolver snapshot to restore onto the live transformer; may be {@code null}.
+ * @param emptySource The empty-{@link Source} supplier for the produced Transformer's floor; {@code null} means the default empty DOM.
* @param overrideDefaultParser whether the live transformer's source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureValidator.java b/src/main/java/org/apache/commons/xml/secure/SecureValidator.java
index ec6ef4b..0a593ac 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureValidator.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureValidator.java
@@ -51,7 +51,7 @@ final class SecureValidator extends Validator {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @param overrideDefaultParser whether the source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureValidatorHandler.java b/src/main/java/org/apache/commons/xml/secure/SecureValidatorHandler.java
index 47be477..f32b6b3 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureValidatorHandler.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureValidatorHandler.java
@@ -46,7 +46,7 @@ final class SecureValidatorHandler extends ValidatorHandler {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureValidatorHandler(final ValidatorHandler delegate) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXMLFilter.java b/src/main/java/org/apache/commons/xml/secure/SecureXMLFilter.java
index 204e9f8..3f8f89c 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXMLFilter.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXMLFilter.java
@@ -52,7 +52,7 @@ final class SecureXMLFilter extends XMLFilterImpl implements ErrorListener {
/**
* Bridges a TrAX report to the SAX callback shape.
*
- * @param e the reported exception.
+ * @param e The reported exception.
* @return The original {@link SAXParseException} where one is the cause, otherwise a synthetic one carrying the locator.
*/
private static SAXParseException toSAXParseException(final TransformerException e) {
@@ -73,7 +73,7 @@ private static SAXParseException toSAXParseException(final TransformerException
/**
* Constructs a new instance.
*
- * @param templates the templates to wrap; must not be {@code null}.
+ * @param templates The templates to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code templates} is {@code null}.
*/
SecureXMLFilter(final SecureTemplates templates) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXMLInputFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureXMLInputFactory.java
index d0d8501..58c838c 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXMLInputFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXMLInputFactory.java
@@ -93,7 +93,7 @@ private static XMLResolver unwrap(final XMLResolver resolver) {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final XMLInputFactory delegate) {
@@ -328,7 +328,7 @@ public static XMLInputFactory newInstance() {
* every entity-resolution hook, leaving the standard {@code SUPPORT_DTD} / {@code IS_SUPPORTING_EXTERNAL_ENTITIES} defaults untouched; see the wrapper's
* Javadoc for the per-implementation hook routing.</p>
*
- * @param factory the factory to secure; never {@code null}.
+ * @param factory The factory to secure; never {@code null}.
* @return a secure factory.
*/
static XMLInputFactory secure(final XMLInputFactory factory) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXMLReader.java b/src/main/java/org/apache/commons/xml/secure/SecureXMLReader.java
index 9eecd77..4de8fa1 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXMLReader.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXMLReader.java
@@ -49,7 +49,7 @@ class SecureXMLReader implements XMLReader {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureXMLReader(final XMLReader delegate) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXPath.java b/src/main/java/org/apache/commons/xml/secure/SecureXPath.java
index 786b772..d1ea6f7 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXPath.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXPath.java
@@ -82,7 +82,7 @@ static Document parse(final InputSource source, final boolean overrideDefaultPar
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @param overrideDefaultParser whether the {@link InputSource} document builds should use the pluggable parser lookup instead of the platform's built-in parser.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXPathExpression.java b/src/main/java/org/apache/commons/xml/secure/SecureXPathExpression.java
index 8303b91..3dbec86 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXPathExpression.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXPathExpression.java
@@ -46,7 +46,7 @@ final class SecureXPathExpression implements XPathExpression {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @param overrideDefaultParser whether the {@link InputSource} document builds should use the pluggable parser lookup instead of the platform's built-in parser.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXPathFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureXPathFactory.java
index 12c95cd..e50c4b5 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXPathFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXPathFactory.java
@@ -62,7 +62,7 @@ private static final class Wrapper extends XPathFactory {
/**
* Constructs a new instance.
*
- * @param delegate the delegate to wrap; must not be {@code null}.
+ * @param delegate The delegate to wrap; must not be {@code null}.
* @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final XPathFactory delegate) {
@@ -82,7 +82,7 @@ public boolean getFeature(final String name) throws XPathFactoryConfigurationExc
* delegate's own limits ({@code jdk.xml.xpath*}) behind an {@code UnsupportedOperationException}.
* </p>
*
- * @param name the property name.
+ * @param name The property name.
* @return the delegate's value for the property.
*/
public String getProperty(final String name) {
@@ -131,8 +131,8 @@ public void setFeature(final String name, final boolean value) throws XPathFacto
* {@code @Override}. The {@code jdk.xml.xpath*} limits reached this way are processing limits like any other: an operator may tighten them, and
* loosening one is reconfiguration.
*
- * @param name the property name.
- * @param value the value to set.
+ * @param name The property name.
+ * @param value The value to set.
*/
public void setProperty(final String name, final String value) {
if (MH_setProperty == null) {
diff --git a/src/test/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactoryTest.java b/src/test/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactoryTest.java
index e7899a8..bddebcc 100644
--- a/src/test/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactoryTest.java
+++ b/src/test/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactoryTest.java
@@ -54,7 +54,7 @@ private static DocumentBuilderFactory getDelegate(final DocumentBuilderFactory f
/**
* Selects the implementation {@link DocumentBuilderFactory#newInstance()} returns by setting the {@value #FACTORY_ID} system property.
*
- * @param factoryClassName the implementation class name to install, or {@code null} to clear the property and restore the platform lookup.
+ * @param factoryClassName The implementation class name to install, or {@code null} to clear the property and restore the platform lookup.
* @return The previous property value, {@code null} if it was not set; pass it back here to restore the original lookup.
*/
private static String setFactoryIdProperty(final String factoryClassName) {
diff --git a/src/test/java/org/apache/commons/xml/secure/SecureSAXParserFactoryTest.java b/src/test/java/org/apache/commons/xml/secure/SecureSAXParserFactoryTest.java
index 43d0b05..bef253b 100644
--- a/src/test/java/org/apache/commons/xml/secure/SecureSAXParserFactoryTest.java
+++ b/src/test/java/org/apache/commons/xml/secure/SecureSAXParserFactoryTest.java
@@ -80,8 +80,8 @@ public void setFeature(final String name, final boolean value) {
/**
* Asserts {@link SecureSAXParserFactory#newXMLReader(boolean)} on the given delegate throws {@link IllegalStateException} with the given cause.
*
- * @param cause the checked exception the delegate is stubbed to throw.
- * @param delegate the stubbed factory to route {@link MockSAXParserFactory} to.
+ * @param cause The checked exception the delegate is stubbed to throw.
+ * @param delegate The stubbed factory to route {@link MockSAXParserFactory} to.
*/
private static void assertNewXmlReaderWraps(final Exception cause, final SAXParserFactory delegate) {
MockSAXParserFactory.delegate = delegate;
@@ -104,7 +104,7 @@ private static SAXParserFactory getDelegate(final SAXParserFactory factory) thro
/**
* Selects the implementation {@link SAXParserFactory#newInstance()} returns by setting the {@value #FACTORY_ID} system property.
*
- * @param factoryClassName the implementation class name to install, or {@code null} to clear the property and restore the platform lookup.
+ * @param factoryClassName The implementation class name to install, or {@code null} to clear the property and restore the platform lookup.
* @return The previous property value, {@code null} if it was not set; pass it back here to restore the original lookup.
*/
private static String setFactoryIdProperty(final String factoryClassName) {
(commons-secure-xml) 01/02: Normalize Javadoc `@throws`.
Posted by gg...@apache.org.
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-secure-xml.git
commit 8fc0bebaa29654464aefa7c2eb76e76ec370c62a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Sep 2 10:47:05 2026 -0400
Normalize Javadoc `@throws`.
---
.../commons/xml/secure/FallbackIgnoreEntityResolver2.java | 4 ++--
.../org/apache/commons/xml/secure/SecureDocumentBuilder.java | 2 +-
.../commons/xml/secure/SecureDocumentBuilderFactory.java | 2 +-
.../java/org/apache/commons/xml/secure/SecureSAXParser.java | 2 +-
.../org/apache/commons/xml/secure/SecureSAXParserFactory.java | 4 ++--
src/main/java/org/apache/commons/xml/secure/SecureSchema.java | 2 +-
.../org/apache/commons/xml/secure/SecureSchemaFactory.java | 4 ++--
.../java/org/apache/commons/xml/secure/SecureTemplates.java | 2 +-
.../org/apache/commons/xml/secure/SecureTemplatesHandler.java | 2 +-
.../java/org/apache/commons/xml/secure/SecureTransformer.java | 2 +-
.../apache/commons/xml/secure/SecureTransformerFactory.java | 10 +++++-----
.../apache/commons/xml/secure/SecureTransformerHandler.java | 2 +-
.../java/org/apache/commons/xml/secure/SecureValidator.java | 2 +-
.../org/apache/commons/xml/secure/SecureValidatorHandler.java | 2 +-
.../org/apache/commons/xml/secure/SecureXMLInputFactory.java | 2 +-
.../java/org/apache/commons/xml/secure/SecureXMLReader.java | 2 +-
src/main/java/org/apache/commons/xml/secure/SecureXPath.java | 6 +++---
.../org/apache/commons/xml/secure/SecureXPathExpression.java | 2 +-
.../java/org/apache/commons/xml/secure/SecureXPathFactory.java | 2 +-
19 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/src/main/java/org/apache/commons/xml/secure/FallbackIgnoreEntityResolver2.java b/src/main/java/org/apache/commons/xml/secure/FallbackIgnoreEntityResolver2.java
index 50e6e4d..fd47576 100644
--- a/src/main/java/org/apache/commons/xml/secure/FallbackIgnoreEntityResolver2.java
+++ b/src/main/java/org/apache/commons/xml/secure/FallbackIgnoreEntityResolver2.java
@@ -110,8 +110,8 @@ public InputSource getExternalSubset(final String name, final String baseURI) th
* @param baseURI The base URI for relative resolution, or {@code null}.
* @param systemId The system identifier of the unresolved entity.
* @return an empty {@link InputSource} carrying the requested identifiers.
- * @throws SAXException when {@value SecureException#THROW_ON_UNRESOLVED} is set: unresolved references are rejected instead of resolved to empty.
- * @throws IOException never by the default implementation.
+ * @throws SAXException Thrown when {@value SecureException#THROW_ON_UNRESOLVED} is set: unresolved references are rejected instead of resolved to empty.
+ * @throws IOException Never thrown by the default implementation.
*/
private InputSource onUnresolved(final String name, final String publicId, final String baseURI, final String systemId) throws SAXException {
if (SecureException.throwOnUnresolved()) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java b/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java
index 069f383..53b0628 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilder.java
@@ -47,7 +47,7 @@ final class SecureDocumentBuilder extends DocumentBuilder {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureDocumentBuilder(final DocumentBuilder delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java
index 42a5e43..19db08b 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureDocumentBuilderFactory.java
@@ -62,7 +62,7 @@ private static final class Wrapper extends DocumentBuilderFactory {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final DocumentBuilderFactory delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java b/src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java
index 363da5c..abd2bed 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureSAXParser.java
@@ -51,7 +51,7 @@ final class SecureSAXParser extends SAXParser {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureSAXParser(final SAXParser delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java
index 5759080..d166f17 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureSAXParserFactory.java
@@ -95,7 +95,7 @@ private static final class Wrapper extends SAXParserFactory {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final SAXParserFactory delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
@@ -375,7 +375,7 @@ static Source secure(final Source source, final boolean overrideDefaultParser) {
*
* @param reader The reader to secure; never {@code null}.
* @return A secure reader.
- * @throws IllegalStateException if a required secure setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
*/
static XMLReader secure(final XMLReader reader) {
if (reader instanceof SecureXMLReader) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureSchema.java b/src/main/java/org/apache/commons/xml/secure/SecureSchema.java
index eaccf80..2a908a5 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureSchema.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureSchema.java
@@ -43,7 +43,7 @@ final class SecureSchema extends Schema {
*
* @param delegate the delegate to wrap; must not be {@code null}.
* @param overrideDefaultParser whether the produced Validators' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureSchema(final Schema delegate, final boolean overrideDefaultParser) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java
index 58c063d..97539ca 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureSchemaFactory.java
@@ -97,7 +97,7 @@ private static final class Wrapper extends SchemaFactory {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final SchemaFactory delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
@@ -285,7 +285,7 @@ static SchemaFactory secure(final SchemaFactory factory) {
* @param factory the factory to configure; never {@code null}.
* @param feature the feature name.
* @param value the value to set.
- * @throws SecureException if the implementation rejects the feature.
+ * @throws SecureException Thrown if the implementation rejects the feature.
*/
private static void setFeature(final SchemaFactory factory, final String feature, final boolean value) {
try {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTemplates.java b/src/main/java/org/apache/commons/xml/secure/SecureTemplates.java
index 66eb84f..755e809 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTemplates.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTemplates.java
@@ -64,7 +64,7 @@ final class SecureTemplates implements Templates {
* @param uriResolver the compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
* @param emptySource the empty-{@link Source} supplier for the produced Transformers.
* @param overrideDefaultParser whether the produced Transformers' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureTemplates(final Templates delegate, final URIResolver uriResolver, final Supplier<Source> emptySource, final boolean overrideDefaultParser) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java b/src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java
index bdb04ba..a71e747 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTemplatesHandler.java
@@ -63,7 +63,7 @@ final class SecureTemplatesHandler implements TemplatesHandler {
* @param uriResolver the compile-time URIResolver snapshot to restore onto Transformers produced from the compiled Templates; may be {@code null}.
* @param emptySource the empty-{@link Source} supplier for the produced Templates; may be {@code null} for the default empty DOM document.
* @param overrideDefaultParser whether the produced Templates' source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureTemplatesHandler(final TemplatesHandler delegate, final URIResolver uriResolver, final Supplier<Source> emptySource,
final boolean overrideDefaultParser) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTransformer.java b/src/main/java/org/apache/commons/xml/secure/SecureTransformer.java
index dfa9473..0bcd49e 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTransformer.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTransformer.java
@@ -63,7 +63,7 @@ final class SecureTransformer extends Transformer {
* @param uriResolver the compile-time URIResolver snapshot to seed the floor with; may be {@code null}.
* @param emptySource the empty-{@link Source} supplier for the produced Transformers; {@code null} for the default empty DOM document.
* @param overrideDefaultParser whether the source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureTransformer(final Transformer delegate, final URIResolver uriResolver, final Supplier<Source> emptySource, final boolean overrideDefaultParser) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTransformerFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureTransformerFactory.java
index 7e6db46..51fe807 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTransformerFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTransformerFactory.java
@@ -168,7 +168,7 @@ private static Templates unwrap(final Templates templates) {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final SAXTransformerFactory delegate) {
this(delegate, null);
@@ -180,7 +180,7 @@ private Wrapper(final SAXTransformerFactory delegate) {
* @param delegate the delegate to wrap; must not be {@code null}.
* @param emptySource the empty-{@link Source} supplier for the resolver floor, threaded onto every produced Templates/Transformer; {@code null} means the
* default empty DOM.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final SAXTransformerFactory delegate, final Supplier<Source> emptySource) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
@@ -202,7 +202,7 @@ private Wrapper(final SAXTransformerFactory delegate, final Supplier<Source> emp
* @param associated The delegate's result; {@code null} when no PI matched.
* @param base The system id of the scanned document, the base the href was resolved against.
* @return The caller resolver's source for an opted-in href, an empty source otherwise, or {@code null} when no PI matched.
- * @throws TransformerConfigurationException if the floor rejects the href, which it does when {@value SecureException#THROW_ON_UNRESOLVED} is set.
+ * @throws TransformerConfigurationException Thrown if the floor rejects the href, which it does when {@value SecureException#THROW_ON_UNRESOLVED} is set.
*/
private Source floorAssociated(final Source associated, final String base) throws TransformerConfigurationException {
if (associated == null || associated.getSystemId() == null) {
@@ -358,7 +358,7 @@ private TransformerHandler secure(final TransformerHandler handler) {
*
* @param source The source to scan for an associated stylesheet.
* @return A {@link DOMSource} for a stream or SAX source, otherwise the result of {@link SecureSAXParserFactory#secure(Source, boolean)}.
- * @throws TransformerConfigurationException if the source cannot be parsed.
+ * @throws TransformerConfigurationException Thrown if the source cannot be parsed.
* @throws FactoryConfigurationError Thrown from a factory in case of a {@link java.util.ServiceConfigurationError service
* configuration error} or if the implementation is not available or cannot be instantiated.
* @throws SecureException Thrown if a (non-Android) factory cannot support the secure processing feature {@link XMLConstants#FEATURE_SECURE_PROCESSING}.
@@ -441,7 +441,7 @@ public static TransformerFactory newDefaultInstance() {
* Returns a new, secure {@link TransformerFactory}.
*
* @return A secure factory.
- * @throws IllegalStateException if a required secure setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
*/
public static TransformerFactory newInstance() {
return secure(TransformerFactory.newInstance());
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureTransformerHandler.java b/src/main/java/org/apache/commons/xml/secure/SecureTransformerHandler.java
index c71bd98..88b5a59 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureTransformerHandler.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureTransformerHandler.java
@@ -55,7 +55,7 @@ final class SecureTransformerHandler implements TransformerHandler {
* @param uriResolver the compile-time URIResolver snapshot to restore onto the live transformer; may be {@code null}.
* @param emptySource the empty-{@link Source} supplier for the produced Transformer's floor; {@code null} means the default empty DOM.
* @param overrideDefaultParser whether the live transformer's source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureTransformerHandler(final TransformerHandler delegate, final URIResolver uriResolver, final Supplier<Source> emptySource,
final boolean overrideDefaultParser) {
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureValidator.java b/src/main/java/org/apache/commons/xml/secure/SecureValidator.java
index 784b0f1..ec6ef4b 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureValidator.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureValidator.java
@@ -53,7 +53,7 @@ final class SecureValidator extends Validator {
*
* @param delegate the delegate to wrap; must not be {@code null}.
* @param overrideDefaultParser whether the source rewrites should use the pluggable parser lookup instead of the platform's built-in parser.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureValidator(final Validator delegate, final boolean overrideDefaultParser) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureValidatorHandler.java b/src/main/java/org/apache/commons/xml/secure/SecureValidatorHandler.java
index e07f068..47be477 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureValidatorHandler.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureValidatorHandler.java
@@ -47,7 +47,7 @@ final class SecureValidatorHandler extends ValidatorHandler {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureValidatorHandler(final ValidatorHandler delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXMLInputFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureXMLInputFactory.java
index 9b6873e..d0d8501 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXMLInputFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXMLInputFactory.java
@@ -94,7 +94,7 @@ private static XMLResolver unwrap(final XMLResolver resolver) {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final XMLInputFactory delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXMLReader.java b/src/main/java/org/apache/commons/xml/secure/SecureXMLReader.java
index 6531bd0..9eecd77 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXMLReader.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXMLReader.java
@@ -50,7 +50,7 @@ class SecureXMLReader implements XMLReader {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureXMLReader(final XMLReader delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXPath.java b/src/main/java/org/apache/commons/xml/secure/SecureXPath.java
index 19f834d..786b772 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXPath.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXPath.java
@@ -57,8 +57,8 @@ final class SecureXPath implements XPath {
* @param source The document to evaluate against.
* @param overrideDefaultParser Whether the document build should use the pluggable parser lookup instead of the platform's built-in parser.
* @return The parsed document.
- * @throws NullPointerException if {@code source} is {@code null}, per the {@link XPath} contract.
- * @throws XPathExpressionException if the source cannot be parsed.
+ * @throws NullPointerException Thrown if {@code source} is {@code null}, per the {@link XPath} contract.
+ * @throws XPathExpressionException Thrown if the source cannot be parsed.
* @throws FactoryConfigurationError Thrown from a factory in case of a {@link java.util.ServiceConfigurationError service
* configuration error} or if the implementation is not available or cannot be instantiated.
* @throws SecureException Thrown if a (non-Android) factory cannot support the secure processing feature {@link XMLConstants#FEATURE_SECURE_PROCESSING}.
@@ -84,7 +84,7 @@ static Document parse(final InputSource source, final boolean overrideDefaultPar
*
* @param delegate the delegate to wrap; must not be {@code null}.
* @param overrideDefaultParser whether the {@link InputSource} document builds should use the pluggable parser lookup instead of the platform's built-in parser.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureXPath(final XPath delegate, final boolean overrideDefaultParser) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXPathExpression.java b/src/main/java/org/apache/commons/xml/secure/SecureXPathExpression.java
index 002d603..8303b91 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXPathExpression.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXPathExpression.java
@@ -48,7 +48,7 @@ final class SecureXPathExpression implements XPathExpression {
*
* @param delegate the delegate to wrap; must not be {@code null}.
* @param overrideDefaultParser whether the {@link InputSource} document builds should use the pluggable parser lookup instead of the platform's built-in parser.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
SecureXPathExpression(final XPathExpression delegate, final boolean overrideDefaultParser) {
this.delegate = Objects.requireNonNull(delegate, "delegate");
diff --git a/src/main/java/org/apache/commons/xml/secure/SecureXPathFactory.java b/src/main/java/org/apache/commons/xml/secure/SecureXPathFactory.java
index d7ca9a6..12c95cd 100644
--- a/src/main/java/org/apache/commons/xml/secure/SecureXPathFactory.java
+++ b/src/main/java/org/apache/commons/xml/secure/SecureXPathFactory.java
@@ -63,7 +63,7 @@ private static final class Wrapper extends XPathFactory {
* Constructs a new instance.
*
* @param delegate the delegate to wrap; must not be {@code null}.
- * @throws NullPointerException if {@code delegate} is {@code null}.
+ * @throws NullPointerException Thrown if {@code delegate} is {@code null}.
*/
private Wrapper(final XPathFactory delegate) {
this.delegate = Objects.requireNonNull(delegate, "delegate");