Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultOutputMode.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/DefaultOutputMode.java Wed Mar 31 13:48:07 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultOutputMode.java Thu Apr 01 09:15:36 2010 +0000 @@ -4,6 +4,8 @@ import java.util.List; /** + * The default implementation of <code>OutputMode</code>. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> */ @@ -22,9 +24,11 @@ /** * Constructor * - * @param name - * @param description - * @param mimeType + * @param name The name of the output mode. + * @param description The description of this output mode. + * @param mimeType The mime type used by this output mode. + * @param inputParameters The input parameters required by this output mode. + * @param exportModes The export modes for this output mode. */ public DefaultOutputMode( String name, @@ -42,28 +46,28 @@ } /** - * @see de.intevation.gnv.state.OutputMode#getDescription() + * @return the description. */ public String getDescription() { return this.description; } /** - * @see de.intevation.gnv.state.OutputMode#getMimeType() + * @return the mime type. */ public String getMimeType() { return this.mimeType; } /** - * @see de.intevation.gnv.state.OutputMode#getName() + * @return the name. */ public String getName() { return this.name; } /** - * @see java.lang.Object#toString() + * @return this output mode as string. */ @Override public String toString() { @@ -72,15 +76,19 @@ } /** - * @see de.intevation.gnv.state.OutputMode#getInputParameters() + * @return the input parameters. */ public Collection<InputValue> getInputParameters() { return this.inputParameters; } + /** + * + * @return the export modes. + */ public List<ExportMode> getExportModes() { return exportModes; } } -// 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 :