diff gnv-artifacts/src/main/java/de/intevation/gnv/state/ExportMode.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 f953c9a559d8
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/ExportMode.java	Wed Mar 31 13:48:07 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/ExportMode.java	Thu Apr 01 09:15:36 2010 +0000
@@ -3,13 +3,32 @@
 import java.io.Serializable;
 
 /**
+ * This interface defines basic methods which are necessary for exports.
+ *
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public interface ExportMode
 extends          Serializable
 {
+    /**
+     * Return the export name (e.g. pdf, svg, image).
+     *
+     * @return the export name.
+     */
     public String getName();
+
+    /**
+     * Return the description for this export.
+     *
+     * @return the export description.
+     */
     public String getDescription();
+
+    /**
+     * Returns the mime type used by this export.
+     *
+     * @return export's mimetype.
+     */
     public String getMimeType();
 }
-// 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