svn commit: r349898 - in /maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting: ArtifactReportProcessor.java ArtifactReporter.java MetadataReportProcessor.java RepositoryQueryLayer.java

[ep...@apache.org]

Author: epunzalan
Date: Tue Nov 29 22:35:33 2005
New Revision: 349898

URL: http://svn.apache.org/viewcvs?rev=349898&view=rev
Log:
Added class descriptions for the interfaces for easy reference.

Modified:
    maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java
    maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java
    maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java
    maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java

Modified: maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java
URL: http://svn.apache.org/viewcvs/maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java?rev=349898&r1=349897&r2=349898&view=diff
==============================================================================
--- maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java (original)
+++ maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReportProcessor.java Tue Nov 29 22:35:33 2005
@@ -20,6 +20,10 @@
 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();

Modified: maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java
URL: http://svn.apache.org/viewcvs/maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java?rev=349898&r1=349897&r2=349898&view=diff
==============================================================================
--- maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java (original)
+++ maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/ArtifactReporter.java Tue Nov 29 22:35:33 2005
@@ -18,6 +18,13 @@
 
 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();

Modified: maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java
URL: http://svn.apache.org/viewcvs/maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java?rev=349898&r1=349897&r2=349898&view=diff
==============================================================================
--- maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java (original)
+++ maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/MetadataReportProcessor.java Tue Nov 29 22:35:33 2005
@@ -19,6 +19,9 @@
 
 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();

Modified: maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java
URL: http://svn.apache.org/viewcvs/maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java?rev=349898&r1=349897&r2=349898&view=diff
==============================================================================
--- maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java (original)
+++ maven/repository-manager/trunk/maven-repository-reports-standard/src/main/java/org/apache/maven/repository/reporting/RepositoryQueryLayer.java Tue Nov 29 22:35:33 2005
@@ -19,6 +19,9 @@
 
 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();