This is an automated email from the ASF dual-hosted git repository.
claude pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
The following commit(s) were added to refs/heads/master by this push:
new 1c848df1 RAT-436: checkstyle fixes for plugin (#381)
1c848df1 is described below
commit 1c848df1598560d149ce063c0fc6da216002b5e6
Author: Claude Warren <[email protected]>
AuthorDate: Sat Nov 2 08:33:36 2024 +0000
RAT-436: checkstyle fixes for plugin (#381)
* Fixed checkstyle issues
Marked deprecated code
Removed deprecated code from checkstyle consideration
Fixed checkstyle issues.
Fixed javadoc issue.
* fixedupt javadoc
* Minor fixes
* updated changes.xml
---------
Co-authored-by: P. Ottlinger <[email protected]>
---
.../src/main/java/org/apache/rat/package-info.java | 1 +
apache-rat-plugin/src/main/java/org/apache/rat/mp/All.java | 4 ++++
apache-rat-plugin/src/main/java/org/apache/rat/mp/Any.java | 4 ++++
.../src/main/java/org/apache/rat/mp/Copyright.java | 4 ++++
.../src/main/java/org/apache/rat/mp/EnclosingMatcher.java | 4 ++++
.../src/main/java/org/apache/rat/mp/Family.java | 4 ++++
.../java/org/apache/rat/mp/HeaderMatcherSpecification.java | 5 +++--
.../src/main/java/org/apache/rat/mp/License.java | 4 ++++
apache-rat-plugin/src/main/java/org/apache/rat/mp/Not.java | 4 ++++
.../src/main/java/org/apache/rat/mp/RatCheckException.java | 11 ++++++-----
.../src/main/java/org/apache/rat/mp/RatCheckMojo.java | 4 ++--
.../src/main/java/org/apache/rat/mp/RatReportMojo.java | 4 ++--
.../src/main/java/org/apache/rat/mp/Regex.java | 4 ++++
apache-rat-plugin/src/main/java/org/apache/rat/mp/Spdx.java | 4 ++++
apache-rat-plugin/src/main/java/org/apache/rat/mp/Text.java | 4 ++++
.../src/main/java/org/apache/rat/mp}/package-info.java | 7 ++-----
src/changes/changes.xml | 4 ++++
src/conf/checkstyle-suppressions.xml | 13 +++++++++++--
18 files changed, 71 insertions(+), 18 deletions(-)
diff --git a/apache-rat-core/src/main/java/org/apache/rat/package-info.java
b/apache-rat-core/src/main/java/org/apache/rat/package-info.java
index 99110067..61499bf1 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/package-info.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/package-info.java
@@ -22,5 +22,6 @@
* <p>
* In general UIs will use OptionsCollection to get the list of supported
options and then create an instance of
* ReportConfiguration that is then passed to the Reporter for processing and
report generation.
+ * </p>
*/
package org.apache.rat;
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/All.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/All.java
index c40c3b41..dc863f02 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/All.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/All.java
@@ -22,6 +22,10 @@ import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.analysis.IHeaderMatcher.Builder;
import org.apache.rat.configuration.builders.AllBuilder;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class All extends EnclosingMatcher implements IHeaderMatcher.Builder {
final AllBuilder builder = Builder.all();
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Any.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Any.java
index 7007a0b8..126da934 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Any.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Any.java
@@ -22,6 +22,10 @@ import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.analysis.IHeaderMatcher.Builder;
import org.apache.rat.configuration.builders.AnyBuilder;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class Any extends EnclosingMatcher implements IHeaderMatcher.Builder {
final AnyBuilder builder = Builder.any();
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Copyright.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Copyright.java
index f64b2afd..b693f1b9 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Copyright.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Copyright.java
@@ -22,6 +22,10 @@ import org.apache.maven.plugins.annotations.Parameter;
import org.apache.rat.analysis.matchers.CopyrightMatcher;
import org.apache.rat.configuration.builders.CopyrightBuilder;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class Copyright extends CopyrightBuilder {
@Parameter(required = false)
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/EnclosingMatcher.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/EnclosingMatcher.java
index d85f9c90..49fe0b8f 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/EnclosingMatcher.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/EnclosingMatcher.java
@@ -21,6 +21,10 @@ package org.apache.rat.mp;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.rat.analysis.IHeaderMatcher;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
abstract class EnclosingMatcher {
protected abstract void setMatcher(IHeaderMatcher.Builder builder);
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Family.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Family.java
index 0b790164..db965680 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Family.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Family.java
@@ -21,6 +21,10 @@ package org.apache.rat.mp;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.rat.license.ILicenseFamily;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class Family {
private final ILicenseFamily.Builder builder = ILicenseFamily.builder();
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/HeaderMatcherSpecification.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/HeaderMatcherSpecification.java
index 0c0c306a..f761d8fd 100644
---
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/HeaderMatcherSpecification.java
+++
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/HeaderMatcherSpecification.java
@@ -22,9 +22,10 @@ package org.apache.rat.mp;
/**
* Used to specify additional license matchers. A license matcher is basically
a class, which implements
* {@link org.apache.rat.analysis.IHeaderMatcher}.
+ * @deprecated use Configuration file to define licenses
*/
-public class HeaderMatcherSpecification
-{
+@Deprecated
+public class HeaderMatcherSpecification {
/**
* The license matchers class name.
*/
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/License.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/License.java
index 195f4bf9..6644f434 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/License.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/License.java
@@ -25,6 +25,10 @@ import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.license.ILicense;
import org.apache.rat.license.ILicenseFamily;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class License extends EnclosingMatcher {
private final ILicense.Builder builder = ILicense.builder();
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Not.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Not.java
index 5aa791f1..343e2baf 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Not.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Not.java
@@ -22,6 +22,10 @@ import org.apache.rat.analysis.IHeaderMatcher;
import org.apache.rat.analysis.IHeaderMatcher.Builder;
import org.apache.rat.configuration.builders.NotBuilder;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class Not extends EnclosingMatcher implements IHeaderMatcher.Builder {
final NotBuilder builder = Builder.not();
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckException.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckException.java
index 00169536..57a55732 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckException.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckException.java
@@ -21,12 +21,13 @@ package org.apache.rat.mp;
import org.apache.maven.plugin.MojoFailureException;
-public class RatCheckException extends MojoFailureException
-{
+/**
+ * Exception thrown when Plugin processing encounters an error not found in
Core system.
+ */
+public class RatCheckException extends MojoFailureException {
private static final long serialVersionUID = -1720861476741779140L;
- public RatCheckException( String message )
- {
- super( message );
+ public RatCheckException(final String message) {
+ super(message);
}
}
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
index d2a4698a..96155dd2 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java
@@ -18,8 +18,6 @@
*/
package org.apache.rat.mp;
-import static java.lang.String.format;
-
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.nio.charset.StandardCharsets;
@@ -37,6 +35,8 @@ import org.apache.rat.commandline.StyleSheets;
import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
import org.apache.rat.report.claim.ClaimStatistic;
+import static java.lang.String.format;
+
/**
* Run Rat to perform a violation check.
* <p>
diff --git
a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
index 79c4e969..311fb0af 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatReportMojo.java
@@ -18,8 +18,6 @@
*/
package org.apache.rat.mp;
-import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
-
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
@@ -60,6 +58,8 @@ import org.apache.rat.VersionInfo;
import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
import org.codehaus.plexus.util.ReaderFactory;
+import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
+
/**
* Generates a report with Rat's output.
*/
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Regex.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Regex.java
index 5184ae65..8cd7b84d 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Regex.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Regex.java
@@ -22,6 +22,10 @@ import javax.inject.Named;
import org.apache.rat.configuration.builders.RegexBuilder;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class Regex extends RegexBuilder {
@Named("expr")
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Spdx.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Spdx.java
index 54620d78..f2198cf3 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Spdx.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Spdx.java
@@ -21,6 +21,10 @@ package org.apache.rat.mp;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.rat.configuration.builders.SpdxBuilder;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class Spdx extends SpdxBuilder {
@Parameter(name="name")
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Text.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Text.java
index 9fe156e1..6fc31eba 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/Text.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/Text.java
@@ -20,6 +20,10 @@ package org.apache.rat.mp;
import org.apache.rat.configuration.builders.TextBuilder;
+/**
+ * @deprecated use Configuration file to define licenses
+ */
+@Deprecated
public class Text extends TextBuilder {
public void set(String text) {
super.setSimpleText(text);
diff --git a/apache-rat-core/src/main/java/org/apache/rat/package-info.java
b/apache-rat-plugin/src/main/java/org/apache/rat/mp/package-info.java
similarity index 79%
copy from apache-rat-core/src/main/java/org/apache/rat/package-info.java
copy to apache-rat-plugin/src/main/java/org/apache/rat/mp/package-info.java
index 99110067..8876b3f8 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/package-info.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/package-info.java
@@ -18,9 +18,6 @@
*/
/**
- * The base package for the RAT tool.
- * <p>
- * In general UIs will use OptionsCollection to get the list of supported
options and then create an instance of
- * ReportConfiguration that is then passed to the Reporter for processing and
report generation.
+ * The base package for the RAT Maven plugin.
*/
-package org.apache.rat;
+package org.apache.rat.mp;
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index c75c6afe..6c016fd6 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -72,6 +72,10 @@ The <action> type attribute can be one of:
</release>
-->
<release version="0.17-SNAPSHOT" date="xxxx-yy-zz" description="Current
SNAPSHOT - release to be done">
+ <action issue="RAT-438" type="fix" dev="claudenw">
+ Fix checkstyle issues in plugin module.
+ Deprecated several classes.
+ </action>
<action issue="RAT-438" type="fix" dev="claudenw">
Fix checkstyle issues in tools module.
</action>
diff --git a/src/conf/checkstyle-suppressions.xml
b/src/conf/checkstyle-suppressions.xml
index 483f562e..c215f1d2 100644
--- a/src/conf/checkstyle-suppressions.xml
+++ b/src/conf/checkstyle-suppressions.xml
@@ -28,9 +28,18 @@
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]analysis[/\\]license[/\\]*"
/>
<suppress checks="[a-zA-Z0-9]*"
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]license[/\\]SimpleLicenseFamily.java"
/>
- <!-- all java files not starting with R -->
<suppress checks="[a-zA-Z0-9]*"
-
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]anttasks[/\\]([A-Q]|[R-Z]).*.java"
/>
+
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]mp[/\\]All.java" />
+ <suppress checks="[a-zA-Z0-9]*"
+
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]mp[/\\]Any.java" />
+ <!-- most all plugin java files not starting with A or R -->
+ <suppress checks="[a-zA-Z0-9]*"
+
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]mp[/\\]([B-Q]|[S-Z]).*.java"
/>
+ <suppress checks="[a-zA-Z0-9]*"
+
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]mp[/\\]Regex.java"
/>
+ <!-- most all task java files not starting with R -->
+ <suppress checks="[a-zA-Z0-9]*"
+
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]anttasks[/\\]([A-Q]|[S-Z]).*.java"
/>
<suppress checks="[a-zA-Z0-9]*"
files="src[/\\]main[/\\]java[/\\]org[/\\]apache[/\\]rat[/\\]anttasks[/\\]Regex.java"
/>
