From 0188ed33d09f809104dac0c98333221f517c15a4 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Sat, 11 May 2024 21:23:03 +0200
Subject: [PATCH 01/19] fixed RAT-265 and initial tests for command line
 processing

---
 .../src/main/java/org/apache/rat/Report.java  |  60 ++++--
 .../resources/org/apache/rat/rat-config.xsd   |   4 +-
 .../test/java/org/apache/rat/ReportTest.java  | 180 +++++++++++++++++-
 .../java/org/apache/rat/ReporterTest.java     |   3 +
 src/changes/changes.xml                       |   4 +
 5 files changed, 226 insertions(+), 25 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/Report.java b/apache-rat-core/src/main/java/org/apache/rat/Report.java
index 3241fb8c5..bc88cd619 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/Report.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/Report.java
@@ -41,6 +41,7 @@
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Converter;
 import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.DeprecatedAttributes;
 import org.apache.commons.cli.HelpFormatter;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.OptionGroup;
@@ -130,9 +131,14 @@ public String desc() {
     /**
      * Adds license headers to files missing headers.
      */
-    private static final OptionGroup ADD = new OptionGroup()
-            .addOption(new Option("a", false,
-                    "(deprecated) Add the default license header to any file with an unknown license.  Use '-A' or ---addLicense instead."))
+    private static final DeprecatedAttributes addAttributes = DeprecatedAttributes.builder().setForRemoval(true).setSince("1.17.0")
+                                    .setDescription("Use '-A' or --addLicense instead.").get();
+    static final OptionGroup ADD = new OptionGroup()
+            .addOption(Option.builder("a").hasArg(false)
+                    .desc(format( "[%s]", addAttributes))
+                    .deprecated( addAttributes )
+                    .build())
+
             .addOption(new Option("A", "addLicense", false,
                     "Add the default license header to any file with an unknown license that is not in the exclusion list. "
                             + "By default new files will be created with the license header, "
@@ -147,19 +153,24 @@ public String desc() {
             .desc("Define the output file where to write a report to (default is System.out).")
             .converter(Converter.FILE).build();
 
+    static final DeprecatedAttributes dirAttributes = DeprecatedAttributes.builder().setForRemoval(true).setSince("1.17.0")
+            .setDescription("Use '--'").get();
     static final Option DIR = Option.builder().option("d").longOpt("dir").hasArg()
-            .desc("(deprecated, use '--') Used to indicate source when using --exclude.").argName("DirOrArchive").build();
+            .desc(format( "[%s] %s", dirAttributes, "Used to indicate end of list when using --exclude.")).argName("DirOrArchive")
+            .deprecated( dirAttributes).build();
 
     /**
      * Forces changes to be written to new files.
      */
     static final Option FORCE = new Option("f", "force", false,
-            "Forces any changes in files to be written directly to the source files (i.e. new files are not created).");
+            format("Forces any changes in files to be written directly to the source files (i.e. new files are not created).  Only valid with --%s",
+                    ADD.getOptions().stream().filter(o -> !o.isDeprecated()).findAny().get().getLongOpt()));
     /**
      * Defines the copyright header to add to the file.
      */
     static final Option COPYRIGHT = Option.builder().option("c").longOpt("copyright").hasArg()
-            .desc("The copyright message to use in the license headers, usually in the form of \"Copyright 2008 Foo\"")
+            .desc(format("The copyright message to use in the license headers, usually in the form of \"Copyright 2008 Foo\".  Only valid with --%s",
+                    ADD.getOptions().stream().filter(o -> !o.isDeprecated()).findAny().get().getLongOpt()))
             .build();
     /**
      * Name of File to exclude from report consideration.
@@ -309,8 +320,10 @@ public static ReportConfiguration parseCommands(String[] args, Consumer<Options>
     public static ReportConfiguration parseCommands(String[] args, Consumer<Options> helpCmd, boolean noArgs) throws IOException {
         Options opts = buildOptions();
         CommandLine cl;
+        Consumer<Option> logDeprecated = o -> DefaultLog.INSTANCE.warn( format("Deprecated option %s used.  %s", o.getOpt(), o.getDeprecated().toString()));
         try {
-            cl = new DefaultParser().parse(opts, args);
+            //DefaultParser.builder().setDeprecatedHandler()
+            cl = DefaultParser.builder().setDeprecatedHandler(logDeprecated).build().parse(opts, args);
         } catch (ParseException e) {
             DefaultLog.INSTANCE.error(e.getMessage());
             DefaultLog.INSTANCE.error("Please use the \"--help\" option to see a list of valid commands and options");
@@ -462,24 +475,29 @@ static FilenameFilter parseExclusions(List<String> excludes) {
         final OrFileFilter orFilter = new OrFileFilter();
         int ignoredLines = 0;
         for (String exclude : excludes) {
-            try {
-                // skip comments
-                if (exclude.startsWith("#") || StringUtils.isEmpty(exclude)) {
-                    ignoredLines++;
-                    continue;
-                }
 
-                String exclusion = exclude.trim();
-                // interpret given patterns as regular expression, direct file names or
-                // wildcards to give users more choices to configure exclusions
+            // skip comments
+            if (exclude.startsWith("#") || StringUtils.isEmpty(exclude)) {
+                ignoredLines++;
+                continue;
+            }
+
+            String exclusion = exclude.trim();
+            // interpret given patterns as regular expression, direct file names or
+            // wildcards to give users more choices to configure exclusions
+            try {
                 orFilter.addFileFilter(new RegexFileFilter(exclusion));
-                orFilter.addFileFilter(new NameFileFilter(exclusion));
-                orFilter.addFileFilter(WildcardFileFilter.builder().setWildcards(exclusion).get());
             } catch (PatternSyntaxException e) {
-                DefaultLog.INSTANCE.error("Will skip given exclusion '" + exclude + "' due to " + e);
+                DefaultLog.INSTANCE.info("Will skip given exclusion '" + exclude + "' due to " + e.getMessage());
             }
+            orFilter.addFileFilter(new NameFileFilter(exclusion));
+            if (exclude.contains("?") || exclude.contains("*")) {
+                orFilter.addFileFilter(WildcardFileFilter.builder().setWildcards(exclusion).get());
+            }
+        }
+        if (ignoredLines > 0) {
+            DefaultLog.INSTANCE.info("Ignored " + ignoredLines + " lines in your exclusion files as comments or empty lines.");
         }
-        DefaultLog.INSTANCE.error("Ignored " + ignoredLines + " lines in your exclusion files as comments or empty lines.");
         return new NotFileFilter(orFilter);
     }
 
@@ -521,7 +539,7 @@ static String header(String txt) {
    }
     static void printUsage(PrintWriter writer, Options opts) {
 
-        HelpFormatter helpFormatter = new HelpFormatter();
+        HelpFormatter helpFormatter = new HelpFormatter.Builder().get();
         helpFormatter.setWidth(130);
         helpFormatter.setOptionComparator(new OptionComparator());
         String syntax = "java -jar apache-rat/target/apache-rat-CURRENT-VERSION.jar [options] [DIR|TARBALL]";
diff --git a/apache-rat-core/src/main/resources/org/apache/rat/rat-config.xsd b/apache-rat-core/src/main/resources/org/apache/rat/rat-config.xsd
index a9f54f758..9c0735045 100644
--- a/apache-rat-core/src/main/resources/org/apache/rat/rat-config.xsd
+++ b/apache-rat-core/src/main/resources/org/apache/rat/rat-config.xsd
@@ -152,7 +152,7 @@
                 <xs:complexType>
                   <xs:simpleContent>
                     <xs:extension base="xs:string">
-                      <xs:attribute type="xs:string" name="license_ref" use="optional"/>
+                        <xs:attribute type="xs:string" name="license_ref" use="optional"/>
                     </xs:extension>
                   </xs:simpleContent>
                 </xs:complexType>
@@ -178,4 +178,4 @@
       </xs:sequence>
     </xs:complexType>
   </xs:element>
-</xs:schema>
\ No newline at end of file
+</xs:schema>
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index d13782744..406bc1916 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -23,15 +23,24 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import java.io.BufferedReader;
 import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileWriter;
 import java.io.FilenameFilter;
 import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
 import java.io.PrintWriter;
 import java.io.StringWriter;
+import java.net.URL;
 import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Optional;
 import java.util.SortedSet;
+import java.util.List;
+import java.util.function.Predicate;
+import java.util.stream.Stream;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.DefaultParser;
@@ -41,13 +50,21 @@
 import org.apache.commons.io.FileUtils;
 import org.apache.rat.license.ILicense;
 import org.apache.rat.license.LicenseSetFactory;
+import org.apache.commons.io.filefilter.FalseFileFilter;
+import org.apache.rat.report.xml.writer.IXmlWriter;
+import org.apache.rat.report.xml.writer.impl.base.XmlWriter;
 import org.apache.rat.testhelpers.TextUtils;
+import org.apache.rat.utils.DefaultLog;
+import org.apache.rat.utils.Log;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 
 public class ReportTest {
     @TempDir
-    File tempDirectory;
+    static File tempDirectory;
 
     private ReportConfiguration createConfig(String... args) throws IOException, ParseException {
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), args);
@@ -152,4 +169,163 @@ public void LicensesOptionNoDefaultsTest() throws Exception {
         assertFalse(LicenseSetFactory.search("LiOne", "LiTwo", set).isPresent(), "LiOne/LiTwo");
         assertTrue(LicenseSetFactory.search("LiTwo", "LiTwo", set).isPresent(), "LiTwo");
     }
+
+    @ParameterizedTest
+    @MethodSource("optionsProvider")
+    public void testOptionsUpdateConfig(String[] args, Predicate<ReportConfiguration> test) throws Exception {
+        ReportConfiguration config = Report.parseCommands(args, (o)-> {}, true);
+        assertNotNull(config, "Did not create ReportConfiguraiton");
+        assertTrue(test.test(config));
+    }
+
+    static Stream<Arguments> optionsProvider() {
+
+        List<Arguments> lst = new ArrayList<>();
+        String[] args;
+        Predicate<ReportConfiguration> test;
+//        Report.ARCHIVE
+        for (ReportConfiguration.Processing processing : ReportConfiguration.Processing.values()) {
+            args = new String[]{"--" + Report.ARCHIVE.getLongOpt(), processing.name().toLowerCase()};
+            test = c -> c.getArchiveProcessing() == processing;
+            lst.add(Arguments.of(args, test));
+        }
+//        Report.COPYRIGHT
+        args = new String[]{"--" + Report.COPYRIGHT.getLongOpt(), "My copyright statement"};
+        test = c -> c.getCopyrightMessage() == null;
+        lst.add(Arguments.of(args, test));
+        args = new String[]{"--" + Report.COPYRIGHT.getLongOpt(), "My copyright statement",
+                "--" + Report.ADD.getOptions().stream().filter(o -> !o.isDeprecated()).findAny().get().getLongOpt()};
+        test = c -> "My copyright statement".equals(c.getCopyrightMessage());
+        lst.add(Arguments.of(args, test));
+
+//        Report.DIR;
+//        Report.DRY_RUN;
+        args = new String[]{"--" + Report.DRY_RUN.getLongOpt()};
+        test = ReportConfiguration::isDryRun;
+        lst.add(Arguments.of(args, test));
+
+//        Report.EXCLUDE_CLI;
+        args = new String[]{"--" + Report.EXCLUDE_CLI.getLongOpt(), "*.foo","[A-Z]\\.bar", "justbaz"};
+        test = c -> {
+            FilenameFilter f = c.getFilesToIgnore();
+
+            assertNotNull(f);
+            assertFalse(f.accept(tempDirectory, "some.foo" ), "some.foo");
+            assertFalse(f.accept(tempDirectory, "B.bar"), "B.bar");
+            assertFalse(f.accept(tempDirectory, "justbaz" ), "justbaz");
+            assertTrue(f.accept(tempDirectory, "notbaz"), "notbaz");
+            return true;
+        };
+        lst.add(Arguments.of(args, test));
+
+//        Report.EXCLUDE_FILE_CLI;
+        File outputFile = new File(tempDirectory, "exclude.txt");
+        try (FileWriter fw = new FileWriter(outputFile)) {
+            fw.write("*.foo");
+            fw.write(System.lineSeparator());
+            fw.write("[A-Z]\\.bar");
+            fw.write(System.lineSeparator());
+            fw.write("justbaz");
+            fw.write(System.lineSeparator());
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+        args = new String[]{"--" + Report.EXCLUDE_FILE_CLI.getLongOpt(), outputFile.getPath()};
+        // same test as above
+        lst.add(Arguments.of(args, test));
+
+//        Report.FORCE
+        args = new String[]{"--" + Report.FORCE.getLongOpt()};
+        test = ReportConfiguration::isAddingLicensesForced;
+        lst.add(Arguments.of(args, test.negate()));
+
+        args = new String[]{"--" + Report.FORCE.getLongOpt(),
+                "--" + Report.ADD.getOptions().stream().filter(o -> !o.isDeprecated()).findAny().get().getLongOpt()};
+        lst.add(Arguments.of(args, test));
+
+//        Report.LICENSES;
+        File cfgFile = new File( tempDirectory, "test.xml");
+        try (IXmlWriter writer = new XmlWriter(new FileWriter(cfgFile))) {
+            writer.openElement("rat-config").openElement("families").openElement("family")
+                    .attribute("id","TEST").attribute("name", "Test license family")
+                    .closeElement().closeElement() // closed families
+                    .openElement("licenses").openElement("license")
+                    .attribute("id", "TEST-1").attribute("name", "Test license")
+                    .openElement("text").content("Hello world").closeElement()
+                    .closeDocument();
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+        args = new String[]{"--" + Report.LICENSES.getLongOpt(), cfgFile.getPath(), "--"  + Report.NO_DEFAULTS};
+        test = c -> {
+            assertEquals(1, c.getLicenses(LicenseSetFactory.LicenseFilter.ALL).size());
+            return true;
+        };
+
+//        Report.LIST_LICENSES;
+        for (LicenseSetFactory.LicenseFilter f : LicenseSetFactory.LicenseFilter.values()) {
+            args = new String[]{"--" + Report.LIST_LICENSES.getLongOpt(), f.name().toLowerCase()};
+            test = c -> c.listLicenses() == f;
+            lst.add(Arguments.of(args, test));
+        }
+
+//        Report.LIST_FAMILIES
+        for (LicenseSetFactory.LicenseFilter f : LicenseSetFactory.LicenseFilter.values()) {
+            args = new String[]{"--" + Report.LIST_FAMILIES.getLongOpt(), f.name().toLowerCase()};
+            test = c -> c.listFamilies() == f;
+            lst.add(Arguments.of(args, test));
+        }
+
+//        Report LOG_LEVEL
+        for (Log.Level l : Log.Level.values()) {
+            args = new String[]{"--" + Report.LOG_LEVEL.getLongOpt(), l.name().toLowerCase()};
+            test = c -> DefaultLog.INSTANCE.getLevel() == l;
+            lst.add(Arguments.of(args, test));
+        }
+//        Report.NO_DEFAULTS
+        args = new String[]{"--" + Report.NO_DEFAULTS.getLongOpt()};
+        test = c -> {
+            assertEquals(0, c.getLicenses(LicenseSetFactory.LicenseFilter.ALL).size());
+            return true;
+        };
+        lst.add(Arguments.of(args, test));
+
+//        Report.OUT;
+        File outFile = new File( tempDirectory, "outexample");
+        args = new String[] {"--"+Report.OUT.getLongOpt(), outFile.getAbsolutePath()};
+        test = c -> {
+            try (OutputStream os = c.getOutput().get()) {
+                os.write("Hello world".getBytes());
+            } catch (IOException e) {
+                throw new RuntimeException(e);
+            }
+            try (BufferedReader reader = new BufferedReader( new InputStreamReader( new FileInputStream(outFile)))) {
+                return "Hello world".equals(reader.readLine());
+            } catch (IOException e) {
+                throw new RuntimeException(e);
+            }
+        };
+        lst.add(Arguments.of(args, test));
+
+//        Report.SCAN_HIDDEN_DIRECTORIES
+        args = new String[]{"--" + Report.SCAN_HIDDEN_DIRECTORIES.getLongOpt()};
+        test = c -> c.getDirectoriesToIgnore() == FalseFileFilter.FALSE;
+        lst.add(Arguments.of(args, test));
+
+//        Report.STYLESHEET_CLI
+        test = c -> c.getStyleSheet() != null;
+        for (String sheet : new String[]{"plain-rat", "missing-headers", "unapproved-licenses"}) {
+            args = new String[]{"--" + Report.STYLESHEET_CLI.getLongOpt(), sheet};
+            lst.add(Arguments.of(args, test));
+        }
+        URL url = ReportTest.class.getResource("MatcherContainerResource.txt");
+        args = new String[]{"--" + Report.STYLESHEET_CLI.getLongOpt(), url.getFile()};
+        lst.add(Arguments.of(args, test));
+
+//        Report.XML;
+        args = new String[]{"--" + Report.XML.getLongOpt()};
+        test = ReportConfiguration::isStyleReport;
+        lst.add(Arguments.of(args, test.negate()));
+        return lst.stream();
+    }
 }
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
index 160519c34..599b8b066 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
@@ -27,6 +27,7 @@
 import java.io.FileInputStream;
 import java.io.PrintStream;
 import java.nio.charset.StandardCharsets;
+import java.util.function.Predicate;
 
 import javax.xml.xpath.XPath;
 import javax.xml.xpath.XPathConstants;
@@ -46,6 +47,8 @@
 import org.apache.rat.walker.DirectoryWalker;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 import org.w3c.dom.Document;
 import org.w3c.dom.NodeList;
 
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index e042d2702..6de0f7a4a 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -84,6 +84,10 @@ https://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd
         Javascript (.js) files not processed as text.
         Fixed as part of the Tika change.
       </action>
+      <action issue="RAT-256" type="fix" dev="claudenw">
+        Fixed the filter compilation so that illegal regex do not cause other filters to be ignored.
+        Updated the logging to only log a warning when at least one filter was skipped.
+      </action>
       <action issue="RAT-372" type="add" dev="claudenw">
         Added ability to process archive files within a project to look for license files.  This necessitated an addition
         of a command line option "archive" to limit specify the level of detail in the archive report.  See command line

From 70750c097d053b352bcaba3d81b82ea3dd6ef987 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Sun, 12 May 2024 10:26:14 +0200
Subject: [PATCH 02/19] Added DeprecationReporter and logged deprecated uses

---
 .../org/apache/rat/DeprecationReporter.java   | 84 +++++++++++++++++++
 .../src/main/java/org/apache/rat/Report.java  | 56 ++++++++++---
 .../configuration/XMLConfigurationReader.java |  2 +-
 .../apache/rat/header/ArrayCharFilter.java    |  5 ++
 .../org/apache/rat/header/CharFilter.java     |  4 +
 .../rat/header/FilteringSequenceFactory.java  |  4 +
 .../org/apache/rat/header/HeaderBean.java     |  4 +
 .../org/apache/rat/header/HeaderMatcher.java  |  4 +
 .../apache/rat/header/LineNumberReader.java   |  4 +
 .../rat/license/SimpleLicenseFamily.java      |  8 +-
 .../java/org/apache/rat/utils/DefaultLog.java | 21 ++++-
 .../org/apache/rat/utils/ReportingSet.java    |  4 +-
 .../java/org/apache/rat/DefaultsTest.java     |  2 +-
 .../apache/rat/ReportConfigurationTest.java   | 63 ++++++--------
 .../test/java/org/apache/rat/ReportTest.java  | 25 +++++-
 .../java/org/apache/rat/ReporterTest.java     | 12 +--
 .../analysis/DefaultAnalyserFactoryTest.java  | 14 ++--
 .../rat/analysis/TikaProcessorTest.java       | 16 ++--
 .../analysis/license/AbstractLicenseTest.java |  2 +-
 .../rat/annotation/TestLicenseAppender.java   | 10 +--
 .../XMLConfigurationWriterTest.java           | 10 +--
 .../builders/TextBuilderTest.java             |  8 +-
 .../apache/rat/license/SimpleLicenseTest.java |  6 +-
 .../apache/rat/policy/DefaultPolicyTest.java  |  2 +-
 .../rat/report/ConfigurationReportTest.java   |  4 +-
 .../rat/report/xml/XmlReportFactoryTest.java  |  4 +-
 .../apache/rat/testhelpers/TestingLog.java    | 48 +++++++++++
 .../rat/walker/DirectoryWalkerTest.java       |  2 +-
 src/changes/changes.xml                       | 24 +++---
 29 files changed, 336 insertions(+), 116 deletions(-)
 create mode 100644 apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
 create mode 100644 apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java

diff --git a/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java b/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
new file mode 100644
index 000000000..b15c31905
--- /dev/null
+++ b/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
@@ -0,0 +1,84 @@
+package org.apache.rat;
+
+import org.apache.commons.cli.Option;
+import org.apache.rat.utils.DefaultLog;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.function.Consumer;
+
+import static java.lang.String.format;
+
+/**
+ * Reporting methods for deprecated objects.
+ */
+public class DeprecationReporter {
+    /**
+     * Deprecated Command line option consumer.
+     */
+    public static Consumer<Option> LOG_DEPRECATED = o -> {
+        StringBuilder buff = new StringBuilder();
+        if (o.getOpt() != null) {
+            buff.append("-").append(o.getOpt());
+            if (o.getLongOpt() != null) {
+                buff.append(", --").append(o.getLongOpt());
+            }
+        } else {
+            buff.append("--").append(o.getLongOpt());
+        }
+        DefaultLog.getInstance().warn(format("Option [%s] used.  %s", buff, o.getDeprecated().toString()));
+    };
+
+    /**
+     * Log Deprecated class use.
+     * @param clazz the Deprecated class to log
+     */
+    public static void logDeprecated(Class<?> clazz) {
+        if (clazz.getAnnotation(Deprecated.class) != null) {
+            StringBuilder sb = new StringBuilder(format("Deprecated class used: %s ", clazz));
+            Info info = clazz.getAnnotation(Info.class);
+            if (info != null) {
+                if (info.forRemoval()) {
+                    sb.append("  Scheduled for removal");
+                    if (!info.since().isEmpty()) {
+                        sb.append( " since ").append(info.since());
+                    }
+                    sb.append(".");
+                } else if (!info.since().isEmpty()) {
+                    sb.append(" Deprecated since ").append(info.since()).append(".");
+                }
+                if (!info.use().isEmpty()) {
+                    sb.append(" Use ").append(info.use()).append(" instead.");
+                }
+            }
+            DefaultLog.getInstance().warn(sb.toString());
+        }
+    }
+
+    /**
+     * Annotation to provide deprecation information for Java8.
+     * TODO remove this when Java 8 no longer supported.
+     */
+    @Target(ElementType.TYPE)
+    @Retention(RetentionPolicy.RUNTIME)
+    public @interface Info {
+        /**
+         * The common name for the component. If not specified the name of the field or class is used.
+         * @return the component name.
+         */
+        String since() default "";
+
+        /**
+         * The description of the component.
+         * @return the component description.
+         */
+        boolean forRemoval() default false;
+        /**
+         * The component type
+         * @return the component type.
+         */
+        String use() default "";
+    }
+}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/Report.java b/apache-rat-core/src/main/java/org/apache/rat/Report.java
index bc88cd619..457bac36e 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/Report.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/Report.java
@@ -131,7 +131,7 @@ public String desc() {
     /**
      * Adds license headers to files missing headers.
      */
-    private static final DeprecatedAttributes addAttributes = DeprecatedAttributes.builder().setForRemoval(true).setSince("1.17.0")
+    private static final DeprecatedAttributes addAttributes = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17.0")
                                     .setDescription("Use '-A' or --addLicense instead.").get();
     static final OptionGroup ADD = new OptionGroup()
             .addOption(Option.builder("a").hasArg(false)
@@ -153,7 +153,7 @@ public String desc() {
             .desc("Define the output file where to write a report to (default is System.out).")
             .converter(Converter.FILE).build();
 
-    static final DeprecatedAttributes dirAttributes = DeprecatedAttributes.builder().setForRemoval(true).setSince("1.17.0")
+    static final DeprecatedAttributes dirAttributes = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17.0")
             .setDescription("Use '--'").get();
     static final Option DIR = Option.builder().option("d").longOpt("dir").hasArg()
             .desc(format( "[%s] %s", dirAttributes, "Used to indicate end of list when using --exclude.")).argName("DirOrArchive")
@@ -277,6 +277,13 @@ public String desc() {
             .converter(s -> ReportConfiguration.Processing.valueOf(s.toUpperCase()))
             .build();
 
+
+    private static void logDeprecated(Option option) {
+        if (option.isDeprecated()) {
+            DeprecationReporter.LOG_DEPRECATED.accept(option);
+        }
+    }
+
     private static String asString(Object[] args) {
         return Arrays.stream(args).map(Object::toString).collect(Collectors.joining(", "));
     }
@@ -291,13 +298,13 @@ private static String asString(Object[] args) {
     public static void main(String[] args) throws Exception {
         ReportConfiguration configuration = parseCommands(args, Report::printUsage);
         if (configuration != null) {
-            configuration.validate(DefaultLog.INSTANCE::error);
+            configuration.validate(DefaultLog.getInstance()::error);
             new Reporter(configuration).output();
         }
     }
 
     /**
-     * Parses the standard options to create a ReportConfiguraton.
+     * Parses the standard options to create a ReportConfiguration.
      *
      * @param args    the arguments to parse
      * @param helpCmd the help command to run when necessary.
@@ -357,15 +364,25 @@ public static ReportConfiguration parseCommands(String[] args, Consumer<Options>
     }
 
     private static void logParseException(ParseException e, Option opt, CommandLine cl, Object dflt) {
-        DefaultLog.INSTANCE.warn(format("Invalid %s specified: %s ", opt.getOpt(), cl.getOptionValue(opt)));
-        DefaultLog.INSTANCE.warn(format("%s set to: %s", opt.getOpt(), dflt));
+        DefaultLog.getInstance().warn(format("Invalid %s specified: %s ", opt.getOpt(), cl.getOptionValue(opt)));
+        DefaultLog.getInstance().warn(format("%s set to: %s", opt.getOpt(), dflt));
+        DefaultLog.getInstance().debug(e);
     }
 
     static ReportConfiguration createConfiguration(String baseDirectory, CommandLine cl) throws IOException {
-        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.INSTANCE);
+        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.getInstance());
+
+        if (cl.hasOption(DIR)) {
+            logDeprecated(DIR);
+        }
+
+        if (cl.hasOption(DRY_RUN)) {
+            logDeprecated(DRY_RUN);
+            configuration.setDryRun(cl.hasOption(DRY_RUN));
+        }
 
-        configuration.setDryRun(cl.hasOption(DRY_RUN));
         if (cl.hasOption(LIST_FAMILIES)) {
+            logDeprecated(LIST_FAMILIES);
             try {
                 configuration.listFamilies(cl.getParsedOptionValue(LIST_FAMILIES));
             } catch (ParseException e) {
@@ -374,6 +391,7 @@ static ReportConfiguration createConfiguration(String baseDirectory, CommandLine
         }
 
         if (cl.hasOption(LIST_LICENSES)) {
+            logDeprecated(LIST_LICENSES);
             try {
                 configuration.listLicenses(cl.getParsedOptionValue(LIST_LICENSES));
             } catch (ParseException e) {
@@ -382,6 +400,7 @@ static ReportConfiguration createConfiguration(String baseDirectory, CommandLine
         }
 
         if (cl.hasOption(ARCHIVE)) {
+            logDeprecated(ARCHIVE);
             try {
                 configuration.setArchiveProcessing(cl.getParsedOptionValue(ARCHIVE));
             } catch (ParseException e) {
@@ -398,6 +417,7 @@ static ReportConfiguration createConfiguration(String baseDirectory, CommandLine
         }
 
         if (cl.hasOption(OUT)) {
+            logDeprecated(OUT);
             try {
                 configuration.setOut((File) cl.getParsedOptionValue(OUT));
             } catch (ParseException e) {
@@ -406,21 +426,29 @@ static ReportConfiguration createConfiguration(String baseDirectory, CommandLine
         }
 
         if (cl.hasOption(SCAN_HIDDEN_DIRECTORIES)) {
+            logDeprecated(SCAN_HIDDEN_DIRECTORIES);
             configuration.setDirectoriesToIgnore(FalseFileFilter.FALSE);
         }
 
         if (ADD.getSelected() != null) {
+            // @TODO remove this block when Commons-cli version 1.7.1 or higher is used
+            Arrays.stream(cl.getOptions()).filter( o -> o.getOpt().equals("a")).forEach( o -> cl.hasOption(o.getOpt()));
+            if (cl.hasOption(FORCE)) logDeprecated(FORCE);
+            if (cl.hasOption(COPYRIGHT)) logDeprecated(COPYRIGHT);
+            // remove that block ---^
             configuration.setAddLicenseHeaders(cl.hasOption(FORCE) ? AddLicenseHeaders.FORCED : AddLicenseHeaders.TRUE);
             configuration.setCopyrightMessage(cl.getOptionValue(COPYRIGHT));
         }
 
         if (cl.hasOption(EXCLUDE_CLI)) {
+            logDeprecated(EXCLUDE_CLI);
             String[] excludes = cl.getOptionValues(EXCLUDE_CLI);
             if (excludes != null) {
                 final FilenameFilter filter = parseExclusions(Arrays.asList(excludes));
                 configuration.setFilesToIgnore(filter);
             }
         } else if (cl.hasOption(EXCLUDE_FILE_CLI)) {
+            logDeprecated(EXCLUDE_FILE_CLI);
             String excludeFileName = cl.getOptionValue(EXCLUDE_FILE_CLI);
             if (excludeFileName != null) {
                 final FilenameFilter filter = parseExclusions(
@@ -430,13 +458,15 @@ static ReportConfiguration createConfiguration(String baseDirectory, CommandLine
         }
 
         if (cl.hasOption(XML)) {
+            logDeprecated(XML);
             configuration.setStyleReport(false);
         } else {
             configuration.setStyleReport(true);
             if (cl.hasOption(STYLESHEET_CLI)) {
+                logDeprecated(STYLESHEET_CLI);
                 String[] style = cl.getOptionValues(STYLESHEET_CLI);
                 if (style.length != 1) {
-                    DefaultLog.INSTANCE.error("Please specify a single stylesheet");
+                    DefaultLog.getInstance().error("Please specify a single stylesheet");
                     System.exit(1);
                 }
 
@@ -450,14 +480,16 @@ static ReportConfiguration createConfiguration(String baseDirectory, CommandLine
 
         Defaults.Builder defaultBuilder = Defaults.builder();
         if (cl.hasOption(NO_DEFAULTS)) {
+            logDeprecated(NO_DEFAULTS);
             defaultBuilder.noDefault();
         }
         if (cl.hasOption(LICENSES)) {
+            logDeprecated(LICENSES);
             for (String fn : cl.getOptionValues(LICENSES)) {
                 defaultBuilder.add(fn);
             }
         }
-        Defaults defaults = defaultBuilder.build(DefaultLog.INSTANCE);
+        Defaults defaults = defaultBuilder.build(DefaultLog.getInstance());
         configuration.setFrom(defaults);
         if (StringUtils.isNotBlank(baseDirectory)) {
             configuration.setReportable(getDirectory(baseDirectory, configuration));
@@ -488,7 +520,7 @@ static FilenameFilter parseExclusions(List<String> excludes) {
             try {
                 orFilter.addFileFilter(new RegexFileFilter(exclusion));
             } catch (PatternSyntaxException e) {
-                DefaultLog.INSTANCE.info("Will skip given exclusion '" + exclude + "' due to " + e.getMessage());
+                DefaultLog.getInstance().info("Will skip given exclusion '" + exclude + "' due to " + e.getMessage());
             }
             orFilter.addFileFilter(new NameFileFilter(exclusion));
             if (exclude.contains("?") || exclude.contains("*")) {
@@ -496,7 +528,7 @@ static FilenameFilter parseExclusions(List<String> excludes) {
             }
         }
         if (ignoredLines > 0) {
-            DefaultLog.INSTANCE.info("Ignored " + ignoredLines + " lines in your exclusion files as comments or empty lines.");
+            DefaultLog.getInstance().info("Ignored " + ignoredLines + " lines in your exclusion files as comments or empty lines.");
         }
         return new NotFileFilter(orFilter);
     }
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
index 728f8587f..f19d09ad9 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
@@ -127,7 +127,7 @@ public void setLog(Log log) {
     }
 
     public Log getLog() {
-        return log == null ? DefaultLog.INSTANCE : log;
+        return log == null ? DefaultLog.getInstance() : log;
     }
 
     @Override
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/ArrayCharFilter.java b/apache-rat-core/src/main/java/org/apache/rat/header/ArrayCharFilter.java
index 9b3ee888f..e27997080 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/ArrayCharFilter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/ArrayCharFilter.java
@@ -17,7 +17,11 @@
  * under the License.                                           *
  */ 
 package org.apache.rat.header;
+
+import org.apache.rat.DeprecationReporter;
+
 @Deprecated // since 0.17
+@DeprecationReporter.Info(since = "0.17", forRemoval = true)
 class ArrayCharFilter implements CharFilter {
 
     private final char[] filtered;
@@ -25,6 +29,7 @@ class ArrayCharFilter implements CharFilter {
     
     protected ArrayCharFilter(final char[] filtered) {
         super();
+        DeprecationReporter.logDeprecated(this.getClass());
         this.filtered = filtered;
         length = filtered.length;
     }
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/CharFilter.java b/apache-rat-core/src/main/java/org/apache/rat/header/CharFilter.java
index 13f28d528..be80825f3 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/CharFilter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/CharFilter.java
@@ -17,7 +17,11 @@
  * under the License.                                           *
  */ 
 package org.apache.rat.header;
+
+import org.apache.rat.DeprecationReporter;
+
 @Deprecated // since 0.17
+@DeprecationReporter.Info(since = "0.17", forRemoval = true)
 interface CharFilter {
 
     /**
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/FilteringSequenceFactory.java b/apache-rat-core/src/main/java/org/apache/rat/header/FilteringSequenceFactory.java
index 2c852a570..2ff791862 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/FilteringSequenceFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/FilteringSequenceFactory.java
@@ -18,10 +18,13 @@
  */ 
 package org.apache.rat.header;
 
+import org.apache.rat.DeprecationReporter;
+
 import java.io.IOException;
 import java.io.Reader;
 import java.nio.CharBuffer;
 @Deprecated // since 0.17
+@DeprecationReporter.Info(since = "0.17", forRemoval = true)
 class FilteringSequenceFactory {
     
     private static final int BUFFER_CAPACITY = 5000;
@@ -34,6 +37,7 @@ public FilteringSequenceFactory(final CharFilter filter) {
     }
     
     public FilteringSequenceFactory(final int capacity, final CharFilter filter) {
+        DeprecationReporter.logDeprecated(this.getClass());
         this.buffer = CharBuffer.allocate(capacity);
         this.filter = filter;
     }
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java b/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java
index bf979ee0f..30c07b78c 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/HeaderBean.java
@@ -18,9 +18,12 @@
  */ 
 package org.apache.rat.header;
 
+import org.apache.rat.DeprecationReporter;
+
 import java.util.regex.Pattern;
 
 @Deprecated // since 0.17
+@DeprecationReporter.Info(since = "0.17", forRemoval = true)
 public class HeaderBean {
 
     private Pattern headerPattern;
@@ -32,6 +35,7 @@ public HeaderBean() {
     
     public HeaderBean(Pattern headerPattern, boolean match) {
         super();
+        DeprecationReporter.logDeprecated(this.getClass());
         this.headerPattern = headerPattern;
         this.match = match;
     }
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java b/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
index 4c887d238..89b71b0a2 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/HeaderMatcher.java
@@ -18,6 +18,8 @@
  */ 
 package org.apache.rat.header;
 
+import org.apache.rat.DeprecationReporter;
+
 import java.io.IOException;
 import java.io.Reader;
 import java.util.regex.Matcher;
@@ -34,6 +36,7 @@
  *
  */
 @Deprecated // since 0.17
+@DeprecationReporter.Info(since = "0.17", forRemoval = true)
 public class HeaderMatcher {
 
     private final FilteringSequenceFactory factory;
@@ -46,6 +49,7 @@ public HeaderMatcher(final CharFilter filter, final int capacity) {
     }
     
     public HeaderMatcher(final CharFilter filter, final int capacity, final HeaderBean[] headers) {
+        DeprecationReporter.logDeprecated(this.getClass());
         factory = new FilteringSequenceFactory(capacity, filter);
         read = null;
         this.headers = headers;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/header/LineNumberReader.java b/apache-rat-core/src/main/java/org/apache/rat/header/LineNumberReader.java
index 8465ec5a3..1aa3f113e 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/header/LineNumberReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/header/LineNumberReader.java
@@ -18,6 +18,8 @@
  */ 
 package org.apache.rat.header;
 
+import org.apache.rat.DeprecationReporter;
+
 import java.io.IOException;
 import java.io.Reader;
 
@@ -30,12 +32,14 @@
  * thus providing upwards compatibility for RAT.
  */
 @Deprecated // since 0.17
+@DeprecationReporter.Info(since = "0.17", forRemoval = true)
 public class LineNumberReader {
 	private final Reader parent;
 	private boolean previousCharWasCR = false;
 	private int lineNumber = 0;
 
 	public LineNumberReader(Reader pReader) {
+		DeprecationReporter.logDeprecated(this.getClass());
 		parent = pReader;
 	}
 
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicenseFamily.java b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicenseFamily.java
index 3e6cd4cf4..49b358f17 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicenseFamily.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicenseFamily.java
@@ -18,15 +18,21 @@
  */
 package org.apache.rat.license;
 
+import org.apache.rat.DeprecationReporter;
+import org.apache.rat.utils.DefaultLog;
+
 /**
  * An implementation of the ILicenseFamily.
  */
 @Deprecated // remove in v1.0
+@DeprecationReporter.Info(since = "0.17", forRemoval = true, use = "ILicenseFamilyBuilder")
 public class SimpleLicenseFamily  {
     private String familyName;
     private String familyCategory;
 
-    public SimpleLicenseFamily() {}
+    public SimpleLicenseFamily() {
+        DeprecationReporter.logDeprecated(SimpleLicenseFamily.class);
+    }
 
     public void setFamilyName(String familyName) {
         this.familyName = familyName;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/utils/DefaultLog.java b/apache-rat-core/src/main/java/org/apache/rat/utils/DefaultLog.java
index f421121d2..d6215a875 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/utils/DefaultLog.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/utils/DefaultLog.java
@@ -26,7 +26,24 @@ public class DefaultLog implements Log {
     /**
      * The instance of the default log.
      */
-    public static final DefaultLog INSTANCE = new DefaultLog();
+    private static Log INSTANCE = new DefaultLog();
+
+    /**
+     * Retrieves teh DefaultLog instance.
+     * @return the Default log instance.
+     */
+    public static Log getInstance() {
+        return INSTANCE;
+    }
+
+    /**
+     * Sets the default log instance.
+     * If not set an instance of DefaultLog will be returned
+     * @param instance a Log to use as the defult.
+     */
+    public static void setInstance(final Log instance) {
+        INSTANCE = instance == null ? new DefaultLog() : instance;
+    }
     
     private Level level;
 
@@ -60,4 +77,4 @@ public void log(Level level, String msg) {
                 break;
             }
     }
-}
\ No newline at end of file
+}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/utils/ReportingSet.java b/apache-rat-core/src/main/java/org/apache/rat/utils/ReportingSet.java
index fa506a328..68c7cdb86 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/utils/ReportingSet.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/utils/ReportingSet.java
@@ -37,7 +37,7 @@ public class ReportingSet<T> implements SortedSet<T> {
     private final SortedSet<T> delegate;
     private Options duplicateOption = Options.IGNORE;
     private Log.Level duplicateLogLevel = Log.Level.WARN;
-    private Log log = DefaultLog.INSTANCE;
+    private Log log = DefaultLog.getInstance();
     private Function<T,String> duplicateFmt = (t) -> String.format("Duplicate %s (%s) detected %s", t.getClass(), t);
 
     public enum Options { OVERWRITE, IGNORE, FAIL }
@@ -283,4 +283,4 @@ public Object[] toArray() {
     public <T> T[] toArray(T[] a) {
         return delegate.toArray(a);
     }
-}
\ No newline at end of file
+}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/DefaultsTest.java b/apache-rat-core/src/test/java/org/apache/rat/DefaultsTest.java
index fe7f31e51..0a1ee5085 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/DefaultsTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/DefaultsTest.java
@@ -39,7 +39,7 @@ public class DefaultsTest {
 
     @Test
     public void defaultConfigTest() {
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
 
         Set<ILicense> licenses = defaults.getLicenses(LicenseFilter.ALL);
 
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java
index 43f0c546a..89b54a83f 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportConfigurationTest.java
@@ -56,10 +56,10 @@
 import org.apache.rat.license.ILicenseFamily;
 import org.apache.rat.license.LicenseSetFactory.LicenseFilter;
 import org.apache.rat.report.IReportable;
+import org.apache.rat.testhelpers.TestingLog;
 import org.apache.rat.testhelpers.TestingLicense;
 import org.apache.rat.testhelpers.TestingMatcher;
 import org.apache.rat.utils.DefaultLog;
-import org.apache.rat.utils.Log;
 import org.apache.rat.utils.Log.Level;
 import org.apache.rat.utils.ReportingSet.Options;
 import org.apache.rat.walker.NameBasedHiddenFileFilter;
@@ -70,11 +70,11 @@
 public class ReportConfigurationTest {
 
     private ReportConfiguration underTest;
-    private LoggingCapture log;
+    private TestingLog log;
 
     @BeforeEach
     public void setup() {
-        log = new LoggingCapture();
+        log = new TestingLog();
         underTest = new ReportConfiguration(log);
     }
 
@@ -192,7 +192,7 @@ public void filesToIgnoreTest() {
 
         assertThat(underTest.getFilesToIgnore()).isExactlyInstanceOf(FalseFileFilter.class);
 
-        underTest.setFrom(Defaults.builder().build(DefaultLog.INSTANCE));
+        underTest.setFrom(Defaults.builder().build(DefaultLog.getInstance()));
         assertThat(underTest.getFilesToIgnore()).isExactlyInstanceOf(FalseFileFilter.class);
 
         FilenameFilter filter = mock(FilenameFilter.class);
@@ -204,7 +204,7 @@ public void filesToIgnoreTest() {
     public void directoriesToIgnoreTest() {
         assertThat(underTest.getDirectoriesToIgnore()).isExactlyInstanceOf(NameBasedHiddenFileFilter.class);
 
-        underTest.setFrom(Defaults.builder().build(DefaultLog.INSTANCE));
+        underTest.setFrom(Defaults.builder().build(DefaultLog.getInstance()));
         assertThat(underTest.getDirectoriesToIgnore()).isExactlyInstanceOf(NameBasedHiddenFileFilter.class);
 
         underTest.setDirectoriesToIgnore(DirectoryFileFilter.DIRECTORY);
@@ -219,7 +219,7 @@ public void directoriesToIgnoreTest() {
     public void archiveProcessingTest() {
         assertThat(underTest.getArchiveProcessing()).isEqualTo(ReportConfiguration.Processing.NOTIFICATION);
 
-        underTest.setFrom(Defaults.builder().build(DefaultLog.INSTANCE));
+        underTest.setFrom(Defaults.builder().build(DefaultLog.getInstance()));
         assertThat(underTest.getArchiveProcessing()).isEqualTo(ReportConfiguration.Processing.NOTIFICATION);
 
         underTest.setArchiveProcessing(ReportConfiguration.Processing.ABSENCE);
@@ -358,7 +358,7 @@ public void testFlags() {
     public void testValidate() {
         final StringBuilder sb = new StringBuilder();
         try {
-            underTest.validate(s -> sb.append(s));
+            underTest.validate(sb::append);
             fail("should have thrown ConfigurationException");
         } catch (ConfigurationException e) {
             assertThat(e.getMessage()).isEqualTo("Reportable may not be null");
@@ -367,7 +367,7 @@ public void testValidate() {
 
         underTest.setReportable(mock(IReportable.class));
         try {
-            underTest.validate(s -> sb.append(s));
+            underTest.validate(sb::append);
             fail("should have thrown ConfigurationException");
         } catch (ConfigurationException e) {
             assertThat(e.getMessage()).isEqualTo("You must specify at least one license");
@@ -376,7 +376,7 @@ public void testValidate() {
 
         underTest.addLicense(testingLicense("valid", "Validation testing license"));
         try {
-            underTest.validate(s -> sb.append(s));
+            underTest.validate(sb::append);
             fail("should have thrown ConfigurationException");
         } catch (ConfigurationException e) {
             assertThat(e.getMessage()).isEqualTo("Stylesheet must be specified if report styling is selected");
@@ -385,12 +385,12 @@ public void testValidate() {
 
         underTest.setStyleSheet(()->mock(InputStream.class));
         underTest.setStyleReport(false);
-        underTest.validate(s -> sb.append(s));
+        underTest.validate(sb::append);
         assertThat(sb.toString()).isEqualTo("Ignoring stylesheet because styling is not selected");
 
         final StringBuilder sb2 = new StringBuilder();
         underTest.setStyleReport(true);
-        underTest.validate(s -> sb2.append(s));
+        underTest.validate(sb2::append);
         assertThat(sb2.length()).isEqualTo(0);
     }
     
@@ -415,20 +415,20 @@ public void testSetOut() throws IOException {
     public void logFamilyCollisionTest() {
         // setup
         underTest.addFamily(ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("name"));
-        assertFalse(log.captured.toString().contains("CAT"));
+        assertFalse(log.getCaptured().contains("CAT"));
        
         // verify default collision logs WARNING
         underTest.addFamily(ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("name2"));
-        assertTrue(log.captured.toString().contains("WARN"), ()->"default value not WARN");
-        assertTrue(log.captured.toString().contains("CAT"), ()->"'CAT' not found");
+        assertTrue(log.getCaptured().contains("WARN"), "default value not WARN");
+        assertTrue(log.getCaptured().contains("CAT"), "'CAT' not found");
         
         // verify level setting works.
         for (Level l : Level.values()) {
         log.clear();
         underTest.logFamilyCollisions(l);
         underTest.addFamily(ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("name2"));
-        assertTrue(log.captured.toString().contains("CAT"), ()->"'CAT' not found");
-        assertTrue(log.captured.toString().contains(l.name()), ()->"logging not set to "+l);
+        assertTrue(log.getCaptured().contains("CAT"), "'CAT' not found");
+        assertTrue(log.getCaptured().contains(l.name()), "logging not set to "+l);
         }
 
     }
@@ -436,18 +436,18 @@ public void logFamilyCollisionTest() {
     @Test
     public void familyDuplicateOptionsTest() {
         underTest.addFamily(ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("name"));
-        assertFalse(log.captured.toString().contains("CAT"));
+        assertFalse(log.getCaptured().toString().contains("CAT"));
         
         // verify default second setting ignores change
         underTest.addFamily(ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("name2"));
-        assertTrue(log.captured.toString().contains("CAT"));
+        assertTrue(log.getCaptured().toString().contains("CAT"));
         assertEquals("name", underTest.getLicenseFamilies(LicenseFilter.ALL).stream()
                 .filter(s -> s.getFamilyCategory().equals("CAT  ")).map(s -> s.getFamilyName()).findFirst().get());
         
         underTest.familyDuplicateOption(Options.OVERWRITE);
         // verify second setting ignores change
         underTest.addFamily(ILicenseFamily.builder().setLicenseFamilyCategory("CAT").setLicenseFamilyName("name2"));
-        assertTrue(log.captured.toString().contains("CAT"));
+        assertTrue(log.getCaptured().toString().contains("CAT"));
         assertEquals("name2", underTest.getLicenseFamilies(LicenseFilter.ALL).stream()
                 .filter(s -> s.getFamilyCategory().equals("CAT  ")).map(s -> s.getFamilyName()).findFirst().get());
 
@@ -475,7 +475,7 @@ public void logLicenseCollisionTest() {
         underTest.addLicense(ILicense.builder().setId("ID").setName("license name2").setFamily(family.getFamilyCategory())
                 .setMatcher( matcher ).setLicenseFamilies(underTest.getLicenseFamilies(LicenseFilter.ALL))
                 .build());
-        assertTrue(log.captured.toString().contains("WARN"));
+        assertTrue(log.getCaptured().contains("WARN"));
         
         log.clear();
         underTest.logLicenseCollisions(Level.ERROR);
@@ -484,7 +484,7 @@ public void logLicenseCollisionTest() {
         underTest.addLicense(ILicense.builder().setId("ID").setName("license name2").setFamily(family.getFamilyCategory())
                 .setMatcher( matcher ).setLicenseFamilies(underTest.getLicenseFamilies(LicenseFilter.ALL))
                 .build());
-        assertTrue(log.captured.toString().contains("ERROR"));
+        assertTrue(log.getCaptured().contains("ERROR"));
 
     }
     
@@ -503,7 +503,7 @@ public void licenseDuplicateOptionsTest() {
         
         // verify default second setting ignores change
         underTest.addLicense(makeLicense.apply("license name2"));
-        assertTrue(log.captured.toString().contains("WARN"));
+        assertTrue(log.getCaptured().toString().contains("WARN"));
         assertEquals("license name",
                 underTest.getLicenses(LicenseFilter.ALL).stream().map(ILicense::getName).findFirst().get());
         
@@ -577,30 +577,15 @@ public static void validateDefault(ReportConfiguration config) {
         assertThat(config.getCopyrightMessage()).isNull();
         assertThat(config.getFilesToIgnore()).isExactlyInstanceOf(FalseFileFilter.class);
         assertThat(config.isStyleReport()).isTrue();
-        assertThat(config.getStyleSheet()).isNotNull().withFailMessage("Stylesheet should not be null");
-        assertThat(config.getDirectoriesToIgnore()).isNotNull().withFailMessage("Directory filter should not be null");
+        assertThat(config.getStyleSheet()).withFailMessage("Stylesheet should not be null").isNotNull();
+        assertThat(config.getDirectoriesToIgnore()).withFailMessage("Directory filter should not be null").isNotNull();
         assertThat(config.getDirectoriesToIgnore()).isExactlyInstanceOf(NameBasedHiddenFileFilter.class);
         
         validateDefaultApprovedLicenses(config);
         validateDefaultLicenseFamilies(config);
         validateDefaultLicenses(config);
     }
-    
-    private class LoggingCapture implements Log {
 
-        StringBuilder captured = new StringBuilder();
-        
-        public void clear() {
-            captured = new StringBuilder();
-        }
-        
-        @Override
-        public void log(Level level, String msg) {
-            captured.append( String.format("%s: %s%n", level, msg));
-        }
-        
-    }
-    
     static class OutputStreamIntercepter extends OutputStream {
         
         int closeCount = 0;
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 406bc1916..168afeabc 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -18,6 +18,7 @@
  */
 package org.apache.rat;
 
+import static java.lang.String.format;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -39,11 +40,13 @@
 import java.util.Arrays;
 import java.util.SortedSet;
 import java.util.List;
+import java.util.Optional;
 import java.util.function.Predicate;
 import java.util.stream.Stream;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.DeprecatedAttributes;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
 import org.apache.commons.cli.ParseException;
@@ -53,6 +56,7 @@
 import org.apache.commons.io.filefilter.FalseFileFilter;
 import org.apache.rat.report.xml.writer.IXmlWriter;
 import org.apache.rat.report.xml.writer.impl.base.XmlWriter;
+import org.apache.rat.testhelpers.TestingLog;
 import org.apache.rat.testhelpers.TextUtils;
 import org.apache.rat.utils.DefaultLog;
 import org.apache.rat.utils.Log;
@@ -183,6 +187,7 @@ static Stream<Arguments> optionsProvider() {
         List<Arguments> lst = new ArrayList<>();
         String[] args;
         Predicate<ReportConfiguration> test;
+
 //        Report.ARCHIVE
         for (ReportConfiguration.Processing processing : ReportConfiguration.Processing.values()) {
             args = new String[]{"--" + Report.ARCHIVE.getLongOpt(), processing.name().toLowerCase()};
@@ -199,6 +204,7 @@ static Stream<Arguments> optionsProvider() {
         lst.add(Arguments.of(args, test));
 
 //        Report.DIR;
+
 //        Report.DRY_RUN;
         args = new String[]{"--" + Report.DRY_RUN.getLongOpt()};
         test = ReportConfiguration::isDryRun;
@@ -277,9 +283,10 @@ static Stream<Arguments> optionsProvider() {
         }
 
 //        Report LOG_LEVEL
+        DefaultLog log = (DefaultLog) DefaultLog.getInstance();
         for (Log.Level l : Log.Level.values()) {
             args = new String[]{"--" + Report.LOG_LEVEL.getLongOpt(), l.name().toLowerCase()};
-            test = c -> DefaultLog.INSTANCE.getLevel() == l;
+            test = c -> log.getLevel() == l;
             lst.add(Arguments.of(args, test));
         }
 //        Report.NO_DEFAULTS
@@ -328,4 +335,20 @@ static Stream<Arguments> optionsProvider() {
         lst.add(Arguments.of(args, test.negate()));
         return lst.stream();
     }
+
+    @Test
+    public void testDeprecatedUseLogged() throws IOException {
+        TestingLog log = new TestingLog();
+        try {
+            DefaultLog.setInstance(log);
+            String[] args = {longOpt(Report.DIR), "foo", "-a"};
+            ReportConfiguration config = Report.parseCommands(args, (o) -> {
+            }, true);
+
+        } finally {
+            DefaultLog.setInstance(null);
+        }
+        log.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17.0: Use '--'");
+        log.assertContains("WARN: Option [-a] used.  Deprecated for removal since 0.17.0: Use '-A or --addLicense'");
+    }
 }
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
index 599b8b066..38537eedf 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
@@ -209,11 +209,11 @@ private static void checkNode(Document doc, XPath xpath, String resource, Licens
 
     @Test
     public void xmlReportTest() throws Exception {
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
         ByteArrayOutputStream out = new ByteArrayOutputStream();
 
         final String elementsPath = Resources.getResourceDirectory("elements/Source.java");
-        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.INSTANCE);
+        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.getInstance());
         configuration.setStyleReport(false);
         configuration.setFrom(defaults);
         configuration.setDirectoriesToIgnore(HiddenFileFilter.HIDDEN);
@@ -273,11 +273,11 @@ private String licenseOut(String family, String id, String name) {
 
     @Test
     public void plainReportTest() throws Exception {
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
         ByteArrayOutputStream out = new ByteArrayOutputStream();
 
         final String elementsPath = Resources.getResourceDirectory("elements/Source.java");
-        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.INSTANCE);
+        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.getInstance());
         configuration.setFrom(defaults);
         configuration.setDirectoriesToIgnore(HiddenFileFilter.HIDDEN);
         configuration.setReportable(new DirectoryWalker(configuration, new FileDocument(new File(elementsPath))));
@@ -331,11 +331,11 @@ public void plainReportTest() throws Exception {
 
     @Test
     public void UnapprovedLicensesReportTest() throws Exception {
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
         ByteArrayOutputStream out = new ByteArrayOutputStream();
 
         final String elementsPath = Resources.getResourceDirectory("elements/Source.java");
-        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.INSTANCE);
+        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.getInstance());
         configuration.setFrom(defaults);
         configuration.setDirectoriesToIgnore(HiddenFileFilter.HIDDEN);
         configuration.setReportable(new DirectoryWalker(configuration, new FileDocument(new File(elementsPath))));
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/DefaultAnalyserFactoryTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/DefaultAnalyserFactoryTest.java
index f7a29a2cc..58b258e41 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/DefaultAnalyserFactoryTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/DefaultAnalyserFactoryTest.java
@@ -48,7 +48,7 @@ public class DefaultAnalyserFactoryTest {
     public void setUp() throws Exception {
         out = new StringWriter();
         reporter = new SimpleXmlClaimReporter(new XmlWriter(out));
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
         config.addLicense(UnknownLicense.INSTANCE);
         analyser = DefaultAnalyserFactory.createDefaultAnalyser(config);
     }
@@ -107,8 +107,8 @@ public void binaryTypeAnalyser() throws Exception {
     public void archiveTypeAnalyserTest() throws Exception {
         final Document document = new FileDocument(
                 Resources.getResourceFile("/elements/dummy.jar"));
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
         config.setFrom(defaults);
         config.setFilesToIgnore(FalseFileFilter.FALSE);
         analyser = DefaultAnalyserFactory.createDefaultAnalyser(config);
@@ -121,8 +121,8 @@ public void archiveTypeAnalyserTest() throws Exception {
     public void archivesAbsenceTest() throws Exception {
         final Document document = new FileDocument(
                 Resources.getResourceFile("/elements/dummy.jar"));
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
         config.setFrom(defaults);
         config.setFilesToIgnore(FalseFileFilter.FALSE);
         config.setArchiveProcessing(ReportConfiguration.Processing.ABSENCE);
@@ -139,8 +139,8 @@ public void archivesAbsenceTest() throws Exception {
     public void archivesPresenceTest() throws Exception {
         final Document document = new FileDocument(
                 Resources.getResourceFile("/elements/dummy.jar"));
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
         config.setFrom(defaults);
         config.setFilesToIgnore(FalseFileFilter.FALSE);
         config.setArchiveProcessing(ReportConfiguration.Processing.PRESENCE);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/TikaProcessorTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/TikaProcessorTest.java
index ad7607044..20f211345 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/TikaProcessorTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/TikaProcessorTest.java
@@ -57,27 +57,27 @@ public int read() throws IOException {
                 throw new MalformedInputException(0);
             }
         });
-        assertThrows(RatDocumentAnalysisException.class, () -> TikaProcessor.process(DefaultLog.INSTANCE, doc));
+        assertThrows(RatDocumentAnalysisException.class, () -> TikaProcessor.process(DefaultLog.getInstance(), doc));
     }
 
     @Test
     public void UTF16_input() throws Exception {
         Document doc = getDocument(Resources.getResourceStream("/binaries/UTF16_with_signature.xml"));
-        TikaProcessor.process(DefaultLog.INSTANCE, doc);
+        TikaProcessor.process(DefaultLog.getInstance(), doc);
         assertEquals(Document.Type.STANDARD, doc.getMetaData().getDocumentType());
     }
 
     @Test
     public void UTF8_input() throws Exception {
         FileDocument doc = new FileDocument(Resources.getResourceFile("/binaries/UTF8_with_signature.xml"));
-        TikaProcessor.process(DefaultLog.INSTANCE, doc);
+        TikaProcessor.process(DefaultLog.getInstance(), doc);
         assertEquals(Document.Type.STANDARD, doc.getMetaData().getDocumentType());
     }
 
     @Test
     public void missNamedBinaryTest() throws Exception {
         FileDocument doc = new FileDocument(Resources.getResourceFile("/binaries/Image-png.not"));
-        TikaProcessor.process(DefaultLog.INSTANCE, doc);
+        TikaProcessor.process(DefaultLog.getInstance(), doc);
         assertEquals(Document.Type.BINARY, doc.getMetaData().getDocumentType());
     }
 
@@ -85,21 +85,21 @@ public void missNamedBinaryTest() throws Exception {
     @Test
     public void plainTextTest() throws Exception {
         FileDocument doc = new FileDocument(Resources.getResourceFile("/elements/Text.txt"));
-        TikaProcessor.process(DefaultLog.INSTANCE, doc);
+        TikaProcessor.process(DefaultLog.getInstance(), doc);
         assertEquals(Document.Type.STANDARD, doc.getMetaData().getDocumentType());
     }
 
     @Test
     public void emptyFileTest() throws Exception {
         FileDocument doc = new FileDocument(Resources.getResourceFile("/elements/sub/Empty.txt"));
-        TikaProcessor.process(DefaultLog.INSTANCE, doc);
+        TikaProcessor.process(DefaultLog.getInstance(), doc);
         assertEquals(Document.Type.STANDARD, doc.getMetaData().getDocumentType());
     }
 
     @Test
     public void javaFileWithChineseCharacters_RAT301() throws Exception {
         FileDocument doc = new FileDocument(Resources.getResourceFile("/tikaFiles/standard/ChineseCommentsJava.java"));
-        TikaProcessor.process(DefaultLog.INSTANCE, doc);
+        TikaProcessor.process(DefaultLog.getInstance(), doc);
         assertEquals(Document.Type.STANDARD, doc.getMetaData().getDocumentType());
     }
 
@@ -113,7 +113,7 @@ public void testTikaFiles() throws RatDocumentAnalysisException, IOException {
             if (typeDir.isDirectory()) {
                 for (File file : Objects.requireNonNull(typeDir.listFiles())) {
                     Document doc = new FileDocument(file);
-                    String mimeType = TikaProcessor.process(DefaultLog.INSTANCE, doc);
+                    String mimeType = TikaProcessor.process(DefaultLog.getInstance(), doc);
                     statistic.incCounter(doc.getMetaData().getDocumentType(), 1);
                     assertEquals( docType, doc.getMetaData().getDocumentType(), () -> "Wrong type for "+file.toString());
                     unseenMime.remove(mimeType);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AbstractLicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AbstractLicenseTest.java
index b3d38a2ea..80f94d109 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AbstractLicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/license/AbstractLicenseTest.java
@@ -57,7 +57,7 @@ protected AbstractLicenseTest() {
     @BeforeEach
     public void setup() {
         data = new MetaData();
-        defaults = Defaults.builder().build(DefaultLog.INSTANCE);
+        defaults = Defaults.builder().build(DefaultLog.getInstance());
     }
 
     protected ILicense extractCategory(String famId, String id) {
diff --git a/apache-rat-core/src/test/java/org/apache/rat/annotation/TestLicenseAppender.java b/apache-rat-core/src/test/java/org/apache/rat/annotation/TestLicenseAppender.java
index a6b6040b9..dcc11a188 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/annotation/TestLicenseAppender.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/annotation/TestLicenseAppender.java
@@ -72,7 +72,7 @@ private void commonTestTemplate(String relativeName, FileCreator creator, NewFil
 
         createTestFile(name, creator);
 
-        ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.INSTANCE);
+        ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.getInstance());
         appender.append(new File(name));
 
         try (BufferedReader r = new BufferedReader(new FileReader(name + ".new"))) {
@@ -106,7 +106,7 @@ public void createFile(Writer writer) throws IOException {
 
         File file = new File(filename);
         file.deleteOnExit();
-        ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.INSTANCE);
+        ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.getInstance());
         appender.append(file);
 
         File newFile = new File(filename + ".new");
@@ -470,7 +470,7 @@ public void createFile(Writer writer) throws IOException {
     public void fileWithBOM() throws IOException {
         File f = Resources.getResourceFile("violations/FilterTest.cs");
 
-        ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.INSTANCE);
+        ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.getInstance());
         appender.append(f);
 
         try (BufferedReader r = new BufferedReader(new FileReader(f.getAbsolutePath() + ".new"))) {
@@ -651,7 +651,7 @@ public void testForced() throws IOException {
         try {
             createTestFile(name, phpCreator);
 
-            ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.INSTANCE);
+            ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.getInstance());
             appender.setForce(true);
             appender.append(new File(name));
 
@@ -684,7 +684,7 @@ public void testExecutePermsPreserved() throws IOException {
             createTestFile(name, phpCreator);
             assertTrue(new File(name).setExecutable(true), "Unable to set executable flag");
 
-            ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.INSTANCE);
+            ApacheV2LicenseAppender appender = new ApacheV2LicenseAppender(DefaultLog.getInstance());
             appender.setForce(true);
             appender.append(new File(name));
 
diff --git a/apache-rat-core/src/test/java/org/apache/rat/configuration/XMLConfigurationWriterTest.java b/apache-rat-core/src/test/java/org/apache/rat/configuration/XMLConfigurationWriterTest.java
index 82c10c497..3b9d8960d 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/configuration/XMLConfigurationWriterTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/configuration/XMLConfigurationWriterTest.java
@@ -46,8 +46,8 @@ public class XMLConfigurationWriterTest {
 
     @Test
     public void roundTrip() throws RatException {
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
-        config.setFrom(Defaults.builder().build(DefaultLog.INSTANCE));
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
+        config.setFrom(Defaults.builder().build(DefaultLog.getInstance()));
         config.listFamilies(LicenseFilter.ALL);
         config.listLicenses(LicenseFilter.ALL);
         XMLConfigurationWriter underTest = new XMLConfigurationWriter(config);
@@ -63,8 +63,8 @@ public void roundTrip() throws RatException {
     
     @Test
     public void testGen() throws Exception {
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
-        config.setFrom(Defaults.builder().build(DefaultLog.INSTANCE));
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
+        config.setFrom(Defaults.builder().build(DefaultLog.getInstance()));
         config.listFamilies(LicenseFilter.ALL);
         config.listLicenses(LicenseFilter.ALL);
         XMLConfigurationWriter underTest = new XMLConfigurationWriter(config);
@@ -86,4 +86,4 @@ public void testGen() throws Exception {
         assertEquals(0, any.getChildNodes().getLength());
         assertNotNull(any.getAttributes().getNamedItem("resource"), "'resource' attribute missing");
     }
-}
\ No newline at end of file
+}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/configuration/builders/TextBuilderTest.java b/apache-rat-core/src/test/java/org/apache/rat/configuration/builders/TextBuilderTest.java
index fa22f55f0..a82a3c77a 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/configuration/builders/TextBuilderTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/configuration/builders/TextBuilderTest.java
@@ -54,8 +54,8 @@ public void fullTextMatcherTest() throws NoSuchMethodException, SecurityExceptio
         attributes.put("id", "IDValue");
 
         Description description = DescriptionBuilder.buildMap(underTest.builtClass());
-        description.setChildren(DefaultLog.INSTANCE, underTest, attributes);
-        description.setChild(DefaultLog.INSTANCE, underTest, "simpleText", "example text");
+        description.setChildren(DefaultLog.getInstance(), underTest, attributes);
+        description.setChild(DefaultLog.getInstance(), underTest, "simpleText", "example text");
 
         SimpleTextMatcher m = underTest.build();
         assertEquals("example text", m.getSimpleText());
@@ -84,8 +84,8 @@ public void simpleTextMatcherTest() throws NoSuchMethodException, SecurityExcept
         TextBuilder underTest = new TextBuilder();
 
         Description description = DescriptionBuilder.buildMap(underTest.builtClass());
-        description.setChildren(DefaultLog.INSTANCE, underTest, attributes);
-        description.setChild(DefaultLog.INSTANCE, underTest, "simpleText", "exampletext");
+        description.setChildren(DefaultLog.getInstance(), underTest, attributes);
+        description.setChild(DefaultLog.getInstance(), underTest, "simpleText", "exampletext");
 
         SimpleTextMatcher m = underTest.build();
         assertEquals("exampletext", m.getSimpleText());
diff --git a/apache-rat-core/src/test/java/org/apache/rat/license/SimpleLicenseTest.java b/apache-rat-core/src/test/java/org/apache/rat/license/SimpleLicenseTest.java
index 0bd5a747d..81a144f45 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/license/SimpleLicenseTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/license/SimpleLicenseTest.java
@@ -48,11 +48,11 @@ public void descriptionTest() throws IllegalAccessException, IllegalArgumentExce
         Map<String, Description> children = underTest.getChildren();
         assertEquals(6, children.size());
         assertTrue(children.containsKey("id"));
-        assertEquals("TestingId", children.get("id").getParamValue(DefaultLog.INSTANCE, lic));
+        assertEquals("TestingId", children.get("id").getParamValue(DefaultLog.getInstance(), lic));
         assertTrue(children.containsKey("name"));
-        assertEquals("My testing license", children.get("name").getParamValue(DefaultLog.INSTANCE, lic));
+        assertEquals("My testing license", children.get("name").getParamValue(DefaultLog.getInstance(), lic));
         assertTrue(children.containsKey("note"));
-        assertEquals("These are the notes", children.get("note").getParamValue(DefaultLog.INSTANCE, lic));
+        assertEquals("These are the notes", children.get("note").getParamValue(DefaultLog.getInstance(), lic));
 
         assertTrue(children.containsKey("matcher"));
         assertEquals(ComponentType.PARAMETER, children.get("matcher").getType());
diff --git a/apache-rat-core/src/test/java/org/apache/rat/policy/DefaultPolicyTest.java b/apache-rat-core/src/test/java/org/apache/rat/policy/DefaultPolicyTest.java
index c2f23396c..abe7401f2 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/policy/DefaultPolicyTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/policy/DefaultPolicyTest.java
@@ -61,7 +61,7 @@ public class DefaultPolicyTest {
 
     @BeforeEach
     public void setUp() throws Exception {
-        defaults = Defaults.builder().build(DefaultLog.INSTANCE);
+        defaults = Defaults.builder().build(DefaultLog.getInstance());
         policy = new DefaultPolicy(defaults.getLicenseFamilies(LicenseFilter.APPROVED));
         document = new TestingDocument("subject");
     }
diff --git a/apache-rat-core/src/test/java/org/apache/rat/report/ConfigurationReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/report/ConfigurationReportTest.java
index 9759c4f20..f9b4e8c9e 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/report/ConfigurationReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/report/ConfigurationReportTest.java
@@ -52,10 +52,10 @@ public class ConfigurationReportTest {
 
     @BeforeEach
     public void setup() {
-        reportConfiguration = new ReportConfiguration(DefaultLog.INSTANCE);
+        reportConfiguration = new ReportConfiguration(DefaultLog.getInstance());
         reportConfiguration.listFamilies(LicenseFilter.ALL);
         reportConfiguration.listLicenses(LicenseFilter.ALL);
-        reportConfiguration.setFrom(Defaults.builder().build(DefaultLog.INSTANCE));
+        reportConfiguration.setFrom(Defaults.builder().build(DefaultLog.getInstance()));
 
         sw = new StringWriter();
         writer = new XmlWriter(sw);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportFactoryTest.java b/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportFactoryTest.java
index dcba58596..bcc49b972 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportFactoryTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportFactoryTest.java
@@ -72,9 +72,9 @@ private void report(DirectoryWalker directory, RatReport report) throws Exceptio
     @Test
     public void standardReport() throws Exception {
         final String elementsPath = Resources.getResourceDirectory("elements/Source.java");
-        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.INSTANCE);
+        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.getInstance());
         final TestingLicense testingLicense = new TestingLicense("TEST", new TestingMatcher(true), family);
-        configuration.setFrom(Defaults.builder().build(DefaultLog.INSTANCE));
+        configuration.setFrom(Defaults.builder().build(DefaultLog.getInstance()));
         configuration.setDirectoriesToIgnore(HiddenFileFilter.HIDDEN);
         DirectoryWalker directory = new DirectoryWalker(configuration, new FileDocument(new File(elementsPath)));
         final ClaimStatistic statistic = new ClaimStatistic();
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
new file mode 100644
index 000000000..aad7010d5
--- /dev/null
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
@@ -0,0 +1,48 @@
+package org.apache.rat.testhelpers;
+
+import org.apache.rat.utils.Log;
+
+/**
+ * Log that captures output for later review.
+ */
+public class TestingLog implements Log {
+
+    private StringBuilder captured = new StringBuilder();
+
+    /**
+     * Clears the captured buffer
+     */
+    public void clear() {
+        captured = new StringBuilder();
+    }
+
+    /**
+     * Gets the captured log entries.
+     * @return the log entries
+     */
+    public String getCaptured() {
+        return captured.toString();
+    }
+
+    public void assertContains(String expected) {
+        TextUtils.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17.0: Use '--'", captured.toString());
+    }
+
+    public void assertNotContains(String expected) {
+        TextUtils.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17.0: Use '--'", captured.toString());
+    }
+
+    public void assertContainsPattern(String pattern) {
+        TextUtils.assertPatternInTarget(pattern, captured.toString());
+    }
+
+    public void assertNotContainsPattern(String pattern) {
+        TextUtils.assertPatternNotInTarget(pattern, captured.toString());
+    }
+
+    @Override
+    public void log(Level level, String msg) {
+        captured.append(String.format("%s: %s%n", level, msg));
+    }
+
+}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/walker/DirectoryWalkerTest.java b/apache-rat-core/src/test/java/org/apache/rat/walker/DirectoryWalkerTest.java
index 5c946e7f3..4c7f2a845 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/walker/DirectoryWalkerTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/walker/DirectoryWalkerTest.java
@@ -54,7 +54,7 @@ private static void fileWriter(File dir, String name, String contents) throws IO
 
     @BeforeEach
     public void beforeEach() {
-        reportConfiguration = new ReportConfiguration(DefaultLog.INSTANCE);
+        reportConfiguration = new ReportConfiguration(DefaultLog.getInstance());
     }
 
     @BeforeAll
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 6de0f7a4a..b06c33e16 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -72,19 +72,19 @@ https://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd
     </release>
     -->
     <release version="0.17-SNAPSHOT" date="xxxx-yy-zz" description="Current SNAPSHOT - release to be done">
-      <action issue="RAT-377" type="add" dev="claudenw">
-        Added ability to specify the level of reporting on STANDARD files within a project.  This necessitated an addition
-        of a command line option "standard" to limit specify the level of detail in the STANDARD file reporting.  See command line
-        help for more details.  By default, there is no change in the reporting and only the presence of archives are reported.
+        <action issue="RAT-377" type="add" dev="claudenw">
+            Added ability to specify the level of reporting on STANDARD files within a project.  This necessitated an addition
+            of a command line option "standard" to limit specify the level of detail in the STANDARD file reporting.  See command line
+            help for more details.  By default, there is no change in the reporting and only the presence of archives are reported.
 
-        Change also fixed a major issue in license sorting.  Resulting in a change in order and expanding the name space for licenses.
-        Licenses now must have a unique id within the family name space. (e.g. family1/one is different from family2/one).
-      </action>
-      <action issue="RAT-190" type="fix" dev="claudenw">
-        Javascript (.js) files not processed as text.
-        Fixed as part of the Tika change.
-      </action>
-      <action issue="RAT-256" type="fix" dev="claudenw">
+            Change also fixed a major issue in license sorting.  Resulting in a change in order and expanding the name space for licenses.
+            Licenses now must have a unique id within the family name space. (e.g. family1/one is different from family2/one).
+        </action>
+        <action issue="RAT-190" type="fix" dev="claudenw">
+            Javascript (.js) files not processed as text.
+            Fixed as part of the Tika change.
+        </action>
+        <action issue="RAT-265" type="fix" dev="claudenw">
         Fixed the filter compilation so that illegal regex do not cause other filters to be ignored.
         Updated the logging to only log a warning when at least one filter was skipped.
       </action>

From 8c24374e1cc6830c0a2737c60060f68e76cdcc47 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Sun, 12 May 2024 11:59:08 +0200
Subject: [PATCH 03/19] cleaned up checkstyle and logging issues

---
 .../org/apache/rat/DeprecationReporter.java   |  66 +++++--
 .../src/main/java/org/apache/rat/Report.java  | 173 ++++++++++--------
 .../java/org/apache/rat/api/Document.java     |  14 +-
 .../document/CompositeDocumentException.java  |  39 ----
 .../rat/license/SimpleLicenseFamily.java      |   1 -
 .../java/org/apache/rat/report/RatReport.java |   2 +-
 .../org/apache/rat/walker/ArchiveWalker.java  |  15 +-
 .../apache/rat/walker/DirectoryWalker.java    |  14 +-
 .../java/org/apache/rat/walker/Walker.java    |   3 +-
 .../test/java/org/apache/rat/ReportTest.java  |   8 +-
 .../java/org/apache/rat/ReporterTest.java     |   9 +-
 .../apache/rat/testhelpers/TestingLog.java    |  18 ++
 .../org/apache/rat/mp/AbstractRatMojo.java    |   2 +-
 .../java/org/apache/rat/anttasks/Report.java  |   1 -
 14 files changed, 191 insertions(+), 174 deletions(-)
 delete mode 100644 apache-rat-core/src/main/java/org/apache/rat/document/CompositeDocumentException.java

diff --git a/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java b/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
index b15c31905..99ad3f9aa 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
@@ -1,7 +1,26 @@
+/*
+ * 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.                                           *
+ */
 package org.apache.rat;
 
 import org.apache.commons.cli.Option;
 import org.apache.rat.utils.DefaultLog;
+import org.apache.rat.utils.Log;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -14,28 +33,35 @@
 /**
  * Reporting methods for deprecated objects.
  */
-public class DeprecationReporter {
+public final class DeprecationReporter {
+
+    private DeprecationReporter() {
+        // DO NOT INSTANTIATE
+    }
     /**
      * Deprecated Command line option consumer.
      */
-    public static Consumer<Option> LOG_DEPRECATED = o -> {
-        StringBuilder buff = new StringBuilder();
-        if (o.getOpt() != null) {
-            buff.append("-").append(o.getOpt());
-            if (o.getLongOpt() != null) {
-                buff.append(", --").append(o.getLongOpt());
+
+    public static Consumer<Option> getLogReporter(Log log) {
+        return  o -> {
+            StringBuilder buff = new StringBuilder();
+            if (o.getOpt() != null) {
+                buff.append("-").append(o.getOpt());
+                if (o.getLongOpt() != null) {
+                    buff.append(", --").append(o.getLongOpt());
+                }
+            } else {
+                buff.append("--").append(o.getLongOpt());
             }
-        } else {
-            buff.append("--").append(o.getLongOpt());
-        }
-        DefaultLog.getInstance().warn(format("Option [%s] used.  %s", buff, o.getDeprecated().toString()));
-    };
+            log.warn(format("Option [%s] used.  %s", buff, o.getDeprecated().toString()));
+        };
+    }
 
     /**
      * Log Deprecated class use.
      * @param clazz the Deprecated class to log
      */
-    public static void logDeprecated(Class<?> clazz) {
+    public static void logDeprecated(final Class<?> clazz) {
         if (clazz.getAnnotation(Deprecated.class) != null) {
             StringBuilder sb = new StringBuilder(format("Deprecated class used: %s ", clazz));
             Info info = clazz.getAnnotation(Info.class);
@@ -43,7 +69,7 @@ public static void logDeprecated(Class<?> clazz) {
                 if (info.forRemoval()) {
                     sb.append("  Scheduled for removal");
                     if (!info.since().isEmpty()) {
-                        sb.append( " since ").append(info.since());
+                        sb.append(" since ").append(info.since());
                     }
                     sb.append(".");
                 } else if (!info.since().isEmpty()) {
@@ -57,6 +83,18 @@ public static void logDeprecated(Class<?> clazz) {
         }
     }
 
+    /**
+     * Log deprecated options
+     * @param log The log to write to.
+     * @param option potentially deprecated option to log.
+     */
+    // TODO remove this when commons-cli 1.7.1 or higher is available
+    public static void logDeprecated(final Log log, final Option option) {
+        if (option.isDeprecated()) {
+            getLogReporter(log).accept(option);
+        }
+    }
+
     /**
      * Annotation to provide deprecation information for Java8.
      * TODO remove this when Java 8 no longer supported.
diff --git a/apache-rat-core/src/main/java/org/apache/rat/Report.java b/apache-rat-core/src/main/java/org/apache/rat/Report.java
index 457bac36e..436a4c564 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/Report.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/Report.java
@@ -73,7 +73,10 @@
 /**
  * The CLI based configuration object for report generation.
  */
-public class Report {
+public final class Report {
+
+    private static final int HELP_WIDTH = 130;
+    private static final int HELP_PADDING = 5;
 
     /*
     If there are changes to Options the example output should be regenerated and placed in
@@ -87,12 +90,14 @@ public class Report {
             "Rat relies on heuristics: it may miss issues"
     };
 
-    private enum StyleSheets { PLAIN("plain-rat", "The default style"),
+    private enum StyleSheets {
+        PLAIN("plain-rat", "The default style"),
         MISSING_HEADERS("missing-headers", "Produces a report of files that are missing headers"),
         UNAPPROVED_LICENSES("unapproved-licenses", "Produces a report of the files with unapproved licenses");
         private final String arg;
         private final String desc;
-        StyleSheets(String arg, String description) {
+
+        StyleSheets(final String arg, final String description) {
             this.arg = arg;
             this.desc = description;
         }
@@ -131,12 +136,13 @@ public String desc() {
     /**
      * Adds license headers to files missing headers.
      */
-    private static final DeprecatedAttributes addAttributes = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17.0")
-                                    .setDescription("Use '-A' or --addLicense instead.").get();
+    // TODO rework when Commons-CLI version 1.7.1 or higher is available.
+    private static final DeprecatedAttributes ADD_ATTRIBUTES = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17.0")
+            .setDescription("Use '-A' or --addLicense instead.").get();
     static final OptionGroup ADD = new OptionGroup()
             .addOption(Option.builder("a").hasArg(false)
-                    .desc(format( "[%s]", addAttributes))
-                    .deprecated( addAttributes )
+                    .desc(format("[%s]", ADD_ATTRIBUTES))
+                    .deprecated(ADD_ATTRIBUTES)
                     .build())
 
             .addOption(new Option("A", "addLicense", false,
@@ -147,17 +153,19 @@ public String desc() {
 
     /**
      * Defines the output for the file.
+     *
      * @since 0.16.0
      */
     static final Option OUT = Option.builder().option("o").longOpt("out").hasArg()
             .desc("Define the output file where to write a report to (default is System.out).")
             .converter(Converter.FILE).build();
 
-    static final DeprecatedAttributes dirAttributes = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17.0")
+    // TODO rework when commons-cli 1.7.1 or higher is available.
+    static final DeprecatedAttributes DIR_ATTRIBUTES = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17.0")
             .setDescription("Use '--'").get();
     static final Option DIR = Option.builder().option("d").longOpt("dir").hasArg()
-            .desc(format( "[%s] %s", dirAttributes, "Used to indicate end of list when using --exclude.")).argName("DirOrArchive")
-            .deprecated( dirAttributes).build();
+            .desc(format("[%s] %s", DIR_ATTRIBUTES, "Used to indicate end of list when using --exclude.")).argName("DirOrArchive")
+            .deprecated(DIR_ATTRIBUTES).build();
 
     /**
      * Forces changes to be written to new files.
@@ -192,8 +200,8 @@ public String desc() {
      * The stylesheet to use to style the XML output.
      */
     static final Option STYLESHEET_CLI = Option.builder("s").longOpt("stylesheet").hasArg().argName("StyleSheet")
-            .desc("XSLT stylesheet to use when creating the report.  Not compatible with -x.  " +
-                    "Either an external xsl file may be specified or one of the internal named sheets: plain-rat (default), missing-headers, or unapproved-licenses")
+            .desc("XSLT stylesheet to use when creating the report.  Not compatible with -x. "
+                    + "Either an external xsl file may be specified or one of the internal named sheets: plain-rat (default), missing-headers, or unapproved-licenses")
             .build();
     /**
      * Produce help
@@ -201,6 +209,7 @@ public String desc() {
     static final Option HELP = new Option("h", "help", false, "Print help for the RAT command line interface and exit.");
     /**
      * Flag to identify a file with license definitions.
+     *
      * @since 0.16.0
      */
     static final Option LICENSES = Option.builder().longOpt("licenses").hasArgs().argName("FileOrURI")
@@ -278,13 +287,13 @@ public String desc() {
             .build();
 
 
-    private static void logDeprecated(Option option) {
+    private static void logDeprecated(final Option option) {
         if (option.isDeprecated()) {
             DeprecationReporter.LOG_DEPRECATED.accept(option);
         }
     }
 
-    private static String asString(Object[] args) {
+    private static String asString(final Object[] args) {
         return Arrays.stream(args).map(Object::toString).collect(Collectors.joining(", "));
     }
 
@@ -295,7 +304,7 @@ private static String asString(Object[] args) {
      * @param args the arguments.
      * @throws Exception on error.
      */
-    public static void main(String[] args) throws Exception {
+    public static void main(final String[] args) throws Exception {
         ReportConfiguration configuration = parseCommands(args, Report::printUsage);
         if (configuration != null) {
             configuration.validate(DefaultLog.getInstance()::error);
@@ -311,7 +320,7 @@ public static void main(String[] args) throws Exception {
      * @return a ReportConfiguration or null if Help was printed.
      * @throws IOException on error.
      */
-    public static ReportConfiguration parseCommands(String[] args, Consumer<Options> helpCmd) throws IOException {
+    public static ReportConfiguration parseCommands(final String[] args, final Consumer<Options> helpCmd) throws IOException {
         return parseCommands(args, helpCmd, false);
     }
 
@@ -324,26 +333,31 @@ public static ReportConfiguration parseCommands(String[] args, Consumer<Options>
      * @return a ReportConfiguration or null if Help was printed.
      * @throws IOException on error.
      */
-    public static ReportConfiguration parseCommands(String[] args, Consumer<Options> helpCmd, boolean noArgs) throws IOException {
+    public static ReportConfiguration parseCommands(final String[] args, final Consumer<Options> helpCmd, final boolean noArgs) throws IOException {
         Options opts = buildOptions();
         CommandLine cl;
-        Consumer<Option> logDeprecated = o -> DefaultLog.INSTANCE.warn( format("Deprecated option %s used.  %s", o.getOpt(), o.getDeprecated().toString()));
+        Log log = DefaultLog.getInstance();
         try {
-            //DefaultParser.builder().setDeprecatedHandler()
-            cl = DefaultParser.builder().setDeprecatedHandler(logDeprecated).build().parse(opts, args);
+            cl = DefaultParser.builder().setDeprecatedHandler(DeprecationReporter.getLogReporter(log)).build().parse(opts, args);
         } catch (ParseException e) {
-            DefaultLog.INSTANCE.error(e.getMessage());
-            DefaultLog.INSTANCE.error("Please use the \"--help\" option to see a list of valid commands and options");
+            log.error(e.getMessage());
+            log.error("Please use the \"--help\" option to see a list of valid commands and options");
             System.exit(1);
             return null; // dummy return (won't be reached) to avoid Eclipse complaint about possible NPE
             // for "cl"
         }
 
         if (cl.hasOption(LOG_LEVEL)) {
-            try {
-                DefaultLog.INSTANCE.setLevel(cl.getParsedOptionValue(LOG_LEVEL));
-            } catch (ParseException e) {
-                logParseException(e, LOG_LEVEL, cl, DefaultLog.INSTANCE.getLevel());
+            DeprecationReporter.logDeprecated(log, LOG_LEVEL);
+            if (log instanceof DefaultLog) {
+                DefaultLog dLog = (DefaultLog) log;
+                try {
+                    dLog.setLevel(cl.getParsedOptionValue(LOG_LEVEL));
+                } catch (ParseException e) {
+                    logParseException(log, e, LOG_LEVEL, cl, dLog.getLevel());
+                }
+            } else {
+                log.error("log was not a DefaultLog instance.  LogLevel not set.");
             }
         }
         if (cl.hasOption(HELP)) {
@@ -351,64 +365,66 @@ public static ReportConfiguration parseCommands(String[] args, Consumer<Options>
             return null;
         }
 
+        String[] clArgs;
         if (!noArgs) {
-            args = cl.getArgs();
-            if (args == null || args.length != 1) {
+            clArgs = cl.getArgs();
+            if (clArgs == null || clArgs.length != 1) {
                 helpCmd.accept(opts);
                 return null;
             }
         } else {
-            args = new String[]{null};
+            clArgs = new String[]{null};
         }
-        return createConfiguration(args[0], cl);
+        return createConfiguration(log, clArgs[0], cl);
     }
 
-    private static void logParseException(ParseException e, Option opt, CommandLine cl, Object dflt) {
-        DefaultLog.getInstance().warn(format("Invalid %s specified: %s ", opt.getOpt(), cl.getOptionValue(opt)));
-        DefaultLog.getInstance().warn(format("%s set to: %s", opt.getOpt(), dflt));
-        DefaultLog.getInstance().debug(e);
+    private static void logParseException(final Log log, final ParseException e, final Option opt, final CommandLine cl, final Object dflt) {
+        log.warn(format("Invalid %s specified: %s ", opt.getOpt(), cl.getOptionValue(opt)));
+        log.warn(format("%s set to: %s", opt.getOpt(), dflt));
+        log.debug(e);
     }
 
-    static ReportConfiguration createConfiguration(String baseDirectory, CommandLine cl) throws IOException {
-        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.getInstance());
+    static ReportConfiguration createConfiguration(final Log log, final String baseDirectory, final CommandLine cl) throws IOException {
+        final ReportConfiguration configuration = new ReportConfiguration(log);
 
         if (cl.hasOption(DIR)) {
-            logDeprecated(DIR);
+            DeprecationReporter.logDeprecated(log, DIR);
         }
 
         if (cl.hasOption(DRY_RUN)) {
-            logDeprecated(DRY_RUN);
+            DeprecationReporter.logDeprecated(log, DRY_RUN);
             configuration.setDryRun(cl.hasOption(DRY_RUN));
         }
 
         if (cl.hasOption(LIST_FAMILIES)) {
-            logDeprecated(LIST_FAMILIES);
+            DeprecationReporter.logDeprecated(log, LIST_FAMILIES);
             try {
                 configuration.listFamilies(cl.getParsedOptionValue(LIST_FAMILIES));
             } catch (ParseException e) {
-                logParseException(e, LIST_FAMILIES, cl, Defaults.LIST_FAMILIES);
+                logParseException(log, e, LIST_FAMILIES, cl, Defaults.LIST_FAMILIES);
             }
         }
 
         if (cl.hasOption(LIST_LICENSES)) {
-            logDeprecated(LIST_LICENSES);
+            DeprecationReporter.logDeprecated(log, LIST_LICENSES);
             try {
                 configuration.listLicenses(cl.getParsedOptionValue(LIST_LICENSES));
             } catch (ParseException e) {
-                logParseException(e, LIST_LICENSES, cl, Defaults.LIST_LICENSES);
+                logParseException(log, e, LIST_LICENSES, cl, Defaults.LIST_LICENSES);
             }
         }
 
         if (cl.hasOption(ARCHIVE)) {
-            logDeprecated(ARCHIVE);
+            DeprecationReporter.logDeprecated(log, ARCHIVE);
             try {
                 configuration.setArchiveProcessing(cl.getParsedOptionValue(ARCHIVE));
             } catch (ParseException e) {
-                logParseException(e, ARCHIVE, cl, Defaults.ARCHIVE_PROCESSING);
+                logParseException(log, e, ARCHIVE, cl, Defaults.ARCHIVE_PROCESSING);
             }
         }
 
         if (cl.hasOption(STANDARD)) {
+            DeprecationReporter.logDeprecated(log, STANDARD);
             try {
                 configuration.setStandardProcessing(cl.getParsedOptionValue(STANDARD));
             } catch (ParseException e) {
@@ -417,79 +433,83 @@ static ReportConfiguration createConfiguration(String baseDirectory, CommandLine
         }
 
         if (cl.hasOption(OUT)) {
-            logDeprecated(OUT);
+            DeprecationReporter.logDeprecated(log, OUT);
             try {
                 configuration.setOut((File) cl.getParsedOptionValue(OUT));
             } catch (ParseException e) {
-                logParseException(e, OUT, cl, "System.out");
+                logParseException(log, e, OUT, cl, "System.out");
             }
         }
 
         if (cl.hasOption(SCAN_HIDDEN_DIRECTORIES)) {
-            logDeprecated(SCAN_HIDDEN_DIRECTORIES);
+            DeprecationReporter.logDeprecated(log, SCAN_HIDDEN_DIRECTORIES);
             configuration.setDirectoriesToIgnore(FalseFileFilter.FALSE);
         }
 
         if (ADD.getSelected() != null) {
             // @TODO remove this block when Commons-cli version 1.7.1 or higher is used
-            Arrays.stream(cl.getOptions()).filter( o -> o.getOpt().equals("a")).forEach( o -> cl.hasOption(o.getOpt()));
-            if (cl.hasOption(FORCE)) logDeprecated(FORCE);
-            if (cl.hasOption(COPYRIGHT)) logDeprecated(COPYRIGHT);
+            Arrays.stream(cl.getOptions()).filter(o -> o.getOpt().equals("a")).forEach(o -> cl.hasOption(o.getOpt()));
+            if (cl.hasOption(FORCE)) {
+                DeprecationReporter.logDeprecated(log, FORCE);
+            }
+            if (cl.hasOption(COPYRIGHT)) {
+                DeprecationReporter.logDeprecated(log, COPYRIGHT);
+            }
             // remove that block ---^
             configuration.setAddLicenseHeaders(cl.hasOption(FORCE) ? AddLicenseHeaders.FORCED : AddLicenseHeaders.TRUE);
             configuration.setCopyrightMessage(cl.getOptionValue(COPYRIGHT));
         }
 
         if (cl.hasOption(EXCLUDE_CLI)) {
-            logDeprecated(EXCLUDE_CLI);
+            DeprecationReporter.logDeprecated(log, EXCLUDE_CLI);
             String[] excludes = cl.getOptionValues(EXCLUDE_CLI);
             if (excludes != null) {
-                final FilenameFilter filter = parseExclusions(Arrays.asList(excludes));
+                final FilenameFilter filter = parseExclusions(log, Arrays.asList(excludes));
                 configuration.setFilesToIgnore(filter);
             }
         } else if (cl.hasOption(EXCLUDE_FILE_CLI)) {
-            logDeprecated(EXCLUDE_FILE_CLI);
+            DeprecationReporter.logDeprecated(log, EXCLUDE_FILE_CLI);
             String excludeFileName = cl.getOptionValue(EXCLUDE_FILE_CLI);
             if (excludeFileName != null) {
-                final FilenameFilter filter = parseExclusions(
+                final FilenameFilter filter = parseExclusions(log,
                         FileUtils.readLines(new File(excludeFileName), StandardCharsets.UTF_8));
                 configuration.setFilesToIgnore(filter);
             }
         }
 
         if (cl.hasOption(XML)) {
-            logDeprecated(XML);
+            DeprecationReporter.logDeprecated(log, XML);
             configuration.setStyleReport(false);
         } else {
             configuration.setStyleReport(true);
             if (cl.hasOption(STYLESHEET_CLI)) {
-                logDeprecated(STYLESHEET_CLI);
+                DeprecationReporter.logDeprecated(log, STYLESHEET_CLI);
                 String[] style = cl.getOptionValues(STYLESHEET_CLI);
                 if (style.length != 1) {
-                    DefaultLog.getInstance().error("Please specify a single stylesheet");
+                    log.error("Please specify a single stylesheet");
                     System.exit(1);
                 }
 
                 URL url = Report.class.getClassLoader().getResource(String.format("org/apache/rat/%s.xsl", style[0]));
-                IOSupplier<InputStream> ioSupplier = (url == null) ?
-                        () -> Files.newInputStream(Paths.get(style[0])) :
-                        url::openStream;
+                IOSupplier<InputStream> ioSupplier = url == null
+                        ? () -> Files.newInputStream(Paths.get(style[0]))
+                        : url::openStream;
                 configuration.setStyleSheet(ioSupplier);
             }
         }
 
         Defaults.Builder defaultBuilder = Defaults.builder();
         if (cl.hasOption(NO_DEFAULTS)) {
-            logDeprecated(NO_DEFAULTS);
+            DeprecationReporter.logDeprecated(log, NO_DEFAULTS);
             defaultBuilder.noDefault();
         }
         if (cl.hasOption(LICENSES)) {
-            logDeprecated(LICENSES);
+            DeprecationReporter.logDeprecated(log, LICENSES);
             for (String fn : cl.getOptionValues(LICENSES)) {
                 defaultBuilder.add(fn);
             }
         }
-        Defaults defaults = defaultBuilder.build(DefaultLog.getInstance());
+        Defaults defaults = defaultBuilder.build(log);
         configuration.setFrom(defaults);
         if (StringUtils.isNotBlank(baseDirectory)) {
             configuration.setReportable(getDirectory(baseDirectory, configuration));
@@ -500,10 +520,11 @@ static ReportConfiguration createConfiguration(String baseDirectory, CommandLine
     /**
      * Creates a filename filter from patterns to exclude.
      *
+     * @param log the Logger to use.
      * @param excludes the list of patterns to exclude.
      * @return the FilenameFilter tht excludes the patterns
      */
-    static FilenameFilter parseExclusions(List<String> excludes) {
+    static FilenameFilter parseExclusions(final Log log, final List<String> excludes) {
         final OrFileFilter orFilter = new OrFileFilter();
         int ignoredLines = 0;
         for (String exclude : excludes) {
@@ -520,7 +541,7 @@ static FilenameFilter parseExclusions(List<String> excludes) {
             try {
                 orFilter.addFileFilter(new RegexFileFilter(exclusion));
             } catch (PatternSyntaxException e) {
-                DefaultLog.getInstance().info("Will skip given exclusion '" + exclude + "' due to " + e.getMessage());
+                log.info("Will skip given exclusion '" + exclude + "' due to " + e.getMessage());
             }
             orFilter.addFileFilter(new NameFileFilter(exclusion));
             if (exclude.contains("?") || exclude.contains("*")) {
@@ -528,7 +549,7 @@ static FilenameFilter parseExclusions(List<String> excludes) {
             }
         }
         if (ignoredLines > 0) {
-            DefaultLog.getInstance().info("Ignored " + ignoredLines + " lines in your exclusion files as comments or empty lines.");
+            log.info("Ignored " + ignoredLines + " lines in your exclusion files as comments or empty lines.");
         }
         return new NotFileFilter(orFilter);
     }
@@ -556,33 +577,33 @@ static Options buildOptions() {
                         .addOption(XML).addOption(STYLESHEET_CLI));
     }
 
-    private static void printUsage(Options opts) {
+    private static void printUsage(final Options opts) {
         printUsage(new PrintWriter(System.out), opts);
     }
 
-    protected static String createPadding(int len) {
+    private static String createPadding(final int len) {
         char[] padding = new char[len];
         Arrays.fill(padding, ' ');
         return new String(padding);
     }
 
-   static String header(String txt) {
+    static String header(final String txt) {
         return String.format("%n====== %s ======%n", WordUtils.capitalizeFully(txt));
-   }
-    static void printUsage(PrintWriter writer, Options opts) {
+    }
 
+    static void printUsage(final PrintWriter writer, final Options opts) {
         HelpFormatter helpFormatter = new HelpFormatter.Builder().get();
-        helpFormatter.setWidth(130);
+        helpFormatter.setWidth(HELP_WIDTH);
         helpFormatter.setOptionComparator(new OptionComparator());
         String syntax = "java -jar apache-rat/target/apache-rat-CURRENT-VERSION.jar [options] [DIR|TARBALL]";
         helpFormatter.printHelp(writer, helpFormatter.getWidth(), syntax, header("Available options"), opts,
                 helpFormatter.getLeftPadding(), helpFormatter.getDescPadding(),
                 header("Argument Types"), false);
 
-        String argumentPadding = createPadding(helpFormatter.getLeftPadding() + 5);
+        String argumentPadding = createPadding(helpFormatter.getLeftPadding() + HELP_PADDING);
         for (Map.Entry<String, Supplier<String>> argInfo : ARGUMENT_TYPES.entrySet()) {
             writer.format("%n<%s>%n", argInfo.getKey());
-            helpFormatter.printWrapped(writer, helpFormatter.getWidth(), helpFormatter.getLeftPadding() + 10,
+            helpFormatter.printWrapped(writer, helpFormatter.getWidth(), helpFormatter.getLeftPadding() + HELP_PADDING + HELP_PADDING,
                     argumentPadding + argInfo.getValue().get());
         }
         writer.println(header("Notes"));
@@ -606,7 +627,7 @@ private Report() {
      * @param config        the ReportConfiguration.
      * @return the IReportable instance containing the files.
      */
-    private static IReportable getDirectory(String baseDirectory, ReportConfiguration config) {
+    private static IReportable getDirectory(final String baseDirectory, final ReportConfiguration config) {
         File base = new File(baseDirectory);
 
         if (!base.exists()) {
@@ -629,7 +650,7 @@ public static class OptionComparator implements Comparator<Option>, Serializable
         /** The serial version UID.  */
         private static final long serialVersionUID = 5305467873966684014L;
 
-        private String getKey(Option opt) {
+        private String getKey(final Option opt) {
             String key = opt.getOpt();
             key = key == null ? opt.getLongOpt() : key;
             return key;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/api/Document.java b/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
index c2d861a6e..7950de9ee 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
@@ -25,8 +25,6 @@
 import java.nio.file.Paths;
 import java.util.SortedSet;
 
-import org.apache.rat.document.CompositeDocumentException;
-
 /**
  * The representation of a document being scanned.
  */
@@ -80,16 +78,16 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
-        if (obj == null || ! (obj instanceof Document)) {
+    public boolean equals(final Object obj) {
+        if (!(obj instanceof Document)) {
             return false;
         }
-        return getPath().equals(((Document)obj).getPath());
+        return getPath().equals(((Document) obj).getPath());
     }
 
     /**
      * Get the path that identifies the document.
-     * @return
+     * @return the path for the document.
      */
     public Path getPath() {
         return Paths.get(getName());
@@ -100,7 +98,6 @@ public Path getPath() {
      * 
      * @return <code>Reader</code> not null
      * @throws IOException if this document cannot be read
-     * @throws CompositeDocumentException if this document can only be read as a
      * composite archive
      */
     public abstract Reader reader() throws IOException;
@@ -128,8 +125,7 @@ public final MetaData getMetaData() {
      * of this object.
      */
     @Override
-    public String toString()
-    {
+    public String toString() {
         return String.format("%s( name = %s metaData = %s )", this.getClass().getSimpleName(), getName(), getMetaData());
     }
 
diff --git a/apache-rat-core/src/main/java/org/apache/rat/document/CompositeDocumentException.java b/apache-rat-core/src/main/java/org/apache/rat/document/CompositeDocumentException.java
deleted file mode 100644
index a3d1d5351..000000000
--- a/apache-rat-core/src/main/java/org/apache/rat/document/CompositeDocumentException.java
+++ /dev/null
@@ -1,39 +0,0 @@
-/*
- * 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.                                           *
- */ 
-package org.apache.rat.document;
-
-import java.io.IOException;
-
-/**
- * Indicates that the document is a composite archive 
- * and cannot be read.
- */
-public class CompositeDocumentException extends IOException {
-
-    private static final long serialVersionUID = -8874256971728263295L;
-
-    public CompositeDocumentException() {
-        super("This document must be read as an archive.");
-    }
-
-    public CompositeDocumentException(String s) {
-        super(s);
-    }
-
-}
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicenseFamily.java b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicenseFamily.java
index 49b358f17..2ce26e44b 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicenseFamily.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicenseFamily.java
@@ -19,7 +19,6 @@
 package org.apache.rat.license;
 
 import org.apache.rat.DeprecationReporter;
-import org.apache.rat.utils.DefaultLog;
 
 /**
  * An implementation of the ILicenseFamily.
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java b/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
index 6208f571e..a05e98c98 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
@@ -15,7 +15,7 @@
  * KIND, either express or implied.  See the License for the    *
  * specific language governing permissions and limitations      *
  * under the License.                                           *
- */ 
+ */
 package org.apache.rat.report;
 
 import org.apache.rat.api.Document;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java b/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java
index a2a25c3da..f25f93fc6 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/walker/ArchiveWalker.java
@@ -21,11 +21,8 @@
 
 import java.io.BufferedInputStream;
 import java.io.ByteArrayOutputStream;
-import java.io.File;
-import java.io.FilenameFilter;
 import java.io.IOException;
 import java.io.InputStream;
-import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -40,7 +37,6 @@
 import org.apache.rat.api.Document;
 import org.apache.rat.api.RatException;
 import org.apache.rat.document.impl.ArchiveEntryDocument;
-import org.apache.rat.document.impl.FileDocument;
 import org.apache.rat.report.RatReport;
 import org.apache.rat.utils.Log;
 
@@ -55,7 +51,7 @@ public class ArchiveWalker extends Walker {
      * @param config the report configuration for this run.
      * @param document the document to process.
      */
-    public ArchiveWalker(final ReportConfiguration config, Document document) {
+    public ArchiveWalker(final ReportConfiguration config, final Document document) {
         super(document, config.getFilesToIgnore());
         this.log = config.getLog();
     }
@@ -87,22 +83,21 @@ private InputStream createInputStream() throws IOException {
      * @return A collection of documents that pass the file filter.
      * @throws RatException on error.
      */
-    public Collection<Document> getDocuments(Log log) throws RatException {
+    public Collection<Document> getDocuments(final Log log) throws RatException {
         List<Document> result = new ArrayList<>();
         try (ArchiveInputStream<? extends ArchiveEntry> input = new ArchiveStreamFactory().createArchiveInputStream(createInputStream())) {
             ArchiveEntry entry = null;
             while ((entry = input.getNextEntry()) != null) {
-                Path path = this.getDocument().getPath().resolve("#"+entry.getName());
+                Path path = this.getDocument().getPath().resolve("#" + entry.getName());
                 if (!entry.isDirectory() && this.isNotIgnored(path) && input.canReadEntryData(entry)) {
                     ByteArrayOutputStream baos = new ByteArrayOutputStream();
-                    IOUtils.copy(input,baos);
+                    IOUtils.copy(input, baos);
                     result.add(new ArchiveEntryDocument(path, baos.toByteArray()));
                 }
             }
         } catch (ArchiveException e) {
             log.warn(String.format("Unable to process %s: %s", getDocument().getName(), e.getMessage()));
-        }
-        catch (IOException e) {
+        } catch (IOException e) {
             throw RatException.asRatException(e);
         }
         return result;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/walker/DirectoryWalker.java b/apache-rat-core/src/main/java/org/apache/rat/walker/DirectoryWalker.java
index f62d0c081..27b9c78bb 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/walker/DirectoryWalker.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/walker/DirectoryWalker.java
@@ -19,19 +19,13 @@
 
 package org.apache.rat.walker;
 
-import java.io.File;
-import java.io.FilenameFilter;
 import java.nio.file.Path;
-import java.util.Arrays;
-import java.util.Collection;
 import java.util.SortedSet;
 
-import org.apache.commons.io.filefilter.FalseFileFilter;
 import org.apache.commons.io.filefilter.IOFileFilter;
 import org.apache.rat.ReportConfiguration;
 import org.apache.rat.api.Document;
 import org.apache.rat.api.RatException;
-import org.apache.rat.document.impl.FileDocument;
 import org.apache.rat.report.RatReport;
 
 /**
@@ -48,7 +42,7 @@ public class DirectoryWalker extends Walker {
      * @param config the report configuration for this run.
      * @param document the document to process.
      */
-    public DirectoryWalker(final ReportConfiguration config, Document document) {
+    public DirectoryWalker(final ReportConfiguration config, final Document document) {
         super(document, config.getFilesToIgnore());
         this.directoriesToIgnore = config.getDirectoriesToIgnore();
     }
@@ -60,7 +54,7 @@ public DirectoryWalker(final ReportConfiguration config, Document document) {
      * @param document the document to process.
      * @throws RatException on error.
      */
-    private void processDirectory(final RatReport report, Document document) throws RatException {
+    private void processDirectory(final RatReport report, final Document document) throws RatException {
         if (isNotIgnoredDirectory(document.getPath())) {
             process(report, document);
         }
@@ -84,7 +78,7 @@ public void run(final RatReport report) throws RatException {
      * @param document the document to run the report against
      * @throws RatException on error
      */
-    protected void process(final RatReport report, Document document) throws RatException {
+    protected void process(final RatReport report, final Document document) throws RatException {
         final SortedSet<Document> documents = document.listChildren();
         if (documents != null) {
             // breadth first traversal
@@ -94,7 +88,7 @@ protected void process(final RatReport report, Document document) throws RatExce
     }
 
     /** test for directory that is not ignored */
-    private boolean isNotIgnoredDirectory(Path path) {
+    private boolean isNotIgnoredDirectory(final Path path) {
         return !directoriesToIgnore.accept(path.getParent().toFile(), path.toString());
     }
 
diff --git a/apache-rat-core/src/main/java/org/apache/rat/walker/Walker.java b/apache-rat-core/src/main/java/org/apache/rat/walker/Walker.java
index b5f112ef8..e1ef6f8a5 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/walker/Walker.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/walker/Walker.java
@@ -23,7 +23,6 @@
 import org.apache.rat.api.Document;
 import org.apache.rat.report.IReportable;
 
-import java.io.File;
 import java.io.FilenameFilter;
 import java.nio.file.Path;
 
@@ -60,7 +59,7 @@ protected Document getDocument() {
      * @param path the Path to test
      * @return {@code true} if the file should not be ignored.
      */
-    protected final boolean isNotIgnored(Path path) {
+    protected final boolean isNotIgnored(final Path path) {
         return !filesToIgnore.accept(path.getParent().toFile(), path.toString());
     }
 }
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 168afeabc..3452f0cf1 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -72,13 +72,13 @@ public class ReportTest {
 
     private ReportConfiguration createConfig(String... args) throws IOException, ParseException {
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), args);
-        return Report.createConfiguration("target/test-classes/elements", cl);
+        return Report.createConfiguration(DefaultLog.getInstance(), "target/test-classes/elements", cl);
     }
 
     @Test
     public void parseExclusionsForCLIUsage() {
         final FilenameFilter filter = Report
-                .parseExclusions(Arrays.asList("", " # foo/bar", "foo", "##", " ./foo/bar"));
+                .parseExclusions(DefaultLog.getInstance(), Arrays.asList("", " # foo/bar", "foo", "##", " ./foo/bar"));
         assertNotNull(filter);
     }
 
@@ -86,7 +86,7 @@ public void parseExclusionsForCLIUsage() {
     public void testDefaultConfiguration() throws ParseException, IOException {
         String[] empty = {};
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), empty);
-        ReportConfiguration config = Report.createConfiguration("", cl);
+        ReportConfiguration config = Report.createConfiguration(DefaultLog.getInstance(), "", cl);
         ReportConfigurationTest.validateDefault(config);
     }
 
@@ -94,7 +94,7 @@ public void testDefaultConfiguration() throws ParseException, IOException {
     public void testOutputOption() throws Exception {
         File output = new File(tempDirectory, "test");
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[]{"-o", output.getCanonicalPath()});
-        ReportConfiguration config = Report.createConfiguration("target/test-classes/elements", cl);
+        ReportConfiguration config = Report.createConfiguration(DefaultLog.getInstance(), "target/test-classes/elements", cl);
         new Reporter(config).output();
         assertTrue(output.exists());
         String content = FileUtils.readFileToString(output, StandardCharsets.UTF_8);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
index 38537eedf..1fc111c97 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReporterTest.java
@@ -27,7 +27,6 @@
 import java.io.FileInputStream;
 import java.io.PrintStream;
 import java.nio.charset.StandardCharsets;
-import java.util.function.Predicate;
 
 import javax.xml.xpath.XPath;
 import javax.xml.xpath.XPathConstants;
@@ -47,8 +46,6 @@
 import org.apache.rat.walker.DirectoryWalker;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
-import org.junit.jupiter.params.ParameterizedTest;
-import org.junit.jupiter.params.provider.MethodSource;
 import org.w3c.dom.Document;
 import org.w3c.dom.NodeList;
 
@@ -63,7 +60,7 @@ public class ReporterTest {
     public void testOutputOption() throws Exception {
         File output = new File(tempDirectory, "test");
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[] { "-o", output.getCanonicalPath()});
-        ReportConfiguration config = Report.createConfiguration("target/test-classes/elements", cl);
+        ReportConfiguration config = Report.createConfiguration(DefaultLog.getInstance(), "target/test-classes/elements", cl);
         new Reporter(config).output();
         assertTrue(output.exists());
         String content = FileUtils.readFileToString(output, StandardCharsets.UTF_8);
@@ -80,7 +77,7 @@ public void testDefaultOutput() throws Exception {
         try (PrintStream out = new PrintStream(output)){
             System.setOut(out);
             CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[] {});
-            ReportConfiguration config = Report.createConfiguration("target/test-classes/elements", cl);
+            ReportConfiguration config = Report.createConfiguration(DefaultLog.getInstance(), "target/test-classes/elements", cl);
             new Reporter(config).output();
         } finally {
             System.setOut(origin);
@@ -117,7 +114,7 @@ public void testXMLOutput() throws Exception {
         try (PrintStream out = new PrintStream(output)){
             System.setOut(out);
             CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[] { "-x" });
-            ReportConfiguration config = Report.createConfiguration("target/test-classes/elements", cl);
+            ReportConfiguration config = Report.createConfiguration(DefaultLog.getInstance(), "target/test-classes/elements", cl);
             new Reporter(config).output();
         } finally {
             System.setOut(origin);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
index aad7010d5..97c1cd713 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
@@ -1,3 +1,21 @@
+/*
+ * 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.                                           *
+ */
 package org.apache.rat.testhelpers;
 
 import org.apache.rat.utils.Log;
diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java b/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java
index bf486819e..9bff6b67d 100644
--- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java
+++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java
@@ -315,7 +315,7 @@ private void processLicenseFamilies(ReportConfiguration config) {
     
     private org.apache.rat.utils.Log makeLog() {
         return new org.apache.rat.utils.Log() {
-            Log log = getLog();
+            final Log log = getLog();
             @Override
             public void log(Level level, String msg) {
                 switch (level)
diff --git a/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java b/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java
index 9ba88bc55..0474ae564 100644
--- a/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java
+++ b/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java
@@ -21,7 +21,6 @@
 import java.io.*;
 import java.net.MalformedURLException;
 import java.net.URL;
-import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;

From 527c448898602b45656095112d6692b08434611f Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Sun, 12 May 2024 12:27:24 +0200
Subject: [PATCH 04/19] Attempt to fix windows file close issue

---
 apache-rat-core/src/test/java/org/apache/rat/ReportTest.java | 1 +
 1 file changed, 1 insertion(+)

diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 3452f0cf1..a57ac4713 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -265,6 +265,7 @@ static Stream<Arguments> optionsProvider() {
         args = new String[]{"--" + Report.LICENSES.getLongOpt(), cfgFile.getPath(), "--"  + Report.NO_DEFAULTS};
         test = c -> {
             assertEquals(1, c.getLicenses(LicenseSetFactory.LicenseFilter.ALL).size());
+            cfgFile.delete();
             return true;
         };
 

From cab2a6d570d0487b7870bf5ea1887b706a001345 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Sun, 12 May 2024 13:44:53 +0200
Subject: [PATCH 05/19] attempt to fix Windows errors

---
 .../org/apache/rat/configuration/XMLConfigurationReader.java | 5 +++--
 apache-rat-core/src/test/java/org/apache/rat/ReportTest.java | 1 -
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
index f19d09ad9..4690640cf 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
@@ -19,6 +19,7 @@
 package org.apache.rat.configuration;
 
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.Reader;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
@@ -169,8 +170,8 @@ public void read(URL... urls) {
             throw new ConfigurationException("Unable to create DOM builder", e);
         }
         for (URL url : urls) {
-            try {
-                add(builder.parse(url.openStream()));
+            try (InputStream inputStream = url.openStream()){
+                add(builder.parse(inputStream));
             } catch (SAXException | IOException e) {
                 throw new ConfigurationException("Unable to read url: " + url, e);
             }
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index a57ac4713..3452f0cf1 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -265,7 +265,6 @@ static Stream<Arguments> optionsProvider() {
         args = new String[]{"--" + Report.LICENSES.getLongOpt(), cfgFile.getPath(), "--"  + Report.NO_DEFAULTS};
         test = c -> {
             assertEquals(1, c.getLicenses(LicenseSetFactory.LicenseFilter.ALL).size());
-            cfgFile.delete();
             return true;
         };
 

From db3de3767419f3c02834a03db83fecdeb8c9c249 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Sun, 12 May 2024 14:14:06 +0200
Subject: [PATCH 06/19] attempt to fix windows error

---
 .../configuration/MatcherBuilderTracker.java  |  2 +-
 .../configuration/XMLConfigurationReader.java | 25 +++++----------
 .../test/java/org/apache/rat/ReportTest.java  | 31 +++++++++++--------
 3 files changed, 26 insertions(+), 32 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
index 6dbaed10b..ce3f56f0b 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
@@ -63,7 +63,7 @@ public static void addBuilder(final String className, final String name) {
     /**
      * Get the matching builder for the name.
      * @param name The name of the builder.
-     * @return the builder for that name.
+     * @return the builder for that name. (not null)
      */
     public static AbstractBuilder getMatcherBuilder(final String name) {
         Class<? extends AbstractBuilder> clazz = instance().matcherBuilders.get(name);
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
index 4690640cf..5b43f4742 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
@@ -330,26 +330,18 @@ private Pair<Boolean, List<Node>> processChildNodes(Description description, Nod
                 processChildren(description, children, childProcessor);
             }
         }
-        return new ImmutablePair<Boolean, List<Node>>(foundChildren, children);
+        return new ImmutablePair<>(foundChildren, children);
     }
 
     private AbstractBuilder parseMatcher(Node matcherNode) {
         final AbstractBuilder builder = MatcherBuilderTracker.getMatcherBuilder(matcherNode.getNodeName());
-        if (builder == null) {
-            throw new ConfigurationException(String.format("No builder found for: %s", matcherNode.getNodeName()));
-        }
+
         try {
             final Description description = DescriptionBuilder.buildMap(builder.builtClass());
-
+            if (description == null) {
+                throw new ConfigurationException(String.format("Unable to build description for %s", builder.builtClass()));
+            }
             processBuilderParams(description, builder);
-//            for (Description desc : description.childrenOfType(Component.Type.BuilderParam)) {
-//                Method m = builderParams.get(desc.getCommonName());
-//                try {
-//                    callSetter(desc, builder, m.invoke(builderParams));
-//                } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
-//                    ImplementationException.makeInstance(e);
-//                }
-//            }
 
             // process the attributes
             description.setChildren(getLog(), builder, attributes(matcherNode));
@@ -449,11 +441,8 @@ private ILicense parseLicense(Node licenseNode) {
         for (Description childDescription : childDescriptions) {
             Iterator<Node> iter = children.iterator();
             while (iter.hasNext()) {
-                Node child = iter.next();
-                if (MatcherBuilderTracker.getMatcherBuilder(child.getNodeName()) != null) {
-                    callSetter(childDescription, builder, parseMatcher(child));
-                    iter.remove();
-                }
+                callSetter(childDescription, builder, parseMatcher(iter.next()));
+                iter.remove();
             }
         }
 
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 3452f0cf1..5c8ce8648 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -60,6 +60,7 @@
 import org.apache.rat.testhelpers.TextUtils;
 import org.apache.rat.utils.DefaultLog;
 import org.apache.rat.utils.Log;
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -70,6 +71,22 @@ public class ReportTest {
     @TempDir
     static File tempDirectory;
 
+    @BeforeAll
+    public static void setUpClass() throws Exception {
+        File cfgFile = new File( tempDirectory, "test.xml");
+        try (IXmlWriter writer = new XmlWriter(new FileWriter(cfgFile))) {
+            writer.openElement("rat-config").openElement("families").openElement("family")
+                    .attribute("id","TEST").attribute("name", "Test license family")
+                    .closeElement().closeElement() // closed families
+                    .openElement("licenses").openElement("license")
+                    .attribute("id", "TEST-1").attribute("name", "Test license")
+                    .openElement("text").content("Hello world").closeElement()
+                    .closeDocument();
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
     private ReportConfiguration createConfig(String... args) throws IOException, ParseException {
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), args);
         return Report.createConfiguration(DefaultLog.getInstance(), "target/test-classes/elements", cl);
@@ -250,19 +267,7 @@ static Stream<Arguments> optionsProvider() {
         lst.add(Arguments.of(args, test));
 
 //        Report.LICENSES;
-        File cfgFile = new File( tempDirectory, "test.xml");
-        try (IXmlWriter writer = new XmlWriter(new FileWriter(cfgFile))) {
-            writer.openElement("rat-config").openElement("families").openElement("family")
-                    .attribute("id","TEST").attribute("name", "Test license family")
-                    .closeElement().closeElement() // closed families
-                    .openElement("licenses").openElement("license")
-                    .attribute("id", "TEST-1").attribute("name", "Test license")
-                    .openElement("text").content("Hello world").closeElement()
-                    .closeDocument();
-        } catch (Exception e) {
-            throw new RuntimeException(e);
-        }
-        args = new String[]{"--" + Report.LICENSES.getLongOpt(), cfgFile.getPath(), "--"  + Report.NO_DEFAULTS};
+        args = new String[]{"--" + Report.LICENSES.getLongOpt(), new File( tempDirectory, "test.xml").getPath(), "--"  + Report.NO_DEFAULTS};
         test = c -> {
             assertEquals(1, c.getLicenses(LicenseSetFactory.LicenseFilter.ALL).size());
             return true;

From 4a35dfc268217e7647f492a0a04db7c69b5e8d8e Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Tue, 14 May 2024 20:21:33 +0200
Subject: [PATCH 07/19] fixed issues uncovered in the last change

---
 .../configuration/XMLConfigurationReader.java |  7 ++-
 .../rat/license/LicenseFamilySetFactory.java  | 27 ++++++++-
 .../org/apache/rat/license/SimpleLicense.java |  7 ++-
 .../test/java/org/apache/rat/ReportTest.java  | 60 +++++++++----------
 4 files changed, 62 insertions(+), 39 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
index 5b43f4742..93e56a3f6 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
@@ -425,12 +425,13 @@ private BiPredicate<Node, Description> licenseChildNodeProcessor(ILicense.Builde
 
     private ILicense parseLicense(Node licenseNode) {
         ILicense.Builder builder = ILicense.builder();
+        // get the description for the builder
         Description description = builder.getDescription();
-
+        // set the BUILDER_PARAM options from the description
         processBuilderParams(description, builder);
-
+        // set the children from attributes.
         description.setChildren(getLog(), builder, attributes(licenseNode));
-
+        // set children from the child nodes
         Pair<Boolean, List<Node>> pair = processChildNodes(description, licenseNode,
                 licenseChildNodeProcessor(builder, description));
         List<Node> children = pair.getRight();
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java b/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java
index 6e60798c9..cdc300a0f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/LicenseFamilySetFactory.java
@@ -19,6 +19,7 @@
 
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Optional;
 import java.util.SortedSet;
 import java.util.TreeSet;
 
@@ -94,7 +95,31 @@ public SortedSet<String> getFamilyIds(LicenseFilter filter) {
         return result;
     }
 
-    
+    /**
+     * Search a SortedSet of ILicenseFamily instances looking for a matching instance.
+     * @param familyId The instance to search for.
+     * @param licenseFamilies the license families to search
+     * @return the matching instance of the target given.
+     */
+    public static boolean hasFamily(String familyId, SortedSet<ILicenseFamily> licenseFamilies) {
+        String familyCat = ILicenseFamily.makeCategory(familyId);
+        SortedSet<String> result = new TreeSet<>();
+        return licenseFamilies.stream().map(ILicenseFamily::getFamilyCategory).filter( f ->  f.equals(familyCat)).findFirst().isPresent();
+    }
+
+    /**
+     * Search a SortedSet of ILicenseFamily instances looking for a matching instance.
+     * @param familyId The instance to search for.
+     * @param licenseFamilies the license families to search
+     * @return the matching instance of the target given.
+     */
+    public static Optional<ILicenseFamily> findFamily(String familyId, SortedSet<ILicenseFamily> licenseFamilies) {
+        String familyCat = ILicenseFamily.makeCategory(familyId);
+        SortedSet<String> result = new TreeSet<>();
+        return licenseFamilies.stream().filter( f ->  f.getFamilyCategory().equals(familyCat)).findFirst();
+    }
+
+
     /**
      * Search a SortedSet of ILicenseFamily instances looking for a matching instance.
      * @param target The instance to search for.
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
index d8736cf3c..91596f30f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
@@ -21,6 +21,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.SortedSet;
 
 import org.apache.commons.lang3.StringUtils;
@@ -229,12 +230,12 @@ public SimpleLicense build() {
             if (licenseFamilies == null) {
                 throw new ImplementationException("'licenseFamilies' must not be null");
             }
-            ILicenseFamily family = LicenseFamilySetFactory.search(familyCategory, licenseFamilies);
-            if (family == null) {
+            Optional<ILicenseFamily> family = LicenseFamilySetFactory.findFamily(familyCategory, licenseFamilies);
+            if (!family.isPresent()) {
                 throw new ConfigurationException(String.format("License family '%s' not found.", familyCategory));
             }
 
-            return new SimpleLicense(family, matcher.build(), String.join(System.lineSeparator(), notes), name, id);
+            return new SimpleLicense(family.get(), matcher.build(), String.join(System.lineSeparator(), notes), name, id);
         }
     }
 }
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 5c8ce8648..f4c4fdc97 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -18,7 +18,6 @@
  */
 package org.apache.rat;
 
-import static java.lang.String.format;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -40,13 +39,11 @@
 import java.util.Arrays;
 import java.util.SortedSet;
 import java.util.List;
-import java.util.Optional;
 import java.util.function.Predicate;
 import java.util.stream.Stream;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.DefaultParser;
-import org.apache.commons.cli.DeprecatedAttributes;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
 import org.apache.commons.cli.ParseException;
@@ -60,7 +57,6 @@
 import org.apache.rat.testhelpers.TextUtils;
 import org.apache.rat.utils.DefaultLog;
 import org.apache.rat.utils.Log;
-import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -71,22 +67,6 @@ public class ReportTest {
     @TempDir
     static File tempDirectory;
 
-    @BeforeAll
-    public static void setUpClass() throws Exception {
-        File cfgFile = new File( tempDirectory, "test.xml");
-        try (IXmlWriter writer = new XmlWriter(new FileWriter(cfgFile))) {
-            writer.openElement("rat-config").openElement("families").openElement("family")
-                    .attribute("id","TEST").attribute("name", "Test license family")
-                    .closeElement().closeElement() // closed families
-                    .openElement("licenses").openElement("license")
-                    .attribute("id", "TEST-1").attribute("name", "Test license")
-                    .openElement("text").content("Hello world").closeElement()
-                    .closeDocument();
-        } catch (Exception e) {
-            throw new RuntimeException(e);
-        }
-    }
-
     private ReportConfiguration createConfig(String... args) throws IOException, ParseException {
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), args);
         return Report.createConfiguration(DefaultLog.getInstance(), "target/test-classes/elements", cl);
@@ -207,15 +187,15 @@ static Stream<Arguments> optionsProvider() {
 
 //        Report.ARCHIVE
         for (ReportConfiguration.Processing processing : ReportConfiguration.Processing.values()) {
-            args = new String[]{"--" + Report.ARCHIVE.getLongOpt(), processing.name().toLowerCase()};
+            args = new String[]{longOpt(Report.ARCHIVE), processing.name().toLowerCase()};
             test = c -> c.getArchiveProcessing() == processing;
             lst.add(Arguments.of(args, test));
         }
 //        Report.COPYRIGHT
-        args = new String[]{"--" + Report.COPYRIGHT.getLongOpt(), "My copyright statement"};
+        args = new String[]{longOpt(Report.COPYRIGHT), "My copyright statement"};
         test = c -> c.getCopyrightMessage() == null;
         lst.add(Arguments.of(args, test));
-        args = new String[]{"--" + Report.COPYRIGHT.getLongOpt(), "My copyright statement",
+        args = new String[]{longOpt(Report.COPYRIGHT), "My copyright statement",
                 "--" + Report.ADD.getOptions().stream().filter(o -> !o.isDeprecated()).findAny().get().getLongOpt()};
         test = c -> "My copyright statement".equals(c.getCopyrightMessage());
         lst.add(Arguments.of(args, test));
@@ -258,20 +238,15 @@ static Stream<Arguments> optionsProvider() {
         lst.add(Arguments.of(args, test));
 
 //        Report.FORCE
-        args = new String[]{"--" + Report.FORCE.getLongOpt()};
+        args = new String[]{longOpt(Report.FORCE)};
         test = ReportConfiguration::isAddingLicensesForced;
         lst.add(Arguments.of(args, test.negate()));
 
-        args = new String[]{"--" + Report.FORCE.getLongOpt(),
+        args = new String[]{longOpt(Report.FORCE),
                 "--" + Report.ADD.getOptions().stream().filter(o -> !o.isDeprecated()).findAny().get().getLongOpt()};
         lst.add(Arguments.of(args, test));
 
-//        Report.LICENSES;
-        args = new String[]{"--" + Report.LICENSES.getLongOpt(), new File( tempDirectory, "test.xml").getPath(), "--"  + Report.NO_DEFAULTS};
-        test = c -> {
-            assertEquals(1, c.getLicenses(LicenseSetFactory.LicenseFilter.ALL).size());
-            return true;
-        };
+//        Report.LICENSES -- tested in standalone test: testLicenseOption()
 
 //        Report.LIST_LICENSES;
         for (LicenseSetFactory.LicenseFilter f : LicenseSetFactory.LicenseFilter.values()) {
@@ -335,7 +310,7 @@ static Stream<Arguments> optionsProvider() {
         lst.add(Arguments.of(args, test));
 
 //        Report.XML;
-        args = new String[]{"--" + Report.XML.getLongOpt()};
+        args = new String[]{longOpt(Report.XML)};
         test = ReportConfiguration::isStyleReport;
         lst.add(Arguments.of(args, test.negate()));
         return lst.stream();
@@ -356,4 +331,25 @@ public void testDeprecatedUseLogged() throws IOException {
         log.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17.0: Use '--'");
         log.assertContains("WARN: Option [-a] used.  Deprecated for removal since 0.17.0: Use '-A or --addLicense'");
     }
+
+    @Test
+    public void testLicenseOption() throws IOException {
+        File cfgFile = new File( tempDirectory, "test.xml");
+        try (IXmlWriter writer = new XmlWriter(new FileWriter(cfgFile))) {
+            writer.openElement("rat-config").openElement("families").openElement("family")
+                    .attribute("id","TEST").attribute("name", "Test license family")
+                    .closeElement().closeElement() // closed families
+                    .openElement("licenses").openElement("license")
+                    .attribute("family", "TEST")
+                    .attribute("id", "TEST-1").attribute("name", "Test license")
+                    .openElement("text").content("Hello world").closeElement()
+                    .closeDocument();
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+        String[] args = new String[]{longOpt(Report.LICENSES), new File( tempDirectory, "test.xml").getPath(), longOpt(Report.NO_DEFAULTS)};
+        ReportConfiguration config = Report.parseCommands(args, (o)-> {}, true);
+        assertNotNull(config, "Did not create ReportConfiguraiton");
+        assertEquals(1, config.getLicenses(LicenseSetFactory.LicenseFilter.ALL).size());
+    }
 }

From 8f8b8f5a48ef8001acb47701e9e8e09d3d005440 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Wed, 15 May 2024 18:16:49 +0200
Subject: [PATCH 08/19] rebased on main branch

---
 .../org/apache/rat/DeprecationReporter.java   |  2 +-
 .../src/main/java/org/apache/rat/Report.java  | 13 +----
 .../rat/analysis/DefaultAnalyserFactory.java  |  3 -
 .../java/org/apache/rat/api/MetaData.java     |  1 -
 .../java/org/apache/rat/license/ILicense.java |  2 -
 .../apache/rat/license/LicenseSetFactory.java |  1 -
 .../org/apache/rat/license/SimpleLicense.java |  4 ++
 .../impl/xml/SimpleXmlClaimReporter.java      |  2 -
 .../test/java/org/apache/rat/ReportTest.java  |  6 +-
 .../analysis/DefaultAnalyserFactoryTest.java  | 12 ++--
 .../rat/license/ILicenseBuilderTest.java      | 57 +++++++++++++++++++
 .../rat/report/xml/XmlReportFactoryTest.java  |  6 +-
 .../java/org/apache/rat/anttasks/Report.java  | 21 ++++---
 .../antunit/report-bad-configurations.xml     |  2 +-
 14 files changed, 90 insertions(+), 42 deletions(-)
 create mode 100644 apache-rat-core/src/test/java/org/apache/rat/license/ILicenseBuilderTest.java

diff --git a/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java b/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
index 99ad3f9aa..ff7400779 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/DeprecationReporter.java
@@ -42,7 +42,7 @@ private DeprecationReporter() {
      * Deprecated Command line option consumer.
      */
 
-    public static Consumer<Option> getLogReporter(Log log) {
+    public static Consumer<Option> getLogReporter(final Log log) {
         return  o -> {
             StringBuilder buff = new StringBuilder();
             if (o.getOpt() != null) {
diff --git a/apache-rat-core/src/main/java/org/apache/rat/Report.java b/apache-rat-core/src/main/java/org/apache/rat/Report.java
index 436a4c564..ec0cef944 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/Report.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/Report.java
@@ -213,8 +213,8 @@ public String desc() {
      * @since 0.16.0
      */
     static final Option LICENSES = Option.builder().longOpt("licenses").hasArgs().argName("FileOrURI")
-            .desc("File names or URLs for license definitions.  May be followed by multiple arguments. " +
-                    "Note that '--' or a following option is required when using this parameter.")
+            .desc("File names or URLs for license definitions.  May be followed by multiple arguments. "
+                    + "Note that '--' or a following option is required when using this parameter.")
             .build();
     /**
      * Do not use the default files.
@@ -286,13 +286,6 @@ public String desc() {
             .converter(s -> ReportConfiguration.Processing.valueOf(s.toUpperCase()))
             .build();
 
-
-    private static void logDeprecated(final Option option) {
-        if (option.isDeprecated()) {
-            DeprecationReporter.LOG_DEPRECATED.accept(option);
-        }
-    }
-
     private static String asString(final Object[] args) {
         return Arrays.stream(args).map(Object::toString).collect(Collectors.joining(", "));
     }
@@ -428,7 +421,7 @@ static ReportConfiguration createConfiguration(final Log log, final String baseD
             try {
                 configuration.setStandardProcessing(cl.getParsedOptionValue(STANDARD));
             } catch (ParseException e) {
-                logParseException(e, STANDARD, cl, Defaults.STANDARD_PROCESSING);
+                logParseException(log, e, STANDARD, cl, Defaults.STANDARD_PROCESSING);
             }
         }
 
diff --git a/apache-rat-core/src/main/java/org/apache/rat/analysis/DefaultAnalyserFactory.java b/apache-rat-core/src/main/java/org/apache/rat/analysis/DefaultAnalyserFactory.java
index 2ca5279b5..a6cd2cc62 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/analysis/DefaultAnalyserFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/analysis/DefaultAnalyserFactory.java
@@ -24,7 +24,6 @@
 
 import org.apache.rat.ConfigurationException;
 import org.apache.rat.Defaults;
-import org.apache.rat.Report;
 import org.apache.rat.ReportConfiguration;
 import org.apache.rat.api.Document;
 import org.apache.rat.api.RatException;
@@ -32,8 +31,6 @@
 import org.apache.rat.document.RatDocumentAnalysisException;
 import org.apache.rat.license.ILicense;
 import org.apache.rat.license.LicenseSetFactory;
-import org.apache.rat.report.ConfigurationReport;
-import org.apache.rat.utils.Log;
 import org.apache.rat.walker.ArchiveWalker;
 
 /**
diff --git a/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java b/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
index fe3a392af..7854039dc 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
@@ -23,7 +23,6 @@
 import java.util.SortedSet;
 import java.util.TreeSet;
 import java.util.function.Predicate;
-import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import org.apache.rat.license.ILicense;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java b/apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java
index 0803f1919..4229ca42e 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/ILicense.java
@@ -18,11 +18,9 @@
  */
 package org.apache.rat.license;
 
-import java.util.Comparator;
 import java.util.Objects;
 import java.util.SortedSet;
 
-import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.rat.analysis.IHeaderMatcher;
 
 /**
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/LicenseSetFactory.java b/apache-rat-core/src/main/java/org/apache/rat/license/LicenseSetFactory.java
index 9321e32ad..0a9aec5c5 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/LicenseSetFactory.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/LicenseSetFactory.java
@@ -20,7 +20,6 @@
 
 import java.util.Collection;
 import java.util.Collections;
-import java.util.Objects;
 import java.util.Optional;
 import java.util.SortedSet;
 import java.util.TreeSet;
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
index 91596f30f..2c4f804a7 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
@@ -230,6 +230,10 @@ public SimpleLicense build() {
             if (licenseFamilies == null) {
                 throw new ImplementationException("'licenseFamilies' must not be null");
             }
+            if (StringUtils.isBlank(familyCategory)) {
+                throw new ImplementationException("License 'family'  must be specified");
+            }
+
             Optional<ILicenseFamily> family = LicenseFamilySetFactory.findFamily(familyCategory, licenseFamilies);
             if (!family.isPresent()) {
                 throw new ConfigurationException(String.format("License family '%s' not found.", familyCategory));
diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.java b/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.java
index a06ccb029..9eae67a5f 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.java
@@ -19,11 +19,9 @@
 package org.apache.rat.report.claim.impl.xml;
 
 import java.io.IOException;
-import java.util.Calendar;
 import java.util.Iterator;
 
 import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.time.DateFormatUtils;
 import org.apache.rat.api.Document;
 import org.apache.rat.api.MetaData;
 import org.apache.rat.api.RatException;
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index f4c4fdc97..7faddf057 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -153,7 +153,7 @@ public void testXMLOutput() throws Exception {
     @Test
     public void LicensesOptionTest() throws Exception {
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[]{"-licenses", "target/test-classes/report/LicenseOne.xml"});
-        ReportConfiguration config = Report.createConfiguration("", cl);
+        ReportConfiguration config = Report.createConfiguration(DefaultLog.getInstance(),"", cl);
         SortedSet<ILicense> set = config.getLicenses(LicenseSetFactory.LicenseFilter.ALL);
         assertTrue(LicenseSetFactory.search("LiOne", "LiOne", set).isPresent());
         assertFalse(LicenseSetFactory.search("LiOne", "LiTwo", set).isPresent(),"LiOne/LiTwo");
@@ -163,7 +163,7 @@ public void LicensesOptionTest() throws Exception {
     @Test
     public void LicensesOptionNoDefaultsTest() throws Exception {
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[] {"--no-default", "--licenses", "target/test-classes/report/LicenseOne.xml", "--licenses", "target/test-classes/report/LicenseTwo.xml"});
-        ReportConfiguration config = Report.createConfiguration("", cl);
+        ReportConfiguration config = Report.createConfiguration(DefaultLog.getInstance(), "", cl);
         SortedSet<ILicense> set = config.getLicenses(LicenseSetFactory.LicenseFilter.ALL);
         assertEquals(2, set.size());
         assertTrue(LicenseSetFactory.search("LiOne", "LiOne", set).isPresent(), "LiOne");
@@ -175,7 +175,7 @@ public void LicensesOptionNoDefaultsTest() throws Exception {
     @MethodSource("optionsProvider")
     public void testOptionsUpdateConfig(String[] args, Predicate<ReportConfiguration> test) throws Exception {
         ReportConfiguration config = Report.parseCommands(args, (o)-> {}, true);
-        assertNotNull(config, "Did not create ReportConfiguraiton");
+        assertNotNull(config, "Did not create ReportConfiguration");
         assertTrue(test.test(config));
     }
 
diff --git a/apache-rat-core/src/test/java/org/apache/rat/analysis/DefaultAnalyserFactoryTest.java b/apache-rat-core/src/test/java/org/apache/rat/analysis/DefaultAnalyserFactoryTest.java
index 58b258e41..b576868f1 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/analysis/DefaultAnalyserFactoryTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/analysis/DefaultAnalyserFactoryTest.java
@@ -217,8 +217,8 @@ public void RAT147_windows_Test() throws Exception {
     @Test
     public void standardNotificationTest() throws Exception {
 
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
         config.setFrom(defaults);
         config.setFilesToIgnore(FalseFileFilter.FALSE);
         config.setStandardProcessing(ReportConfiguration.Processing.NOTIFICATION);
@@ -238,8 +238,8 @@ public void standardNotificationTest() throws Exception {
     @Test
     public void standardAbsenceTest() throws Exception {
 
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
         config.setFrom(defaults);
         config.setFilesToIgnore(FalseFileFilter.FALSE);
         config.setStandardProcessing(ReportConfiguration.Processing.ABSENCE);
@@ -258,8 +258,8 @@ public void standardAbsenceTest() throws Exception {
 
     @Test
     public void standardPresenceTest() throws Exception {
-        Defaults defaults = Defaults.builder().build(DefaultLog.INSTANCE);
-        ReportConfiguration config = new ReportConfiguration(DefaultLog.INSTANCE);
+        Defaults defaults = Defaults.builder().build(DefaultLog.getInstance());
+        ReportConfiguration config = new ReportConfiguration(DefaultLog.getInstance());
         config.setFrom(defaults);
         config.setFilesToIgnore(FalseFileFilter.FALSE);
         config.setStandardProcessing(ReportConfiguration.Processing.PRESENCE);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/license/ILicenseBuilderTest.java b/apache-rat-core/src/test/java/org/apache/rat/license/ILicenseBuilderTest.java
new file mode 100644
index 000000000..3556246c6
--- /dev/null
+++ b/apache-rat-core/src/test/java/org/apache/rat/license/ILicenseBuilderTest.java
@@ -0,0 +1,57 @@
+/*
+ * 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.
+ */
+package org.apache.rat.license;
+
+import org.apache.rat.ImplementationException;
+import org.apache.rat.testhelpers.TestingMatcher;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+public class ILicenseBuilderTest {
+    @Test
+    public void testNoFamily() {
+        assertThrows(ImplementationException.class, () ->
+            ILicense.builder()
+                .setId("licId")
+                .setMatcher(new TestingMatcher())
+                .setName("No Family")
+                .setNote("The note")
+                .build(), "License 'family'  must be specified");
+
+
+        assertThrows(ImplementationException.class, () ->
+                ILicense.builder()
+                .setId("licId")
+                .setMatcher(new TestingMatcher())
+                .setName("empty Family")
+                .setNote("The note")
+                .setFamily("")
+                .build(), "License 'family'  must be specified");
+
+        assertThrows(ImplementationException.class, () ->
+                ILicense.builder()
+                .setId("licId")
+                .setMatcher(new TestingMatcher())
+                .setName("Null family")
+                .setNote("The note")
+                .setFamily(null)
+                .build(), "License 'family'  must be specified");
+    }
+}
diff --git a/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportFactoryTest.java b/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportFactoryTest.java
index bcc49b972..a9fdb938e 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportFactoryTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/report/xml/XmlReportFactoryTest.java
@@ -27,7 +27,6 @@
 
 import java.io.File;
 import java.io.StringWriter;
-import java.util.regex.Pattern;
 
 import org.apache.commons.io.filefilter.HiddenFileFilter;
 import org.apache.rat.ConfigurationException;
@@ -97,14 +96,14 @@ public void standardReport() throws Exception {
     }
 
     @Test
-    public void testNoLicense() throws Exception {
+    public void testNoLicense()  {
 
         final ILicense mockLicense = mock(ILicense.class);
         when(mockLicense.matches(any())).thenReturn(true);
         when(mockLicense.getLicenseFamily()).thenReturn(family);
 
         final ClaimStatistic statistic = new ClaimStatistic();
-        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.INSTANCE);
+        final ReportConfiguration configuration = new ReportConfiguration(DefaultLog.getInstance());
         // configuration.addLicense(mockLicense);
         try {
             XmlReportFactory.createStandardReport(writer, statistic, configuration);
@@ -112,6 +111,5 @@ public void testNoLicense() throws Exception {
         } catch (ConfigurationException e) {
             // expected;
         }
-
     }
 }
diff --git a/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java b/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java
index 0474ae564..bd2c5aea5 100644
--- a/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java
+++ b/apache-rat-tasks/src/main/java/org/apache/rat/anttasks/Report.java
@@ -28,6 +28,7 @@
 
 import org.apache.rat.ConfigurationException;
 import org.apache.rat.Defaults;
+import org.apache.rat.ImplementationException;
 import org.apache.rat.ReportConfiguration;
 import org.apache.rat.Reporter;
 import org.apache.rat.configuration.Format;
@@ -204,14 +205,18 @@ public void setAddDefaultDefinitions(File fileName) {
     }
 
     public ReportConfiguration getConfiguration() {
-        Defaults defaults = defaultsBuilder.build(configuration.getLog());
-
-        configuration.setFrom(defaults);
-        configuration.setReportable(new ResourceCollectionContainer(nestedResources));
-        families.stream().map(Family::build).forEach(configuration::addFamily);
-        licenses.stream().map(License::asBuilder)
-                .forEach(l -> configuration.addApprovedLicenseCategory(configuration.addLicense(l).getLicenseFamily()));
-        return configuration;
+        try {
+            Defaults defaults = defaultsBuilder.build(configuration.getLog());
+
+            configuration.setFrom(defaults);
+            configuration.setReportable(new ResourceCollectionContainer(nestedResources));
+            families.stream().map(Family::build).forEach(configuration::addFamily);
+            licenses.stream().map(License::asBuilder)
+                    .forEach(l -> configuration.addApprovedLicenseCategory(configuration.addLicense(l).getLicenseFamily()));
+            return configuration;
+        } catch (ImplementationException e) {
+            throw new BuildException(e.getMessage(), e);
+        }
     }
 
     /**
diff --git a/apache-rat-tasks/src/test/resources/antunit/report-bad-configurations.xml b/apache-rat-tasks/src/test/resources/antunit/report-bad-configurations.xml
index 92faed8ff..9cb58a775 100644
--- a/apache-rat-tasks/src/test/resources/antunit/report-bad-configurations.xml
+++ b/apache-rat-tasks/src/test/resources/antunit/report-bad-configurations.xml
@@ -89,7 +89,7 @@
 
   <target name="testLicenseRequiresFamilyCategory">
     <au:expectfailure
-        expectedMessage="LicenseFamily Category must be specified">
+        expectedMessage="License 'family'  must be specified">
       <rat:report>
         <file file="${ant.file}"/>
         <rat:license

From 34e1f124b8dc923c3319cfd09ab75b2fe67e55dd Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Wed, 15 May 2024 19:25:35 +0200
Subject: [PATCH 09/19] attempt to fix windows error

---
 .../src/test/java/org/apache/rat/ReportTest.java         | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 7faddf057..902526a4c 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -57,7 +57,10 @@
 import org.apache.rat.testhelpers.TextUtils;
 import org.apache.rat.utils.DefaultLog;
 import org.apache.rat.utils.Log;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.EnabledOnOs;
+import org.junit.jupiter.api.condition.OS;
 import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
@@ -67,6 +70,12 @@ public class ReportTest {
     @TempDir
     static File tempDirectory;
 
+    @AfterEach
+    @EnabledOnOs(OS.WINDOWS)
+    void cleanUp() {
+        System.gc();
+    }
+
     private ReportConfiguration createConfig(String... args) throws IOException, ParseException {
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), args);
         return Report.createConfiguration(DefaultLog.getInstance(), "target/test-classes/elements", cl);

From a80e090836669739378a4a07da5230217c4a6d31 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Wed, 15 May 2024 19:49:08 +0200
Subject: [PATCH 10/19] work around for
 https://github.com/junit-team/junit5/issues/2811

---
 apache-rat-core/src/test/java/org/apache/rat/ReportTest.java | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 902526a4c..8be53aeb1 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -70,6 +70,10 @@ public class ReportTest {
     @TempDir
     static File tempDirectory;
 
+    /**
+     * This method is a known workaround for junit 5 issue #2811
+     * {@link  https://github.com/junit-team/junit5/issues/2811 }
+     */
     @AfterEach
     @EnabledOnOs(OS.WINDOWS)
     void cleanUp() {

From 7343620dbb400dea186fd31cc6748b8328e85983 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Wed, 15 May 2024 20:04:08 +0200
Subject: [PATCH 11/19] fixed some spotbugs

---
 .../configuration/MatcherBuilderTracker.java    | 17 +++++++++--------
 .../configuration/XMLConfigurationReader.java   |  8 ++++++--
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
index ce3f56f0b..44233ac29 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/MatcherBuilderTracker.java
@@ -95,7 +95,7 @@ public Collection<Class<? extends AbstractBuilder>> getClasses() {
         return Collections.unmodifiableCollection(matcherBuilders.values());
     }
 
-    private void addBuilderImpl(final String className, String name) {
+    private void addBuilderImpl(final String className, final String name) {
         Objects.requireNonNull(className, "className may not be null");
         Class<?> clazz;
         try {
@@ -106,20 +106,21 @@ private void addBuilderImpl(final String className, String name) {
         if (AbstractBuilder.class.isAssignableFrom(clazz)) {
             @SuppressWarnings("unchecked")
             Class<? extends AbstractBuilder> candidate = (Class<? extends AbstractBuilder>) clazz;
-            if (StringUtils.isBlank(name)) {
-                name = candidate.getSimpleName();
-                if (!name.endsWith("Builder")) {
+            String workingName = name;
+            if (StringUtils.isBlank(workingName)) {
+                workingName = candidate.getSimpleName();
+                if (!workingName.endsWith("Builder")) {
                     throw new ConfigurationException(
                             "name is required, or " + candidate.getName() + " must end with 'Builder'");
                 }
-                name = name.substring(0, name.lastIndexOf("Builder"));
-                if (StringUtils.isBlank(name)) {
+                workingName = workingName.substring(0, workingName.lastIndexOf("Builder"));
+                if (StringUtils.isBlank(workingName)) {
                     throw new ConfigurationException("Last segment of " + candidate.getName()
                             + " may not be 'Builder', but must end in 'Builder'");
                 }
-                name = WordUtils.uncapitalize(name);
+                workingName = WordUtils.uncapitalize(workingName);
             }
-            matcherBuilders.put(name, candidate);
+            matcherBuilders.put(workingName, candidate);
         } else {
             throw new ConfigurationException("Class " + clazz.getName() + " does not extend " + AbstractBuilder.class);
         }
diff --git a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
index 93e56a3f6..08096eeba 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/configuration/XMLConfigurationReader.java
@@ -69,7 +69,7 @@
 /**
  * A class that reads the XML configuration file format.
  */
-public class XMLConfigurationReader implements LicenseReader, MatcherReader {
+public final class XMLConfigurationReader implements LicenseReader, MatcherReader {
 
     private Log log;
     private Document document;
@@ -127,6 +127,10 @@ public void setLog(Log log) {
         this.log = log;
     }
 
+    /**
+     * Returns the log the reader.
+     * @return the log if set, if not set {@code DefaultLog.getInstance()} is returned.
+     */
     public Log getLog() {
         return log == null ? DefaultLog.getInstance() : log;
     }
@@ -138,7 +142,7 @@ public void addLicenses(URL url) {
 
     /**
      * Read xml from a reader.
-     * 
+     *
      * @param reader the reader to read XML from.
      */
     public void read(Reader reader) {

From c92cb1567190e366c2d3947e76986a48c33322b4 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Thu, 16 May 2024 20:10:02 +0200
Subject: [PATCH 12/19] modified parseExclusions to remove false warning

---
 apache-rat-core/src/main/java/org/apache/rat/Report.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/Report.java b/apache-rat-core/src/main/java/org/apache/rat/Report.java
index ec0cef944..1e77c19f8 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/Report.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/Report.java
@@ -534,7 +534,7 @@ static FilenameFilter parseExclusions(final Log log, final List<String> excludes
             try {
                 orFilter.addFileFilter(new RegexFileFilter(exclusion));
             } catch (PatternSyntaxException e) {
-                log.info("Will skip given exclusion '" + exclude + "' due to " + e.getMessage());
+                // report nothing, an acceptable outcome.
             }
             orFilter.addFileFilter(new NameFileFilter(exclusion));
             if (exclude.contains("?") || exclude.contains("*")) {

From 7783313ceb64863eeb2d2dbf1016baa7af86154f Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Fri, 17 May 2024 18:06:04 +0200
Subject: [PATCH 13/19] fixed bad merge

---
 .../src/main/java/org/apache/rat/walker/DirectoryWalker.java  | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/walker/DirectoryWalker.java b/apache-rat-core/src/main/java/org/apache/rat/walker/DirectoryWalker.java
index 08253897b..27b9c78bb 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/walker/DirectoryWalker.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/walker/DirectoryWalker.java
@@ -19,10 +19,6 @@
 
 package org.apache.rat.walker;
 
-<<<<<<< RAT-324_tests_to_validate_that_UI_options
-=======
-import java.io.FilenameFilter;
->>>>>>> master
 import java.nio.file.Path;
 import java.util.SortedSet;
 

From f257dce7af81d8c4b6c065653ccc1c81c2ee3367 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Fri, 17 May 2024 18:12:31 +0200
Subject: [PATCH 14/19] changed deprecated version strings to 0.17 and removed
 extra space in message

---
 apache-rat-core/src/main/java/org/apache/rat/Report.java    | 6 +++---
 .../src/main/java/org/apache/rat/license/SimpleLicense.java | 2 +-
 .../src/test/java/org/apache/rat/ReportTest.java            | 4 ++--
 .../test/java/org/apache/rat/testhelpers/TestingLog.java    | 4 ++--
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/Report.java b/apache-rat-core/src/main/java/org/apache/rat/Report.java
index 1e77c19f8..78b95c9d3 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/Report.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/Report.java
@@ -137,7 +137,7 @@ public String desc() {
      * Adds license headers to files missing headers.
      */
     // TODO rework when Commons-CLI version 1.7.1 or higher is available.
-    private static final DeprecatedAttributes ADD_ATTRIBUTES = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17.0")
+    private static final DeprecatedAttributes ADD_ATTRIBUTES = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17")
             .setDescription("Use '-A' or --addLicense instead.").get();
     static final OptionGroup ADD = new OptionGroup()
             .addOption(Option.builder("a").hasArg(false)
@@ -161,7 +161,7 @@ public String desc() {
             .converter(Converter.FILE).build();
 
     // TODO rework when commons-cli 1.7.1 or higher is available.
-    static final DeprecatedAttributes DIR_ATTRIBUTES = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17.0")
+    static final DeprecatedAttributes DIR_ATTRIBUTES = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17")
             .setDescription("Use '--'").get();
     static final Option DIR = Option.builder().option("d").longOpt("dir").hasArg()
             .desc(format("[%s] %s", DIR_ATTRIBUTES, "Used to indicate end of list when using --exclude.")).argName("DirOrArchive")
@@ -269,7 +269,7 @@ public String desc() {
 
     /**
      * Specify the processing of ARCHIVE files.
-     * @since 0.17.0
+     * @since 0.17
      */
     static final Option ARCHIVE = Option.builder().longOpt("archive").hasArg().argName("ProcessingType")
             .desc(format("Specifies the level of detail in ARCHIVE file reporting. (default is %s)",
diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
index 2c4f804a7..0919cbfab 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
@@ -231,7 +231,7 @@ public SimpleLicense build() {
                 throw new ImplementationException("'licenseFamilies' must not be null");
             }
             if (StringUtils.isBlank(familyCategory)) {
-                throw new ImplementationException("License 'family'  must be specified");
+                throw new ImplementationException("License 'family' must be specified");
             }
 
             Optional<ILicenseFamily> family = LicenseFamilySetFactory.findFamily(familyCategory, licenseFamilies);
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 8be53aeb1..01ac4a520 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -341,8 +341,8 @@ public void testDeprecatedUseLogged() throws IOException {
         } finally {
             DefaultLog.setInstance(null);
         }
-        log.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17.0: Use '--'");
-        log.assertContains("WARN: Option [-a] used.  Deprecated for removal since 0.17.0: Use '-A or --addLicense'");
+        log.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17: Use '--'");
+        log.assertContains("WARN: Option [-a] used.  Deprecated for removal since 0.17: Use '-A or --addLicense'");
     }
 
     @Test
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
index 97c1cd713..b801f7f8d 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
@@ -43,11 +43,11 @@ public String getCaptured() {
     }
 
     public void assertContains(String expected) {
-        TextUtils.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17.0: Use '--'", captured.toString());
+        TextUtils.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17: Use '--'", captured.toString());
     }
 
     public void assertNotContains(String expected) {
-        TextUtils.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17.0: Use '--'", captured.toString());
+        TextUtils.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17: Use '--'", captured.toString());
     }
 
     public void assertContainsPattern(String pattern) {

From b861966862e0b17a0b7240622c094e5bbaac1ef2 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Fri, 17 May 2024 18:51:49 +0200
Subject: [PATCH 15/19] fixed test error

---
 .../src/test/resources/antunit/report-bad-configurations.xml    | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apache-rat-tasks/src/test/resources/antunit/report-bad-configurations.xml b/apache-rat-tasks/src/test/resources/antunit/report-bad-configurations.xml
index 9cb58a775..56d1e8d7a 100644
--- a/apache-rat-tasks/src/test/resources/antunit/report-bad-configurations.xml
+++ b/apache-rat-tasks/src/test/resources/antunit/report-bad-configurations.xml
@@ -89,7 +89,7 @@
 
   <target name="testLicenseRequiresFamilyCategory">
     <au:expectfailure
-        expectedMessage="License 'family'  must be specified">
+        expectedMessage="License 'family' must be specified">
       <rat:report>
         <file file="${ant.file}"/>
         <rat:license

From 474e9121df1c6c31c23fcd75b47f5c361e27d2e2 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Sun, 19 May 2024 08:30:03 +0200
Subject: [PATCH 16/19] added tests for RAT-190 and fixed TestingLog

---
 .../src/main/java/org/apache/rat/Report.java  | 17 ++--
 .../test/java/org/apache/rat/ReportTest.java  | 99 ++++++++++++++++++-
 .../apache/rat/testhelpers/TestingLog.java    |  7 +-
 3 files changed, 108 insertions(+), 15 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/Report.java b/apache-rat-core/src/main/java/org/apache/rat/Report.java
index 78b95c9d3..8b0672518 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/Report.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/Report.java
@@ -32,6 +32,7 @@
 import java.util.Comparator;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.TreeMap;
 import java.util.function.Consumer;
 import java.util.function.Supplier;
@@ -138,7 +139,7 @@ public String desc() {
      */
     // TODO rework when Commons-CLI version 1.7.1 or higher is available.
     private static final DeprecatedAttributes ADD_ATTRIBUTES = DeprecatedAttributes.builder().setForRemoval(true).setSince("0.17")
-            .setDescription("Use '-A' or --addLicense instead.").get();
+            .setDescription("Use '-A' or '--addLicense' instead.").get();
     static final OptionGroup ADD = new OptionGroup()
             .addOption(Option.builder("a").hasArg(false)
                     .desc(format("[%s]", ADD_ATTRIBUTES))
@@ -457,16 +458,14 @@ static ReportConfiguration createConfiguration(final Log log, final String baseD
             DeprecationReporter.logDeprecated(log, EXCLUDE_CLI);
             String[] excludes = cl.getOptionValues(EXCLUDE_CLI);
             if (excludes != null) {
-                final FilenameFilter filter = parseExclusions(log, Arrays.asList(excludes));
-                configuration.setFilesToIgnore(filter);
+                parseExclusions(log, Arrays.asList(excludes)).ifPresent(configuration::setFilesToIgnore);
             }
         } else if (cl.hasOption(EXCLUDE_FILE_CLI)) {
             DeprecationReporter.logDeprecated(log, EXCLUDE_FILE_CLI);
             String excludeFileName = cl.getOptionValue(EXCLUDE_FILE_CLI);
             if (excludeFileName != null) {
-                final FilenameFilter filter = parseExclusions(log,
-                        FileUtils.readLines(new File(excludeFileName), StandardCharsets.UTF_8));
-                configuration.setFilesToIgnore(filter);
+                parseExclusions(log,FileUtils.readLines(new File(excludeFileName), StandardCharsets.UTF_8))
+                        .ifPresent(configuration::setFilesToIgnore);
             }
         }
 
@@ -515,9 +514,9 @@ static ReportConfiguration createConfiguration(final Log log, final String baseD
      *
      * @param log the Logger to use.
      * @param excludes the list of patterns to exclude.
-     * @return the FilenameFilter tht excludes the patterns
+     * @return the FilenameFilter tht excludes the patterns or an empty optional.
      */
-    static FilenameFilter parseExclusions(final Log log, final List<String> excludes) {
+    static Optional<FilenameFilter> parseExclusions(final Log log, final List<String> excludes) {
         final OrFileFilter orFilter = new OrFileFilter();
         int ignoredLines = 0;
         for (String exclude : excludes) {
@@ -544,7 +543,7 @@ static FilenameFilter parseExclusions(final Log log, final List<String> excludes
         if (ignoredLines > 0) {
             log.info("Ignored " + ignoredLines + " lines in your exclusion files as comments or empty lines.");
         }
-        return new NotFileFilter(orFilter);
+        return orFilter.getFileFilters().isEmpty() ? Optional.empty() : Optional.of(orFilter.negate());
     }
 
     static Options buildOptions() {
diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index 01ac4a520..c42cfc78c 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -18,8 +18,11 @@
  */
 package org.apache.rat;
 
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
@@ -37,6 +40,8 @@
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
+import java.util.Optional;
 import java.util.SortedSet;
 import java.util.List;
 import java.util.function.Predicate;
@@ -48,6 +53,12 @@
 import org.apache.commons.cli.Options;
 import org.apache.commons.cli.ParseException;
 import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.filefilter.IOFileFilter;
+import org.apache.commons.io.filefilter.NameFileFilter;
+import org.apache.commons.io.filefilter.NotFileFilter;
+import org.apache.commons.io.filefilter.OrFileFilter;
+import org.apache.commons.io.filefilter.RegexFileFilter;
+import org.apache.commons.io.filefilter.WildcardFileFilter;
 import org.apache.rat.license.ILicense;
 import org.apache.rat.license.LicenseSetFactory;
 import org.apache.commons.io.filefilter.FalseFileFilter;
@@ -87,9 +98,9 @@ private ReportConfiguration createConfig(String... args) throws IOException, Par
 
     @Test
     public void parseExclusionsForCLIUsage() {
-        final FilenameFilter filter = Report
+        final Optional<FilenameFilter> filter = Report
                 .parseExclusions(DefaultLog.getInstance(), Arrays.asList("", " # foo/bar", "foo", "##", " ./foo/bar"));
-        assertNotNull(filter);
+        assertThat(filter).isPresent();
     }
 
     @Test
@@ -174,7 +185,7 @@ public void LicensesOptionTest() throws Exception {
     }
 
     @Test
-    public void LicensesOptionNoDefaultsTest() throws Exception {
+    public void testLicensesOptionNoDefaults() throws Exception {
         CommandLine cl = new DefaultParser().parse(Report.buildOptions(), new String[] {"--no-default", "--licenses", "target/test-classes/report/LicenseOne.xml", "--licenses", "target/test-classes/report/LicenseTwo.xml"});
         ReportConfiguration config = Report.createConfiguration(DefaultLog.getInstance(), "", cl);
         SortedSet<ILicense> set = config.getLicenses(LicenseSetFactory.LicenseFilter.ALL);
@@ -342,7 +353,7 @@ public void testDeprecatedUseLogged() throws IOException {
             DefaultLog.setInstance(null);
         }
         log.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17: Use '--'");
-        log.assertContains("WARN: Option [-a] used.  Deprecated for removal since 0.17: Use '-A or --addLicense'");
+        log.assertContains("WARN: Option [-a] used.  Deprecated for removal since 0.17: Use '-A' or '--addLicense'");
     }
 
     @Test
@@ -365,4 +376,84 @@ public void testLicenseOption() throws IOException {
         assertNotNull(config, "Did not create ReportConfiguraiton");
         assertEquals(1, config.getLicenses(LicenseSetFactory.LicenseFilter.ALL).size());
     }
+
+    @ParameterizedTest
+    @MethodSource("exclusionsProvider")
+    public void testParseExclusions(String pattern, List<IOFileFilter> expectedPatterns, List<String> logEntries) {
+        TestingLog log = new TestingLog();
+        Optional<FilenameFilter> filter = Report.parseExclusions(log, Collections.singletonList(pattern));
+        if (expectedPatterns.isEmpty()) {
+            assertThat(filter).isEmpty();
+        } else {
+            assertInstanceOf(NotFileFilter.class, filter.get());
+            String result = filter.toString();
+            for (IOFileFilter expectedFilter : expectedPatterns) {
+                TextUtils.assertContains(expectedFilter.toString(), result);
+            }
+        }
+        assertEquals(log.isEmpty(), logEntries.isEmpty());
+        for (String logEntry : logEntries) {
+            log.assertContains(logEntry);
+        }
+    }
+
+    public static Stream<Arguments> exclusionsProvider() {
+        List<Arguments> lst = new ArrayList<>();
+
+        lst.add(Arguments.of( "", Collections.emptyList(), Collections.singletonList("INFO: Ignored 1 lines in your exclusion files as comments or empty lines.")));
+
+        lst.add(Arguments.of( "# a comment", Collections.emptyList(), Collections.singletonList("INFO: Ignored 1 lines in your exclusion files as comments or empty lines.")));
+
+        List<IOFileFilter> expected = new ArrayList<>();
+        String pattern = "hello.world";
+        expected.add(new RegexFileFilter(pattern));
+        expected.add(new NameFileFilter(pattern));
+        lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
+
+        expected = new ArrayList<>();
+        pattern = "[Hh]ello.[Ww]orld";
+        expected.add(new RegexFileFilter(pattern));
+        expected.add(new NameFileFilter(pattern));
+        lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
+
+        expected = new ArrayList<>();
+        pattern = "hell*.world";
+        expected.add(new RegexFileFilter(pattern));
+        expected.add(new NameFileFilter(pattern));
+        expected.add(WildcardFileFilter.builder().setWildcards(pattern).get());
+        lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
+
+        expected = new ArrayList<>();
+        pattern = "*.world";
+        expected.add(new NameFileFilter(pattern));
+        expected.add(WildcardFileFilter.builder().setWildcards(pattern).get());
+        lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
+
+        expected = new ArrayList<>();
+        pattern = "hello.*";
+        expected.add(new NameFileFilter(pattern));
+        expected.add(WildcardFileFilter.builder().setWildcards(pattern).get());
+        lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
+
+        expected = new ArrayList<>();
+        pattern = "?ello.world";
+        expected.add(new NameFileFilter(pattern));
+        expected.add(WildcardFileFilter.builder().setWildcards(pattern).get());
+        lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
+
+        expected = new ArrayList<>();
+        pattern = "hell?.world";
+        expected.add(new RegexFileFilter(pattern));
+        expected.add(new NameFileFilter(pattern));
+        expected.add(WildcardFileFilter.builder().setWildcards(pattern).get());
+        lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
+
+        expected = new ArrayList<>();
+        pattern = "hello.worl?";
+        expected.add(new NameFileFilter(pattern));
+        expected.add(WildcardFileFilter.builder().setWildcards(pattern).get());
+        lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
+
+        return lst.stream();
+    }
 }
diff --git a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
index b801f7f8d..3d73b5fdc 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/testhelpers/TestingLog.java
@@ -43,11 +43,11 @@ public String getCaptured() {
     }
 
     public void assertContains(String expected) {
-        TextUtils.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17: Use '--'", captured.toString());
+        TextUtils.assertContains(expected, captured.toString());
     }
 
     public void assertNotContains(String expected) {
-        TextUtils.assertContains("WARN: Option [-d, --dir] used.  Deprecated for removal since 0.17: Use '--'", captured.toString());
+        TextUtils.assertNotContains(expected, captured.toString());
     }
 
     public void assertContainsPattern(String pattern) {
@@ -63,4 +63,7 @@ public void log(Level level, String msg) {
         captured.append(String.format("%s: %s%n", level, msg));
     }
 
+    public boolean isEmpty() {
+        return captured.length() == 0;
+    }
 }

From 4e4655dbf5fe1fdc153b3d59cf079218321c6850 Mon Sep 17 00:00:00 2001
From: Claude Warren <claude@xenei.com>
Date: Sun, 19 May 2024 08:31:24 +0200
Subject: [PATCH 17/19] added tests for RAT-265 and fixed TestingLog

---
 apache-rat-core/src/test/java/org/apache/rat/ReportTest.java | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
index c42cfc78c..01813f4f4 100644
--- a/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
+++ b/apache-rat-core/src/test/java/org/apache/rat/ReportTest.java
@@ -19,7 +19,6 @@
 package org.apache.rat;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.junit.jupiter.api.Assertions.assertArrayEquals;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
@@ -56,7 +55,6 @@
 import org.apache.commons.io.filefilter.IOFileFilter;
 import org.apache.commons.io.filefilter.NameFileFilter;
 import org.apache.commons.io.filefilter.NotFileFilter;
-import org.apache.commons.io.filefilter.OrFileFilter;
 import org.apache.commons.io.filefilter.RegexFileFilter;
 import org.apache.commons.io.filefilter.WildcardFileFilter;
 import org.apache.rat.license.ILicense;
@@ -423,6 +421,7 @@ public static Stream<Arguments> exclusionsProvider() {
         expected.add(WildcardFileFilter.builder().setWildcards(pattern).get());
         lst.add(Arguments.of( pattern, expected, Collections.emptyList()));
 
+        // see RAT-265 for issue
         expected = new ArrayList<>();
         pattern = "*.world";
         expected.add(new NameFileFilter(pattern));

From ba826a85d2aeb68cbf1cbd957a19f7319271a690 Mon Sep 17 00:00:00 2001
From: "P. Ottlinger" <pottlinger@apache.org>
Date: Mon, 20 May 2024 10:12:25 +0200
Subject: [PATCH 18/19] RAT-324: Fix typo

---
 .../src/main/java/org/apache/rat/license/SimpleLicense.java     | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
index 0919cbfab..185afe670 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/license/SimpleLicense.java
@@ -67,7 +67,7 @@ public String toString() {
         return String.format("%s:%s", getId(), getName());
     }
 
-    @ConfigComponent(type = ComponentType.PARAMETER, desc = "The license family cagetory for this license.", required = true)
+    @ConfigComponent(type = ComponentType.PARAMETER, desc = "The license family category for this license.", required = true)
     public String getFamily() {
         return family.getFamilyCategory();
     }

From 900c7d9b376fe212029ec3437cb92cb11b41a8d4 Mon Sep 17 00:00:00 2001
From: "P. Ottlinger" <pottlinger@apache.org>
Date: Mon, 20 May 2024 10:29:42 +0200
Subject: [PATCH 19/19] RAT-324: Fix older version references

---
 .../src/main/java/org/apache/rat/Report.java       | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/apache-rat-core/src/main/java/org/apache/rat/Report.java b/apache-rat-core/src/main/java/org/apache/rat/Report.java
index 8b0672518..d6c1b6a1d 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/Report.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/Report.java
@@ -155,7 +155,7 @@ public String desc() {
     /**
      * Defines the output for the file.
      *
-     * @since 0.16.0
+     * @since 0.16
      */
     static final Option OUT = Option.builder().option("o").longOpt("out").hasArg()
             .desc("Define the output file where to write a report to (default is System.out).")
@@ -211,7 +211,7 @@ public String desc() {
     /**
      * Flag to identify a file with license definitions.
      *
-     * @since 0.16.0
+     * @since 0.16
      */
     static final Option LICENSES = Option.builder().longOpt("licenses").hasArgs().argName("FileOrURI")
             .desc("File names or URLs for license definitions.  May be followed by multiple arguments. "
@@ -219,7 +219,7 @@ public String desc() {
             .build();
     /**
      * Do not use the default files.
-     * @since 0.16.0
+     * @since 0.16
      */
     static final Option NO_DEFAULTS = new Option(null, "no-default-licenses", false, "Ignore default configuration. By default all approved default licenses are used");
 
@@ -230,7 +230,7 @@ public String desc() {
 
     /**
      * List the licenses that were used for the run.
-     * @since 0.16.0
+     * @since 0.16
      */
     static final Option LIST_LICENSES = Option.builder().longOpt("list-licenses").hasArg().argName("LicenseFilter")
             .desc("List the defined licenses (default is NONE). Valid options are: " + asString(LicenseFilter.values()))
@@ -239,7 +239,7 @@ public String desc() {
 
     /**
      * List the all families for the run.
-     * @since 0.16.0
+     * @since 0.16
      */
     static final Option LIST_FAMILIES = Option.builder().longOpt("list-families").hasArg().argName("LicenseFilter")
             .desc("List the defined license families (default is NONE). Valid options are: " + asString(LicenseFilter.values()))
@@ -248,7 +248,7 @@ public String desc() {
 
     /**
      * Specify the log level for output
-     * @since 0.16.0
+     * @since 0.16
      */
     static final Option LOG_LEVEL = Option.builder().longOpt("log-level")
             .hasArg().argName("LogLevel")
@@ -258,7 +258,7 @@ public String desc() {
 
     /**
      * Do not update files.
-     * @since 0.16.0
+     * @since 0.16
      */
     static final Option DRY_RUN = Option.builder().longOpt("dry-run")
             .desc("If set do not update the files but generate the reports.")