diff gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ExportMode.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 af22fa5567a6
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ExportMode.java	Mon Apr 12 10:56:55 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ExportMode.java	Mon Apr 12 16:45:16 2010 +0000
@@ -3,13 +3,33 @@
 import java.io.Serializable;
 
 /**
+ * An <code>ExportMode</code> describes a specific format of an output mode
+ * (e.g. pdf, svg, image).
+ * 
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public interface ExportMode
 extends          Serializable
 {
+    /**
+     * Returns the name of this export mode.
+     *
+     * @return the name.
+     */
     public String getName();
+
+    /**
+     * Returns the description of this export mode.
+     *
+     * @return the description.
+     */
     public String getDescription();
+
+    /**
+     * Returns the mimetype used for this export mode.
+     * 
+     * @return the 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