diff gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java @ 792:9b9bf42b7928

Added and repaired JavaDoc in artifacts package. gnv-artifacts/trunk@874 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Wed, 31 Mar 2010 10:52:34 +0000
parents c4156275c1e1
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java	Wed Mar 31 09:30:34 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java	Wed Mar 31 10:52:34 2010 +0000
@@ -1,6 +1,8 @@
 package de.intevation.gnv.artifacts.services.requestobjects;
 
 /**
+ * The  default implementation of <code>Layer</code>.
+ *
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
@@ -14,8 +16,13 @@
     private boolean groupLayer = false;
 
     private String parentId = null;
+
     /**
      * Constructor
+     * @param id The id of this layer.
+     * @param name The name of this layer.
+     * @param groupLayer A boolean property to define this layer as group layer.
+     * @param parentId The id of the parent layer.
      */
     public DefaultLayer(String id,String name,
                         boolean groupLayer,String parentId) {
@@ -26,35 +33,39 @@
     }
 
 
-
     /**
-     * @see de.intevation.gnv.artifactdatabase.objects.map.Layer#getID()
+     * @return
      */
     public String getID() {
         return this.id;
     }
 
     /**
-     * @see de.intevation.gnv.artifactdatabase.objects.map.Layer#getName()
+     * @return
      */
     public String getName() {
         return this.name;
     }
 
     /**
-     * @see de.intevation.gnv.artifactdatabase.objects.map.Layer#isGroupLayer()
+     * @return
      */
     public boolean isGroupLayer() {
         return this.groupLayer;
     }
 
     /**
-     * @see de.intevation.gnv.artifactdatabase.objects.map.Layer#parentID()
+     * @return
      */
     public String parentID() {
         return this.parentId;
     }
 
+    /**
+     * This methods returns this layer as string.
+     * 
+     * @return this layer as string.
+     */
     @Override
     public String toString() {
         return "ID: "+ this.id + " Name: "+this.name+
@@ -63,3 +74,4 @@
     }
 
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org