RAT-563: Minor refactorings during review

Author: ottlinger

apache-rat-core/src/main/java/org/apache/rat/OptionCollection.java

@@ -209,12 +209,12 @@ public static Options buildOptions() {
     }
 
     /**
-     * Creates an IReportable object from the directory name and ReportConfiguration
+     * Creates a Reportable object from the directory name and ReportConfiguration
      * object.
      *
      * @param base the directory that contains the files to report on.
      * @param config the ReportConfiguration.
-     * @return the IReportable instance containing the files.
+     * @return the Reportable instance containing the files.
      */
     public static Reportable getReportable(final File base, final ReportConfiguration config) {
         File absBase = base.getAbsoluteFile();

apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java

@@ -427,7 +427,7 @@ public void addIncludedPatterns(final Iterable<String> patterns) {
     }
 
     /**
-     * Get the DocumentNameMatcher that excludes files found in the directory tree..
+     * Get the DocumentNameMatcher that excludes files found in the directory tree.
      * @param baseDir the DocumentName for the base directory.
      * @return the DocumentNameMatcher for the base directory.
      */

apache-rat-core/src/main/java/org/apache/rat/config/exclusion/ExclusionProcessor.java

@@ -36,7 +36,7 @@
 
 /**
  * Processes the include and exclude patterns and applies the result against a base directory
- * to return an IReportable that contains all the reportable objects.
+ * to return a Reportable that contains all the reportable objects.
  */
 public class ExclusionProcessor {
     /** Strings that identify the files/directories to exclude */

apache-rat-core/src/main/java/org/apache/rat/walker/FileListWalker.java

@@ -34,7 +34,7 @@
 import org.apache.rat.utils.DefaultLog;
 
 /**
- * Implementation of IReportable that traverses over a resource collection
+ * Implementation of Reportable that traverses over a resource collection
  * internally.
  */
 public class FileListWalker implements Reportable {

apache-rat-core/src/main/java/org/apache/rat/walker/ReportableListWalker.java

@@ -29,7 +29,7 @@
 import org.apache.rat.utils.DefaultLog;
 
 /**
- * A Reportable that walks a list of IReportables and executes the run on each.
+ * A Reportable that walks a list of Reportables and executes the run on each.
  */
 public final class ReportableListWalker implements Reportable {
     /** The document name for this walker. */
@@ -77,7 +77,7 @@ public DocumentName name() {
     public static final class Builder {
         /** The document name for the walker. */
         private final DocumentName documentName;
-        /** The list of IReportable objects to execute. */
+        /** The list of Reportable objects to execute. */
         private List<Reportable> reportables = new ArrayList<>();
 
         /**

apache-rat-core/src/main/java/org/apache/rat/walker/Walker.java

@@ -28,11 +28,11 @@
  */
 public abstract class Walker implements Reportable {
 
-    /** The document this walker is walking */
+    /** The document this walker is walking. */
     private final Document document;
 
     /**
-     * Creates the walker
+     * Creates the walker.
      * @param document The document the walker is walking.
      */
     protected Walker(final Document document) {

apache-rat-tasks/src/main/java/org/apache/rat/anttasks/ResourceCollectionContainer.java

@@ -29,15 +29,15 @@
 import org.apache.tools.ant.types.resources.FileResource;
 
 /**
- * Implementation of IReportable that traverses over a resource collection
+ * Implementation of Reportable that traverses over a resource collection
  * internally.
  */
 class ResourceCollectionContainer implements Reportable {
-    /** The resources as collected by Ant */
+    /** The resources as collected by Ant. */
     private final ResourceCollection resources;
-    /** The report configuration being used for the report */
+    /** The report configuration being used for the report. */
     private final ReportConfiguration configuration;
-    /** The document name */
+    /** The document name. */
     private final DocumentName name;
 
     ResourceCollectionContainer(final DocumentName name, final ReportConfiguration configuration, final ResourceCollection resources) {

src/site/markdown/architecture.md

@@ -87,10 +87,10 @@ The `out` parameter specifies an `OutputStream` IOSupplier that is used to creat
 
 The `styleSheet` parameter specifies the `InputStream` IOSupplier that is used to read the stylesheet that styles the XML output.
 
-## IReportable
+## Reportable
 
-The `IReportable` parameter identifies the objects that the report should run against.
-Implementations of `IReportable` generally do things like walk directory trees, or archives.
+The `Reportable` parameter identifies the objects that the report should run against.
+Implementations of `Reportable` generally do things like walk directory trees, or archives.
 
 # Reporter