You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2015/12/07 21:52:20 UTC
svn commit: r1718461 - in
/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io:
download/DefaultDownloadManager.java download/DownloadFailedException.java
download/DownloadManager.java location/ArtifactLocation.java
Author: khmarbaise
Date: Mon Dec 7 20:52:20 2015
New Revision: 1718461
URL: http://svn.apache.org/viewvc?rev=1718461&view=rev
Log:
Fixed several checkstyle reported errors/warnings.
Modified:
maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java
maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadFailedException.java
maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadManager.java
maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocation.java
Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java?rev=1718461&r1=1718460&r2=1718461&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java (original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java Mon Dec 7 20:52:20 2015
@@ -41,31 +41,46 @@ import org.apache.maven.wagon.authorizat
import org.apache.maven.wagon.events.TransferListener;
import org.apache.maven.wagon.repository.Repository;
+/**
+ * The Implementation of the {@link DownloadManager}.
+ *
+ */
public class DefaultDownloadManager
implements DownloadManager
{
+ /**
+ * Role hint.
+ */
public static final String ROLE_HINT = "default";
private WagonManager wagonManager;
private Map<String, File> cache = new HashMap<String, File>();
+ /**
+ * Create an instance of the {@code DefaultDownloadManager}.
+ */
public DefaultDownloadManager()
{
}
+ /**
+ * @param wagonManager {@Link org.apache.maven.repository.legacy.WagonManager}
+ */
public DefaultDownloadManager( WagonManager wagonManager )
{
this.wagonManager = wagonManager;
}
+ /** {@inheritDoc} */
public File download( String url, MessageHolder messageHolder )
throws DownloadFailedException
{
return download( url, Collections.<TransferListener>emptyList(), messageHolder );
}
+ /** {@inheritDoc} */
public File download( String url, List<TransferListener> transferListeners, MessageHolder messageHolder )
throws DownloadFailedException
{
Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadFailedException.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadFailedException.java?rev=1718461&r1=1718460&r2=1718461&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadFailedException.java (original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadFailedException.java Mon Dec 7 20:52:20 2015
@@ -19,6 +19,10 @@ package org.apache.maven.shared.io.downl
* under the License.
*/
+/**
+ * The Download Failed Exception.
+ *
+ */
public class DownloadFailedException
extends Exception
{
@@ -27,18 +31,30 @@ public class DownloadFailedException
private String url;
+ /**
+ * @param url The url.
+ * @param message The message.
+ * @param cause The cause of the problem.
+ */
public DownloadFailedException( String url, String message, Throwable cause )
{
super( message, cause );
this.url = url;
}
+ /**
+ * @param url The url.
+ * @param message The message.
+ */
public DownloadFailedException( String url, String message )
{
super( message );
this.url = url;
}
+ /**
+ * @return The url.
+ */
public String getUrl()
{
return url;
Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadManager.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadManager.java?rev=1718461&r1=1718460&r2=1718461&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadManager.java (original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/download/DownloadManager.java Mon Dec 7 20:52:20 2015
@@ -25,13 +25,33 @@ import java.util.List;
import org.apache.maven.shared.io.logging.MessageHolder;
import org.apache.maven.wagon.events.TransferListener;
+/**
+ * The Download Manager interface.
+ *
+ */
public interface DownloadManager
{
+ /**
+ * The Role.
+ */
String ROLE = DownloadManager.class.getName();
+ /**
+ * @param url The URL.
+ * @param messageHolder {@link MessageHolder}
+ * @return {@link File}
+ * @throws DownloadFailedException in case of exception.
+ */
File download( String url, MessageHolder messageHolder )
throws DownloadFailedException;
+ /**
+ * @param url The URL.
+ * @param transferListeners {@link TransferListener}
+ * @param messageHolder {@link MessageHolder}
+ * @return {@link File}
+ * @throws DownloadFailedException in case of exception.
+ */
File download( String url, List<TransferListener> transferListeners, MessageHolder messageHolder )
throws DownloadFailedException;
Modified: maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocation.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocation.java?rev=1718461&r1=1718460&r2=1718461&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocation.java (original)
+++ maven/shared/trunk/maven-shared-io/src/main/java/org/apache/maven/shared/io/location/ArtifactLocation.java Mon Dec 7 20:52:20 2015
@@ -21,10 +21,18 @@ package org.apache.maven.shared.io.locat
import org.apache.maven.artifact.Artifact;
+/**
+ * The artifact location.
+ *
+ */
public class ArtifactLocation
extends FileLocation
{
+ /**
+ * @param artifact {@link Artifact}
+ * @param specification The specification.
+ */
public ArtifactLocation( Artifact artifact, String specification )
{
super( specification );