bug(#301): up qulice, fix warnings

h1alexbel · h1alexbel · commit 46810036330e · 2025-04-15T12:40:04.000+02:00
diff --git a/pom.xml b/pom.xml
@@ -203,7 +203,7 @@
           <plugin>
             <groupId>com.qulice</groupId>
             <artifactId>qulice-maven-plugin</artifactId>
-            <version>0.22.0</version>
+            <version>0.24.0</version>
             <configuration>
               <excludes combine.children="append">
                 <exclude>xml:/src/it/settings.xml</exclude>
diff --git a/src/main/java/com/jcabi/xml/ClasspathInput.java b/src/main/java/com/jcabi/xml/ClasspathInput.java
@@ -84,6 +84,7 @@ public String getEncoding() {
         return null;
     }
 
+    @SuppressWarnings("PMD.AvoidCatchingGenericException")
     @Override
     public String getStringData() {
         try {
diff --git a/src/main/java/com/jcabi/xml/ClasspathSources.java b/src/main/java/com/jcabi/xml/ClasspathSources.java
@@ -56,23 +56,25 @@ public ClasspathSources(final String pfx) {
     }
 
     @Override
+    @SuppressWarnings("PMD.CloseResource")
     public Source resolve(final String href, final String base)
         throws TransformerException {
         InputStream stream = this.getClass().getResourceAsStream(
             String.format(ClasspathSources.PATTERN, this.prefix, href)
         );
         if (stream == null) {
-            stream = this.getClass().getResourceAsStream(
+            final InputStream fallback = this.getClass().getResourceAsStream(
                 String.format(ClasspathSources.PATTERN, base, href)
             );
-            if (stream == null) {
+            if (fallback == null) {
                 throw new TransformerException(
                     String.format(
                         "Resource \"%s\" not found in classpath with prefix \"%s\" and base \"%s\"",
                         href, this.prefix, base
                     )
                 );
             }
+            stream = fallback;
         }
         return new StreamSource(stream);
     }
diff --git a/src/main/java/com/jcabi/xml/DomParser.java b/src/main/java/com/jcabi/xml/DomParser.java
@@ -100,6 +100,7 @@ private DomParser(final DocumentBuilderFactory factory, final DocSource source)
      * Get the document body.
      * @return The document
      */
+    @SuppressWarnings("PMD.PrematureDeclaration")
     public Document document() {
         final DocumentBuilder builder;
         try {
@@ -213,6 +214,7 @@ private static class BytesSource implements DocSource {
          * Public ctor.
          * @param xml Bytes of the XML.
          */
+        @SuppressWarnings("PMD.ArrayIsStoredDirectly")
         BytesSource(final byte[] xml) {
             this.xml = xml;
         }
diff --git a/src/main/java/com/jcabi/xml/FileSources.java b/src/main/java/com/jcabi/xml/FileSources.java
@@ -5,8 +5,6 @@
 package com.jcabi.xml;
 
 import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.nio.file.Files;
 import javax.xml.transform.Source;
diff --git a/src/main/java/com/jcabi/xml/ListWrapper.java b/src/main/java/com/jcabi/xml/ListWrapper.java
@@ -13,6 +13,7 @@
 
 /**
  * Wrapper of {@link List}.
+ * @param <T> Time of items
  *
  * <p>This wrapper is our internal implementation of a {@link List}. The only
  * purpose of this wrapper is to throw our own custom exception when the client
@@ -54,7 +55,6 @@
  * <p>The class is immutable and thread-safe.
  *
  * @since 0.1
- * @param <T> Time of items
  */
 @SuppressWarnings("PMD.TooManyMethods")
 final class ListWrapper<T> implements List<T> {
diff --git a/src/main/java/com/jcabi/xml/SaxonDocument.java b/src/main/java/com/jcabi/xml/SaxonDocument.java
@@ -179,8 +179,8 @@ public XML merge(final NamespaceContext context) {
     /**
      * Retrieve DOM node, represented by this wrapper.
      * This method works exactly the same as {@link #deepCopy()}.
-     * @deprecated Use {@link #inner()} or {@link #deepCopy()} instead.
      * @return Deep copy of the inner DOM node.
+     * @deprecated Use {@link #inner()} or {@link #deepCopy()} instead.
      */
     @Deprecated
     public Node node() {
diff --git a/src/main/java/com/jcabi/xml/Sources.java b/src/main/java/com/jcabi/xml/Sources.java
@@ -17,6 +17,7 @@ public interface Sources extends URIResolver {
     /**
      * Dummy sources.
      */
+    @SuppressWarnings("PMD.ConstantsInInterface")
     Sources DUMMY = (href, base) -> {
         throw new UnsupportedOperationException(
             String.format(
diff --git a/src/main/java/com/jcabi/xml/StrictXML.java b/src/main/java/com/jcabi/xml/StrictXML.java
@@ -28,6 +28,7 @@
  * @since 0.7
  * @checkstyle AbbreviationAsWordInNameCheck (5 lines)
  */
+@SuppressWarnings("PMD.TooManyMethods")
 @EqualsAndHashCode(of = "origin")
 public final class StrictXML implements XML {
 
@@ -132,10 +133,12 @@ public XML merge(final NamespaceContext context) {
     /**
      * Retrieve DOM node, represented by this wrapper.
      * This method works exactly the same as {@link #deepCopy()}.
-     * @deprecated Use {@link #inner()} or {@link #deepCopy()} instead.
      * @return Deep copy of the inner DOM node.
+     * @deprecated Use {@link #inner()} or {@link #deepCopy()} instead.
+     * @checkstyle NoJavadocForOverriddenMethodsCheck (5 lines)
      */
     @Deprecated
+    @Override
     public Node node() {
         return this.origin.value().deepCopy();
     }
diff --git a/src/main/java/com/jcabi/xml/TextResource.java b/src/main/java/com/jcabi/xml/TextResource.java
@@ -6,13 +6,13 @@
 
 import java.io.BufferedInputStream;
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.util.Scanner;
 import lombok.EqualsAndHashCode;
 
@@ -56,10 +56,10 @@ private TextResource(final String text) {
      * @param file File to represent as text.
      * @throws FileNotFoundException If file not found
      */
-    TextResource(final File file) throws FileNotFoundException {
+    TextResource(final File file) throws IOException {
         this(
             TextResource.readAsString(
-                new BufferedInputStream(new FileInputStream(file))
+                new BufferedInputStream(Files.newInputStream(file.toPath()))
             )
         );
     }
@@ -93,18 +93,15 @@ public String toString() {
      * @return The stream content, in String form
      */
     private static String readAsString(final InputStream stream) {
-        final Scanner scanner = new Scanner(
-            stream, StandardCharsets.UTF_8.name()
-        ).useDelimiter("\\A");
         final String result;
-        try {
+        try (Scanner scanner = new Scanner(
+            stream, StandardCharsets.UTF_8.name()
+        ).useDelimiter("\\A")) {
             if (scanner.hasNext()) {
                 result = scanner.next();
             } else {
                 result = "";
             }
-        } finally {
-            scanner.close();
         }
         return result;
     }
diff --git a/src/main/java/com/jcabi/xml/XML.java b/src/main/java/com/jcabi/xml/XML.java
@@ -138,8 +138,8 @@ public interface XML {
     /**
      * Retrieve DOM node, represented by this wrapper.
      * This method works exactly the same as {@link #deepCopy()}.
-     * @deprecated Use {@link #inner()} or {@link #deepCopy()} instead.
      * @return Deep copy of the inner DOM node.
+     * @deprecated Use {@link #inner()} or {@link #deepCopy()} instead.
      */
     @Deprecated
     Node node();
diff --git a/src/main/java/com/jcabi/xml/XMLDocument.java b/src/main/java/com/jcabi/xml/XMLDocument.java
@@ -62,7 +62,9 @@
  */
 @SuppressWarnings({
     "PMD.ExcessiveImports",
-    "PMD.OnlyOneConstructorShouldDoInitialization"
+    "PMD.OnlyOneConstructorShouldDoInitialization",
+    "PMD.TooManyMethods",
+    "PMD.GodClass"
 })
 public final class XMLDocument implements XML {
     /**
@@ -270,10 +272,10 @@ public String toString() {
     @Override
     public boolean equals(final Object another) {
         final boolean eql;
-        if (!(another instanceof XML)) {
-            eql = false;
-        } else {
+        if (another instanceof XML) {
             eql = this.toString().equals(another.toString());
+        } else {
+            eql = false;
         }
         return eql;
     }
@@ -286,9 +288,11 @@ public int hashCode() {
     /**
      * Retrieve DOM node, represented by this wrapper.
      * This method works exactly the same as {@link #deepCopy()}.
-     * @deprecated Use {@link #inner()} or {@link #deepCopy()} instead.
      * @return Deep copy of the inner DOM node.
+     * @deprecated Use {@link #inner()} or {@link #deepCopy()} instead.
+     * @checkstyle NoJavadocForOverriddenMethodsCheck (5 lines)
      */
+    @Override
     @Deprecated
     public Node node() {
         return this.deepCopy();
diff --git a/src/main/java/com/jcabi/xml/XPathContext.java b/src/main/java/com/jcabi/xml/XPathContext.java
@@ -117,9 +117,9 @@ public String getNamespaceURI(final String prefix) {
             }
         }
         if (namespace == null) {
-            if (prefix.equals(XMLConstants.XML_NS_PREFIX)) {
+            if (XMLConstants.XML_NS_PREFIX.equals(prefix)) {
                 namespace = XMLConstants.XML_NS_URI;
-            } else if (prefix.equals(XMLConstants.XMLNS_ATTRIBUTE)) {
+            } else if (XMLConstants.XMLNS_ATTRIBUTE.equals(prefix)) {
                 namespace = XMLConstants.XMLNS_ATTRIBUTE_NS_URI;
             } else {
                 namespace = XMLConstants.NULL_NS_URI;
@@ -153,10 +153,10 @@ public Iterator<String> getPrefixes(final String namespace) {
                 prefixes.add(iterator.next().toString());
             }
         }
-        if (namespace.equals(XMLConstants.XML_NS_URI)) {
+        if (XMLConstants.XML_NS_URI.equals(namespace)) {
             prefixes.add(XMLConstants.XML_NS_PREFIX);
         }
-        if (namespace.equals(XMLConstants.XMLNS_ATTRIBUTE_NS_URI)) {
+        if (XMLConstants.XMLNS_ATTRIBUTE_NS_URI.equals(namespace)) {
             prefixes.add(XMLConstants.XMLNS_ATTRIBUTE);
         }
         return Collections.unmodifiableList(prefixes).iterator();
@@ -201,7 +201,7 @@ public XPathContext merge(final NamespaceContext context) {
      * @return Namespaces as map
      */
     private static Map<String, String> namespacesAsMap(
-        final Object...namespaces) {
+        final Object... namespaces) {
         final ConcurrentMap<String, String> map =
             new ConcurrentHashMap<>(namespaces.length);
         for (int pos = 0; pos < namespaces.length; ++pos) {
diff --git a/src/main/java/com/jcabi/xml/XSDDocument.java b/src/main/java/com/jcabi/xml/XSDDocument.java
@@ -70,7 +70,7 @@ public XSDDocument(final URL url) throws IOException {
      * @throws FileNotFoundException If fails to read
      * @since 0.21
      */
-    public XSDDocument(final Path file) throws FileNotFoundException {
+    public XSDDocument(final Path file) throws IOException {
         this(file.toFile());
     }
 
@@ -80,7 +80,7 @@ public XSDDocument(final Path file) throws FileNotFoundException {
      * @throws FileNotFoundException If fails to read
      * @since 0.21
      */
-    public XSDDocument(final File file) throws FileNotFoundException {
+    public XSDDocument(final File file) throws IOException {
         this(new TextResource(file).toString());
     }
 
diff --git a/src/main/java/com/jcabi/xml/XSLChain.java b/src/main/java/com/jcabi/xml/XSLChain.java
@@ -37,7 +37,7 @@ public XSLChain(final XSL... shts) {
      * @param shts Sheets
      */
     public XSLChain(final Collection<XSL> shts) {
-        this.sheets = shts.toArray(new XSL[shts.size()]);
+        this.sheets = shts.toArray(new XSL[0]);
     }
 
     @Override
diff --git a/src/main/java/com/jcabi/xml/XSLDocument.java b/src/main/java/com/jcabi/xml/XSLDocument.java
@@ -147,19 +147,17 @@ public XSLDocument(final URL url, final String base) throws IOException {
      * @throws FileNotFoundException If fails to read
      * @since 0.21
      */
-    public XSLDocument(final File file) throws FileNotFoundException {
+    public XSLDocument(final File file) throws IOException {
         this(file, file.getAbsolutePath());
     }
 
     /**
      * Public ctor, from file  with alternative SystemId.
      * @param file Location of document
      * @param base SystemId/Base
-     * @throws FileNotFoundException If fails to read
      * @since 0.26.0
      */
-    public XSLDocument(final File file, final String base)
-        throws FileNotFoundException {
+    public XSLDocument(final File file, final String base) throws IOException {
         this(new TextResource(file).toString(), base);
     }
 
@@ -169,7 +167,7 @@ public XSLDocument(final File file, final String base)
      * @throws FileNotFoundException If fails to read
      * @since 0.21
      */
-    public XSLDocument(final Path file) throws FileNotFoundException {
+    public XSLDocument(final Path file) throws IOException {
         this(file.toFile());
     }
 
@@ -181,7 +179,7 @@ public XSLDocument(final Path file) throws FileNotFoundException {
      * @since 0.26.0
      */
     public XSLDocument(final Path file, final String base)
-        throws FileNotFoundException {
+        throws IOException {
         this(file.toFile(), base);
     }
 
@@ -402,6 +400,7 @@ public String applyTo(final XML xml) {
      * @since 0.11
      * @link <a href="https://stackoverflow.com/questions/4695489">Relevant SO question</a>
      */
+    @SuppressWarnings("PMD.PrematureDeclaration")
     private void transformInto(final XML xml, final Result result) {
         final Transformer trans = this.transformer();
         final ConsoleErrorListener errors = new ConsoleErrorListener();
@@ -468,7 +467,7 @@ private Transformer transformer() {
      * @return The same
      * @checkstyle ReturnCountCheck (5 lines)
      */
-    @SuppressWarnings("deprecation")
+    @SuppressWarnings({"deprecation", "PMD.UnusedPrivateMethod", "PMD.OnlyOneReturn"})
     private static Transformer forSaxon(final Transformer trans) {
         final String type = trans.getClass().getCanonicalName();
         if (!"net.sf.saxon.jaxp.TransformerImpl".equals(type)) {
diff --git a/src/test/java/com/jcabi/xml/ClasspathInputTest.java b/src/test/java/com/jcabi/xml/ClasspathInputTest.java
@@ -20,6 +20,7 @@ void readsStringFromResourceSuccessfully() {
             "Id", "com/jcabi/xml/simple.xml"
         );
         MatcherAssert.assertThat(
+            "Input XML does not contains expected string, but it should",
             input.getStringData(),
             Matchers.containsString("<root>")
         );
diff --git a/src/test/java/com/jcabi/xml/ClasspathSourcesTest.java b/src/test/java/com/jcabi/xml/ClasspathSourcesTest.java
@@ -17,6 +17,7 @@ final class ClasspathSourcesTest {
     @Test
     void sourcesResolvedFromBase() throws Exception {
         MatcherAssert.assertThat(
+            "Resolved classpath source was not present, but it should be",
             new ClasspathSources().resolve("simple.xml", "com.jcabi.xml."),
             Matchers.notNullValue()
         );
diff --git a/src/test/java/com/jcabi/xml/DomParserTest.java b/src/test/java/com/jcabi/xml/DomParserTest.java
@@ -22,6 +22,7 @@ void parsesIncomingXmlDocument() {
             DocumentBuilderFactory.newInstance(), xml
         );
         MatcherAssert.assertThat(
+            "XPath result node does not match with expected",
             parser.document(),
             XhtmlMatchers.hasXPath("/a/b")
         );
@@ -34,6 +35,7 @@ void parsesIncomingXmlDocumentComment() {
             DocumentBuilderFactory.newInstance(), xml
         );
         MatcherAssert.assertThat(
+            "XPath result node does not match with expected",
             parser.document(),
             XhtmlMatchers.hasXPath("/root")
         );
diff --git a/src/test/java/com/jcabi/xml/FileSourcesTest.java b/src/test/java/com/jcabi/xml/FileSourcesTest.java
@@ -24,6 +24,7 @@ void sourcesResolvedFromDir() throws Exception {
             .resolve("dummy.xml").toFile();
         new LengthOf(new TeeInput("test", file)).value();
         MatcherAssert.assertThat(
+            "File source was not present, but it should",
             new FileSources().resolve(file.getAbsolutePath(), null),
             Matchers.notNullValue()
         );
diff --git a/src/test/java/com/jcabi/xml/TextResourceTest.java b/src/test/java/com/jcabi/xml/TextResourceTest.java
@@ -29,6 +29,7 @@ void readsStreamAsText() {
             text.getBytes(StandardCharsets.UTF_8)
         );
         MatcherAssert.assertThat(
+            "Text does not match, but it should",
             new TextResource(stream).toString(),
             Matchers.is(text)
         );
@@ -41,6 +42,7 @@ void readsFileAsText() throws Exception {
             .resolve("dummy.xml").toFile();
         new LengthOf(new TeeInput(text, file)).value();
         MatcherAssert.assertThat(
+            "Text does not match, but it should",
             new TextResource(file).toString(),
             Matchers.is(text)
         );
diff --git a/src/test/java/com/jcabi/xml/XMLDocumentTest.java b/src/test/java/com/jcabi/xml/XMLDocumentTest.java
diff --git a/src/test/java/com/jcabi/xml/XPathContextTest.java b/src/test/java/com/jcabi/xml/XPathContextTest.java
diff --git a/src/test/java/com/jcabi/xml/XSLChainTest.java b/src/test/java/com/jcabi/xml/XSLChainTest.java
diff --git a/src/test/java/com/jcabi/xml/XSLDocumentTest.java b/src/test/java/com/jcabi/xml/XSLDocumentTest.java

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,7 @@ public String getEncoding() {`
`84`	`84`	`return null;`
`85`	`85`	`}`
`86`	`86`
	`87`	`+ @SuppressWarnings("PMD.AvoidCatchingGenericException")`
`87`	`88`	`@Override`
`88`	`89`	`public String getStringData() {`
`89`	`90`	`try {`
Original file line number	Diff line number	Diff line change
`@@ -56,23 +56,25 @@ public ClasspathSources(final String pfx) {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`@Override`
	`59`	`+ @SuppressWarnings("PMD.CloseResource")`
`59`	`60`	`public Source resolve(final String href, final String base)`
`60`	`61`	`throws TransformerException {`
`61`	`62`	`InputStream stream = this.getClass().getResourceAsStream(`
`62`	`63`	`String.format(ClasspathSources.PATTERN, this.prefix, href)`
`63`	`64`	`);`
`64`	`65`	`if (stream == null) {`
`65`		`- stream = this.getClass().getResourceAsStream(`
	`66`	`+ final InputStream fallback = this.getClass().getResourceAsStream(`
`66`	`67`	`String.format(ClasspathSources.PATTERN, base, href)`
`67`	`68`	`);`
`68`		`- if (stream == null) {`
	`69`	`+ if (fallback == null) {`
`69`	`70`	`throw new TransformerException(`
`70`	`71`	`String.format(`
`71`	`72`	`"Resource \"%s\" not found in classpath with prefix \"%s\" and base \"%s\"",`
`72`	`73`	`href, this.prefix, base`
`73`	`74`	`)`
`74`	`75`	`);`
`75`	`76`	`}`
	`77`	`+ stream = fallback;`
`76`	`78`	`}`
`77`	`79`	`return new StreamSource(stream);`
`78`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* Wrapper of {@link List}.`
	`16`	`+ * @param <T> Time of items`
`16`	`17`	`*`
`17`	`18`	`* <p>This wrapper is our internal implementation of a {@link List}. The only`
`18`	`19`	`* purpose of this wrapper is to throw our own custom exception when the client`
`@@ -54,7 +55,6 @@`
`54`	`55`	`* <p>The class is immutable and thread-safe.`
`55`	`56`	`*`
`56`	`57`	`* @since 0.1`
`57`		`- * @param <T> Time of items`
`58`	`58`	`*/`
`59`	`59`	`@SuppressWarnings("PMD.TooManyMethods")`
`60`	`60`	`final class ListWrapper<T> implements List<T> {`