Added class descriptions for the interfaces for easy reference.

git-svn-id: https://svn.apache.org/repos/asf/maven/repository-manager/trunk@349898 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java b/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java
index 836e1132bc18e6179bbf2359f05d5d6d861ceccc..7dd230a5000bcb6f91ac26cc5d9c81f9cfd47ea5 100644 (file)
--- a/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java
+++ b/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java
@@ -20,6 +20,10 @@ package org.apache.maven.repository.reporting;
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.model.Model;
 
+/**
+ * This interface will be called by the main system for each artifact as it is discovered. This is how each of the 
+ *      different types of reports are implemented.
+ */
 public interface ArtifactReportProcessor
 {
     String ROLE = ArtifactReportProcessor.class.getName();

diff --git a/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java b/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java
index a916ba0c2881a612ff7bb29c27b475fbb22ddabe..7b64d6867f256b24f6dd43433556079be2d76b26 100644 (file)
--- a/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java
+++ b/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java
@@ -18,6 +18,13 @@ package org.apache.maven.repository.reporting;
 
 import org.apache.maven.artifact.Artifact;
 
+/**
+ * This interface is used by the single artifact processor.
+ *
+ * The initial implementation of this will just need to be a mock implementation in src/test/java, used to track the 
+ *      failures and successes for checking assertions. Later, implementations will be made to present reports on the 
+ *      web interface, send them via mail, and so on.
+ */
 public interface ArtifactReporter
 {
     String ROLE = ArtifactReporter.class.getName();

diff --git a/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java b/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java
index ae532888583724ca6adbc85134126a10da7405f7..62625f43a866f0da715d1d7561b0de68c797f07b 100644 (file)
--- a/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java
+++ b/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java
@@ -19,6 +19,9 @@ package org.apache.maven.repository.reporting;
 
 import org.apache.maven.artifact.repository.metadata.RepositoryMetadata;
 
+/**
+ * This interface is called by the main system for each piece of metadata as it is discovered.
+ */
 public interface MetadataReportProcessor
 {
     String ROLE = MetadataReportProcessor.class.getName();

diff --git a/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java b/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java
index 2de686792c5f2c586623d4e538f7c32e67b15e56..c4965a03b3a015c42416dae2ac8d2c1c44d0f46a 100644 (file)
--- a/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java
+++ b/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java
@@ -19,6 +19,9 @@ package org.apache.maven.repository.reporting;
 
 import org.apache.maven.artifact.Artifact;
 
+/**
+ * The transitive and metadata validation reports will need to query the repository for artifacts.
+ */
 public interface RepositoryQueryLayer
 {
     String ROLE = RepositoryQueryLayer.class.getName();