Fix checkstyle errors

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115207 13f79535-47bb-0310-9956-ffa450edef68

xdoc/src/main/org/apache/maven/DescribedDependency.java

@@ -16,157 +16,222 @@ package org.apache.maven;
  *   limitations under the License.
  * ====================================================================
  */
-
 import org.apache.maven.project.Dependency;
 
+
 /**
- * 
- * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a> 
- * @version $Id: DescribedDependency.java,v 1.2 2004/03/02 15:36:14 evenisse Exp $
+ * Dependency wrapper. Adds an url to download and a description.
+ *
+ * @author <a href="mailto:michal.maczka@dimatics.com">Michal Maczka</a>
+ * @version $Id: DescribedDependency.java,v 1.3 2004/05/09 20:58:49 aheritier Exp $
  */
 public class DescribedDependency implements Comparable
 {
-    private Dependency dependency;
+  //~ Instance fields ----------------------------------------------------------
 
-    private String description = null;
+  /** Original dependency. */
+  private Dependency dependency;
 
-    private String url = null;
+  /** Dependency description. */
+  private String description = null;
 
-    public DescribedDependency(Dependency dependency)
+  /** Dependency Url. */
+  private String url = null;
+
+  //~ Constructors -------------------------------------------------------------
+
+  /**
+   * Creates a new DescribedDependency object.
+   *
+   * @param dependencyToWrap Original dependency.
+   */
+  public DescribedDependency(Dependency dependencyToWrap)
+  {
+    this.dependency = dependencyToWrap;
+  }
+
+  //~ Methods ------------------------------------------------------------------
+
+  /**
+   * Dependency's artifact property getter.
+   *
+   * @return dependency's artifact.
+   *
+   * @see Dependency#getArtifact()
+   */
+  public String getArtifact()
+  {
+    return dependency.getArtifact();
+  }
+
+  /**
+   * Dependency's artifactDirectory property getter.
+   *
+   * @return dependency's artifactDirectory.
+   *
+   * @see Dependency#getArtifactDirectory()
+   */
+  public String getArtifactDirectory()
+  {
+    return dependency.getArtifactDirectory();
+  }
+
+  /**
+   * Dependency's artifactId property getter.
+   *
+   * @return dependency's artifactId.
+   *
+   * @see Dependency#getArtifactId()
+   */
+  public String getArtifactId()
+  {
+    return dependency.getArtifactId();
+  }
+
+  /**
+   * Property setter.
+   *
+   * @param newDescription new description for the dependency.
+   *
+   */
+  public void setDescription(String newDescription)
+  {
+    this.description = newDescription;
+  }
+
+  /**
+   * Property getter.
+   *
+   * @return the dependency's description.
+   *
+   */
+  public String getDescription()
+  {
+    return description;
+  }
+
+  /**
+   * Dependency's extension property getter.
+   *
+   * @return dependency's extension.
+   *
+   * @see Dependency#getExtension()
+   */
+  public String getExtension()
+  {
+    return dependency.getExtension();
+  }
+
+  /**
+   * Dependency's groupId property getter.
+   *
+   * @return dependency's groupId.
+   *
+   * @see Dependency#getGroupId()
+   */
+  public String getGroupId()
+  {
+    return dependency.getGroupId();
+  }
+
+  /**
+   * Dependency's id property getter.
+   *
+   * @return dependency's id.
+   *
+   * @see Dependency#getId()
+   */
+  public String getId()
+  {
+    return dependency.getId();
+  }
+
+  /**
+   * Dependency's jar property getter.
+   *
+   * @return dependency's jar.
+   *
+   * @see Dependency#getJar()
+   */
+  public String getJar()
+  {
+    return dependency.getJar();
+  }
+
+  /**
+   * Dependency's name property getter.
+   *
+   * @return dependency's name.
+   *
+   * @see Dependency#getName()
+   */
+  public String getName()
+  {
+    return dependency.getName();
+  }
+
+  /**
+   * Dependency's type property getter.
+   *
+   * @return dependency's type.
+   *
+   * @see Dependency#getType()
+   */
+  public String getType()
+  {
+    return dependency.getType();
+  }
+
+  /**
+   * Property setter.
+   *
+   * @param newUrl the new dependency's url.
+   */
+  public void setUrl(String newUrl)
+  {
+    this.url = newUrl;
+  }
+
+  /**
+   * Property getter.
+   *
+   * @return the dependency's url.
+   */
+  public String getUrl()
+  {
+    String retValue = null;
+
+    if ((dependency.getUrl() != null) && (dependency.getUrl().length() > 0))
     {
-        this.dependency = dependency;
+      retValue = dependency.getUrl();
+    }
+    else
+    {
+      return retValue = url;
     }
 
-    /**
-     * @see java.lang.Comparable#compareTo(java.lang.Object)
-     */
-    public int compareTo(Object obj)
-    {
-        DescribedDependency other = (DescribedDependency) obj;
-        return this.getId().compareTo(other.getId()); 
-    }
-    /**
-     * @return
-     */
-    public String getArtifact()
-    {
-        return dependency.getArtifact();
-    }
+    return retValue;
+  }
 
-    /**
-     * @return
-     */
-    public String getArtifactDirectory()
-    {
-        return dependency.getArtifactDirectory();
-    }
+  /**
+   * Dependency's version property getter.
+   *
+   * @return dependency's version.
+   *
+   * @see Dependency#getVersion()
+   */
+  public String getVersion()
+  {
+    return dependency.getVersion();
+  }
 
-    /**
-     * @return
-     */
-    public String getArtifactId()
-    {
-        return dependency.getArtifactId();
-    }
-
-    /**
-     * @return
-     */
-    public String getExtension()
-    {
-        return dependency.getExtension();
-    }
-
-    /**
-     * @return
-     */
-    public String getGroupId()
-    {
-        return dependency.getGroupId();
-    }
-
-    /**
-     * @return
-     */
-    public String getId()
-    {
-        return dependency.getId();
-    }
-
-    /**
-     * @return
-     */
-    public String getJar()
-    {
-        return dependency.getJar();
-    }
-
-    /**
-     * @return
-     */
-    public String getName()
-    {
-        return dependency.getName();
-    }
-
-    /**
-     * @return
-     */
-    public String getType()
-    {
-        return dependency.getType();
-    }
-
-    /**
-     * 
-     * @param url
-     */
-    public void setUrl(String url)
-    {
-        this.url = url;
-    }
-
-    /**
-     * @return
-     */
-    public String getUrl()
-    {
-        String retValue = null;
-        if (dependency.getUrl() != null && dependency.getUrl().length()>0)
-        {
-            retValue = dependency.getUrl();
-        }
-        else
-        {
-
-            return retValue = url;
-        }
-        return retValue;
-    }
-
-    /**
-     * @return
-     */
-    public String getVersion()
-    {
-        return dependency.getVersion();
-    }
-
-    /**
-    /**
-     * @return
-     */
-    public String getDescription()
-    {
-        return description;
-    }
-
-    /**
-     * @param description
-     */
-    public void setDescription(String description)
-    {
-        this.description = description;
-    }
+  /**
+   * @see java.lang.Comparable#compareTo(java.lang.Object)
+   */
+  public int compareTo(Object obj)
+  {
+    DescribedDependency other = (DescribedDependency) obj;
 
+    return this.getId().compareTo(other.getId());
+  }
 }