You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm@geronimo.apache.org by jd...@apache.org on 2008/11/30 09:21:42 UTC
svn commit: r721785 - in
/geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact:
ArtifactFilter.java ArtifactResolver.java transfer/TransferListener.java
Author: jdillon
Date: Sun Nov 30 00:21:41 2008
New Revision: 721785
URL: http://svn.apache.org/viewvc?rev=721785&view=rev
Log:
Update javadoc
Modified:
geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java
geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java
geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java
Modified: geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java?rev=721785&r1=721784&r2=721785&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java (original)
+++ geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactFilter.java Sun Nov 30 00:21:41 2008
@@ -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
Modified: geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java?rev=721785&r1=721784&r2=721785&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java (original)
+++ geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/ArtifactResolver.java Sun Nov 30 00:21:41 2008
@@ -30,14 +30,19 @@
*/
public interface ArtifactResolver
{
+ /**
+ * Install a transfer listener.
+ */
void setTransferListener(TransferListener listener);
-
- Result resolve(Request request) throws Failure;
- //
- // Request
- //
+ /**
+ * Resolve a request.
+ */
+ Result resolve(Request request) throws Failure;
+ /**
+ * 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
{
Modified: geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java
URL: http://svn.apache.org/viewvc/geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java?rev=721785&r1=721784&r2=721785&view=diff
==============================================================================
--- geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java (original)
+++ geronimo/gshell/trunk/gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferListener.java Sun Nov 30 00:21:41 2008
@@ -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