commit 9bb7ecea708612be3c3646f8b549a4abd9fe20e3
author Jason Dillon <jdillon@apache.org> Sun Nov 30 08:21:41 2008 +0000
committer Jason Dillon <jdillon@apache.org> Sun Nov 30 08:21:41 2008 +0000
tree 84a00ab55174cb36bd1381b64b3b11fd3a74924e
parent 40ffcbec52571399c14476fc3325ce632ae404d4

Update javadoc


git-svn-id: https://svn.apache.org/repos/asf/geronimo/gshell/trunk@721785 13f79535-47bb-0310-9956-ffa450edef68

gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java

diff --git a/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java b/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java
index e4c0ef4..f69ca1a 100644
--- a/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java
+++ b/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java
@@ -26,5 +26,8 @@
  */
 public interface ArtifactFilter
 {
+    /**
+     * Return {@link true} if the given artifact should be included in results.
+     */
     boolean accept(Artifact artifact);
 }
\ No newline at end of file

gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java

diff --git a/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java b/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java
index d12f6d4..ce8094d 100644
--- a/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java
+++ b/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java
@@ -30,14 +30,19 @@
  */
 public interface ArtifactResolver
 {
+    /**
+     * Install a transfer listener.
+     */
     void setTransferListener(TransferListener listener);
-    
+
+    /**
+     * Resolve a request.
+     */
     Result resolve(Request request) throws Failure;
 
-    //
-    // Request
-    //
-
+    /**
+     * Artifact resolution request.
+     */
     class Request
     {
         public ArtifactFilter filter;
@@ -47,19 +52,17 @@
         public Collection<Artifact> artifacts;
     }
 
-    //
-    // Result
-    //
-
+    /**
+     * Artifact resolution result.
+     */
     class Result
     {
         public Collection<Artifact> artifacts;
     }
 
-    //
-    // Failure
-    //
-
+    /**
+     * Artifact resolution failure.
+     */
     class Failure
         extends Exception
     {

gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java

diff --git a/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java b/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java
index 76e1b0c..5c0437c 100644
--- a/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java
+++ b/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java
@@ -26,11 +26,23 @@
  */
 public interface TransferListener
 {
+    /**
+     * Signal the start of a transfer.
+     */
     void transferStarted(TransferEvent event);
 
+    /**
+     * Siginal transfer progress.
+     */
     void transferProgress(TransferEvent event);
 
+    /**
+     * Signal the end of a transfer.
+     */
     void transferCompleted(TransferEvent event);
 
+    /**
+     * Signal that a transfer has failed.
+     */
     void transferFailed(TransferEvent event);
 }
\ No newline at end of file