From 77055caf4ca20f750f8031679e818cda9af09815 Mon Sep 17 00:00:00 2001
From: "Edwin L. Punzalan" <epunzalan@apache.org>
Date: Wed, 30 Nov 2005 06:35:33 +0000
Subject: [PATCH] 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
---
 .../repository/reporting/ArtifactReportProcessor.java      | 4 ++++
 .../maven/repository/reporting/ArtifactReporter.java       | 7 +++++++
 .../repository/reporting/MetadataReportProcessor.java      | 3 +++
 .../maven/repository/reporting/RepositoryQueryLayer.java   | 3 +++
 4 files changed, 17 insertions(+)

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 836e1132b..7dd230a50 100644
--- 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 a916ba0c2..7b64d6867 100644
--- 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 ae5328885..62625f43a 100644
--- 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 2de686792..c4965a03b 100644
--- 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();