You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2021/07/17 19:45:25 UTC
[sling-org-apache-sling-commons-content-analyzing] branch master
updated (d66a14f -> 99f966f)
This is an automated email from the ASF dual-hosted git repository.
olli pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git.
from d66a14f build with JDK 11 and 14 only (to make SonarCloud happy)
new c33ac00 SLING-10627 Update to Sling Bundle Parent 43
new a5c38cb SLING-10628 Enable code checks with Checkstyle
new 474dc3f SLING-10629 Enable code checks with PMD
new d7ec887 SLING-10630 Enable code checks with SpotBugs
new 706e99a javadoc style
new ad4cdfa [checkstyle] (javadoc) MissingJavadocPackage
new 5f7d120 [checkstyle] (javadoc) MissingJavadocType
new ef7b35b [checkstyle] (javadoc) SummaryJavadoc
new 99f966f [checkstyle] (modifier) InterfaceMemberImpliedModifier
The 9 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:
pmd-exclude.properties | 19 ++++++
pom.xml | 73 ++++++++++++++++++++--
.../commons/content/analyzing/ContentAnalyzer.java | 13 ++--
.../commons/content/analyzing/package-info.java | 4 ++
4 files changed, 101 insertions(+), 8 deletions(-)
create mode 100644 pmd-exclude.properties
[sling-org-apache-sling-commons-content-analyzing] 03/09:
SLING-10629 Enable code checks with PMD
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit 474dc3f6bd2fbb6df051624d491826509cbb49d2
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:29:09 2021 +0200
SLING-10629 Enable code checks with PMD
---
pom.xml | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/pom.xml b/pom.xml
index 47682d8..b3f4ceb 100644
--- a/pom.xml
+++ b/pom.xml
@@ -82,6 +82,22 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-pmd-plugin</artifactId>
+ <version>3.14.0</version>
+ <configuration>
+ <targetJdk>${sling.java.version}</targetJdk>
+ </configuration>
+ <executions>
+ <execution>
+ <phase>process-classes</phase>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
[sling-org-apache-sling-commons-content-analyzing] 09/09:
[checkstyle] (modifier) InterfaceMemberImpliedModifier
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit 99f966f1eb418f6c84cbc1555d7c9c6cdaf572ae
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:43:43 2021 +0200
[checkstyle] (modifier) InterfaceMemberImpliedModifier
---
pmd-exclude.properties | 19 +++++++++++++++++++
pom.xml | 1 +
.../commons/content/analyzing/ContentAnalyzer.java | 2 +-
3 files changed, 21 insertions(+), 1 deletion(-)
diff --git a/pmd-exclude.properties b/pmd-exclude.properties
new file mode 100644
index 0000000..dfa4d2c
--- /dev/null
+++ b/pmd-exclude.properties
@@ -0,0 +1,19 @@
+################################################################################
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+################################################################################
+org.apache.sling.commons.content.analyzing.ContentAnalyzer=UnnecessaryModifier
diff --git a/pom.xml b/pom.xml
index aafc3a9..6d57764 100644
--- a/pom.xml
+++ b/pom.xml
@@ -88,6 +88,7 @@
<version>3.14.0</version>
<configuration>
<targetJdk>${sling.java.version}</targetJdk>
+ <excludeFromFailureFile>pmd-exclude.properties</excludeFromFailureFile>
</configuration>
<executions>
<execution>
diff --git a/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java b/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
index 88de9d8..c169c8d 100644
--- a/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
+++ b/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
@@ -40,6 +40,6 @@ public interface ContentAnalyzer {
* @param report the report to which the findings of the analyzing operation are added
* @return {@link java.util.concurrent.CompletableFuture} for signaling completion
*/
- @NotNull CompletableFuture<Void> analyze(@NotNull final InputStream input, @Nullable final Map<String, Object> parameters, @NotNull final Map<String, Object> report);
+ public abstract @NotNull CompletableFuture<Void> analyze(@NotNull final InputStream input, @Nullable final Map<String, Object> parameters, @NotNull final Map<String, Object> report);
}
[sling-org-apache-sling-commons-content-analyzing] 06/09:
[checkstyle] (javadoc) MissingJavadocPackage
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit ad4cdfa756bf202423aefd56b36e2ffbc48fb135
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:39:52 2021 +0200
[checkstyle] (javadoc) MissingJavadocPackage
---
.../java/org/apache/sling/commons/content/analyzing/package-info.java | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/src/main/java/org/apache/sling/commons/content/analyzing/package-info.java b/src/main/java/org/apache/sling/commons/content/analyzing/package-info.java
index f8187b4..5af87b0 100644
--- a/src/main/java/org/apache/sling/commons/content/analyzing/package-info.java
+++ b/src/main/java/org/apache/sling/commons/content/analyzing/package-info.java
@@ -16,6 +16,10 @@
* specific language governing permissions and limitations
* under the License.
*/
+
+/**
+ * Provides the Apache Sling Commons Content Analyzing API.
+ */
@Version("1.0.0")
package org.apache.sling.commons.content.analyzing;
[sling-org-apache-sling-commons-content-analyzing] 04/09:
SLING-10630 Enable code checks with SpotBugs
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit d7ec887fbeeceb874536fad45026aaa75388412a
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:29:39 2021 +0200
SLING-10630 Enable code checks with SpotBugs
---
pom.xml | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/pom.xml b/pom.xml
index b3f4ceb..aafc3a9 100644
--- a/pom.xml
+++ b/pom.xml
@@ -98,6 +98,28 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <groupId>com.github.spotbugs</groupId>
+ <artifactId>spotbugs-maven-plugin</artifactId>
+ <version>4.3.0</version>
+ <configuration>
+ <plugins>
+ <plugin>
+ <groupId>com.h3xstream.findsecbugs</groupId>
+ <artifactId>findsecbugs-plugin</artifactId>
+ <version>1.11.0</version>
+ </plugin>
+ </plugins>
+ </configuration>
+ <executions>
+ <execution>
+ <phase>process-classes</phase>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
[sling-org-apache-sling-commons-content-analyzing] 07/09:
[checkstyle] (javadoc) MissingJavadocType
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit 5f7d1208fc35987d5b68d98a985b3f766baaacf9
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:42:12 2021 +0200
[checkstyle] (javadoc) MissingJavadocType
---
.../org/apache/sling/commons/content/analyzing/ContentAnalyzer.java | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java b/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
index 4021fea..316f592 100644
--- a/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
+++ b/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
@@ -26,6 +26,9 @@ import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.osgi.annotation.versioning.ProviderType;
+/**
+ * Service for analyzing content.
+ */
@ProviderType
public interface ContentAnalyzer {
[sling-org-apache-sling-commons-content-analyzing] 05/09: javadoc
style
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit 706e99a6c26fad921a0fd21c6ebbdb927cdbf632
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:31:12 2021 +0200
javadoc style
---
.../org/apache/sling/commons/content/analyzing/ContentAnalyzer.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java b/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
index b29387a..4021fea 100644
--- a/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
+++ b/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
@@ -30,9 +30,9 @@ import org.osgi.annotation.versioning.ProviderType;
public interface ContentAnalyzer {
/**
- * @param input The stream from which the content is read for analyzing
- * @param parameters The parameters for the analyzing operation
- * @param report The report to which the findings of the analyzing operation are added
+ * @param input the stream from which the content is read for analyzing
+ * @param parameters the parameters for the analyzing operation
+ * @param report the report to which the findings of the analyzing operation are added
* @return {@link java.util.concurrent.CompletableFuture} for signaling completion
*/
@NotNull CompletableFuture<Void> analyze(@NotNull final InputStream input, @Nullable final Map<String, Object> parameters, @NotNull final Map<String, Object> report);
[sling-org-apache-sling-commons-content-analyzing] 02/09:
SLING-10628 Enable code checks with Checkstyle
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit a5c38cb67604bb206ab80ddbe19f0cc356e63c94
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:24:53 2021 +0200
SLING-10628 Enable code checks with Checkstyle
---
pom.xml | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/pom.xml b/pom.xml
index f6c063b..47682d8 100644
--- a/pom.xml
+++ b/pom.xml
@@ -54,6 +54,34 @@
<failOnMissing>false</failOnMissing>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>3.1.2</version>
+ <dependencies>
+ <dependency>
+ <groupId>com.puppycrawl.tools</groupId>
+ <artifactId>checkstyle</artifactId>
+ <version>8.44</version>
+ </dependency>
+ <dependency>
+ <groupId>de.bildschirmarbeiter</groupId>
+ <artifactId>checkstyle</artifactId>
+ <version>1</version>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <configLocation>checks.xml</configLocation>
+ </configuration>
+ <executions>
+ <execution>
+ <phase>validate</phase>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
[sling-org-apache-sling-commons-content-analyzing] 01/09:
SLING-10627 Update to Sling Bundle Parent 43
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit c33ac0058d3e950cde907d4151e737d11efc5286
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:22:57 2021 +0200
SLING-10627 Update to Sling Bundle Parent 43
---
pom.xml | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/pom.xml b/pom.xml
index 281bf66..f6c063b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -24,8 +24,8 @@
<parent>
<groupId>org.apache.sling</groupId>
<artifactId>sling-bundle-parent</artifactId>
- <version>39</version>
- <relativePath />
+ <version>43</version>
+ <relativePath/>
</parent>
<artifactId>org.apache.sling.commons.content.analyzing</artifactId>
@@ -35,8 +35,6 @@
<description>Apache Sling Commons Content Analyzing</description>
<properties>
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<sling.java.version>8</sling.java.version>
</properties>
[sling-org-apache-sling-commons-content-analyzing] 08/09:
[checkstyle] (javadoc) SummaryJavadoc
Posted by ol...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-content-analyzing.git
commit ef7b35ba6dfcd0b4a3ea8d82ce5ab7e5d2c9b11d
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Jul 17 21:42:52 2021 +0200
[checkstyle] (javadoc) SummaryJavadoc
---
.../org/apache/sling/commons/content/analyzing/ContentAnalyzer.java | 2 ++
1 file changed, 2 insertions(+)
diff --git a/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java b/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
index 316f592..88de9d8 100644
--- a/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
+++ b/src/main/java/org/apache/sling/commons/content/analyzing/ContentAnalyzer.java
@@ -33,6 +33,8 @@ import org.osgi.annotation.versioning.ProviderType;
public interface ContentAnalyzer {
/**
+ * Analyzes the given content.
+ *
* @param input the stream from which the content is read for analyzing
* @param parameters the parameters for the analyzing operation
* @param report the report to which the findings of the analyzing operation are added