Fixed several checkstyle reported errors/warnings.
authorKarl Heinz Marbaise <khmarbaise@apache.org>
Mon, 7 Dec 2015 20:52:20 +0000 (20:52 +0000)
committerKarl Heinz Marbaise <khmarbaise@apache.org>
Mon, 7 Dec 2015 20:52:20 +0000 (20:52 +0000)
git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1718461 13f79535-47bb-0310-9956-ffa450edef68

src/main/java/org/apache/maven/shared/io/download/DefaultDownloadManager.java
src/main/java/org/apache/maven/shared/io/download/DownloadFailedException.java
src/main/java/org/apache/maven/shared/io/download/DownloadManager.java
src/main/java/org/apache/maven/shared/io/location/ArtifactLocation.java

index 7532a55..463d026 100644 (file)
@@ -41,31 +41,46 @@ import org.apache.maven.wagon.authorization.AuthorizationException;
 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
     {
index aa5f127..669ce8b 100644 (file)
@@ -19,6 +19,10 @@ package org.apache.maven.shared.io.download;
  * 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;
index 8d3b990..6d2e91a 100644 (file)
@@ -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;
 
index f595537..dea6e68 100644 (file)
@@ -21,10 +21,18 @@ package org.apache.maven.shared.io.location;
 
 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 );