svn commit: r761488 - in /maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository: MetadataGraph.java MetadataGraphNode.java RepositorySystem.java

[og...@apache.org]

Author: ogusakov
Date: Fri Apr  3 00:17:31 2009
New Revision: 761488

URL: http://svn.apache.org/viewvc?rev=761488&view=rev
Log:
some javadocs for the new metadata-only call in the repository system

Modified:
    maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraph.java
    maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraphNode.java
    maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/RepositorySystem.java

Modified: maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraph.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraph.java?rev=761488&r1=761487&r2=761488&view=diff
==============================================================================
--- maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraph.java (original)
+++ maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraph.java Fri Apr  3 00:17:31 2009
@@ -23,7 +23,7 @@
 import java.util.Collection;
 
 /**
- *
+ * This is the main graph data structure used by the RepositorySystem to present tree and graph objects. 
  *
  * @author Oleg Gusakov
  * @version $Id$
@@ -31,7 +31,10 @@
  */
 public class MetadataGraph
 {
+    /** all graph nodes */
     Collection<MetadataGraphNode> nodes;
+
+    /** entry point for tree-like structures */
     MetadataGraphNode             entry;
     
     public MetadataGraph( MetadataGraphNode entry )
@@ -51,6 +54,12 @@
         nodes.add( node );
     }
 
+    /**
+     * find a node by the GAV (metadata)
+     * 
+     * @param md
+     * @return
+     */
     public MetadataGraphNode findNode( MavenArtifactMetadata md )
     {
         for( MetadataGraphNode mgn : nodes )
@@ -63,11 +72,21 @@
         return node;
     }
     
+    /**
+     * getter
+     * 
+     * @return
+     */
     public MetadataGraphNode getEntry()
     {
         return entry;
     }
     
+    /**
+     * getter
+     * 
+     * @return
+     */
     public Collection<MetadataGraphNode> getNodes()
     {
         return nodes;

Modified: maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraphNode.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraphNode.java?rev=761488&r1=761487&r2=761488&view=diff
==============================================================================
--- maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraphNode.java (original)
+++ maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/MetadataGraphNode.java Fri Apr  3 00:17:31 2009
@@ -23,7 +23,7 @@
 import java.util.List;
 
 /**
- *
+ * MetadataGraph node - as it's a directed graph - holds adjacency lists for incident and exident nodes
  *
  * @author Oleg Gusakov
  * @version $Id$
@@ -31,9 +31,13 @@
  */
 public class MetadataGraphNode
 {
+    /** node payload */
     MavenArtifactMetadata   metadata;
 
+    /** nodes, incident to this (depend on me) */
     List<MetadataGraphNode> inNodes;
+    
+    /** nodes, exident to this (I depend on) */
     List<MetadataGraphNode> exNodes;
     
     public MetadataGraphNode()

Modified: maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/RepositorySystem.java
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/RepositorySystem.java?rev=761488&r1=761487&r2=761488&view=diff
==============================================================================
--- maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/RepositorySystem.java (original)
+++ maven/components/trunk/maven-repository/src/main/java/org/apache/maven/repository/RepositorySystem.java Fri Apr  3 00:17:31 2009
@@ -66,6 +66,15 @@
 
     ArtifactResolutionResult resolve( ArtifactResolutionRequest request );
 
+    /**
+     * this is the new metadata-based entry point into repository system. By default - it will transitively resolve metadata
+     * for the supplied root GAV and return a flat set of dependency metadatas. Tweaking the request allows user to ask for 
+     * various formats of the response - resolved tree, resolved graph or dirty tree. Only the resolved tree is implemented now
+     * in MercuryRepositorySystem, LegacyRepositorySystem ignores this call for now.  
+     * 
+     * @param request - supplies all necessary details for the resolution configuration
+     * @return
+     */
     MetadataResolutionResult resolveMetadata( MetadataResolutionRequest request );
        
     //REMOVE