diff gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java @ 690:254f062e334b

Added JavaDoc. gnv/trunk@908 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Mon, 12 Apr 2010 16:45:16 +0000
parents 57fa8019fbdc
children d4d1eb56d725
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java	Mon Apr 12 10:56:55 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java	Mon Apr 12 16:45:16 2010 +0000
@@ -2,7 +2,6 @@
 
 /**
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
- *
  */
 public class ArtifactFactory implements ArtifactObject {
 
@@ -20,6 +19,8 @@
     private String dataBaseUrl = null;
 
     /**
+     * Returns the url of the artifact server.
+     * 
      * @return the dataBaseUrl
      */
     public String getDataBaseUrl() {
@@ -40,49 +41,44 @@
         this.dataBaseUrl = dataBaseUrl;
     }
 
-    /**
-     * @see de.intevation.gnv.artifactdatabase.objects.ArtifactObject#getId()
-     */
+
     public String getId() {
         return this.name;
     }
 
-    /**
-     * @see de.intevation.gnv.artifactdatabase.objects.ArtifactObject#isSelected()
-     */
+
     public boolean isSelected() {
 
         return this.selected;
     }
 
-    /**
-     * @see de.intevation.gnv.artifactdatabase.objects.ArtifactObject#setSelected(boolean)
-     */
+
     public void setSelected(boolean selected) {
         this.selected = selected;
     }
 
-    /**
-     * @see de.intevation.gnv.artifactdatabase.objects.ArtifactObject#getName()
-     */
+
     public String getName() {
         return name;
     }
 
-    /**
-     * @see de.intevation.gnv.artifactdatabase.objects.ArtifactObject#getDescription()
-     */
+
     public String getDescription() {
         return description;
     }
 
-    /**
-     * @see de.intevation.gnv.artifactdatabase.objects.ArtifactObject#getHash()
-     */
+
     public String getHash() {
         return null;
     }
 
+    /**
+     * Two ArtifactFactories are equal, if the name and the url to the artifact
+     * server are equal.
+     * 
+     * @param obj
+     * @return true, if the factories are equal - otherwise false.
+     */
     @Override
     public boolean equals(Object obj) {
         boolean returnValue = false;
@@ -93,5 +89,5 @@
         }
         return returnValue;
     }
-
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org