diff gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultExportMode.java @ 796:a5526908f92f

Added javadoc in state package. gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 01 Apr 2010 09:15:36 +0000
parents c4156275c1e1
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultExportMode.java	Wed Mar 31 13:48:07 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultExportMode.java	Thu Apr 01 09:15:36 2010 +0000
@@ -1,31 +1,63 @@
 package de.intevation.gnv.state;
 
 /**
+ * This is the default implementation of <code>ExportMode</code>.
+ * 
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class DefaultExportMode
 implements   ExportMode
 {
+    /**
+     * The name of the export (e.g. pdf, svg, image).
+     */
     protected String name;
+
+    /**
+     * A description for this export.
+     */
     protected String description;
+
+    /**
+     * The mimetype used to do execute this export.
+     */
     protected String mimeType;
 
+    /**
+     * Constructor.
+     *
+     * @param name
+     * @param description
+     * @param mimeType
+     */
     public DefaultExportMode(String name, String description, String mimeType){
         this.name        = name;
         this.description = description;
         this.mimeType    = mimeType;
     }
 
+    /**
+     *
+     * @return
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     *
+     * @return
+     */
     public String getDescription() {
         return description;
     }
 
+    /**
+     *
+     * @return
+     */
     public String getMimeType() {
         return mimeType;
     }
 }
-// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8:
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org