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 <[email protected]> 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");
