comparison 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
comparison
equal deleted inserted replaced
795:cdade5005cba 796:a5526908f92f
2 2
3 import java.util.Collection; 3 import java.util.Collection;
4 import java.util.List; 4 import java.util.List;
5 5
6 /** 6 /**
7 * The default implementation of <code>OutputMode</code>.
8 *
7 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> 9 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
8 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> 10 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
9 */ 11 */
10 public class DefaultOutputMode implements OutputMode { 12 public class DefaultOutputMode implements OutputMode {
11 13
20 private List<ExportMode> exportModes; 22 private List<ExportMode> exportModes;
21 23
22 /** 24 /**
23 * Constructor 25 * Constructor
24 * 26 *
25 * @param name 27 * @param name The name of the output mode.
26 * @param description 28 * @param description The description of this output mode.
27 * @param mimeType 29 * @param mimeType The mime type used by this output mode.
30 * @param inputParameters The input parameters required by this output mode.
31 * @param exportModes The export modes for this output mode.
28 */ 32 */
29 public DefaultOutputMode( 33 public DefaultOutputMode(
30 String name, 34 String name,
31 String description, 35 String description,
32 String mimeType, 36 String mimeType,
40 this.inputParameters = inputParameters; 44 this.inputParameters = inputParameters;
41 this.exportModes = exportModes; 45 this.exportModes = exportModes;
42 } 46 }
43 47
44 /** 48 /**
45 * @see de.intevation.gnv.state.OutputMode#getDescription() 49 * @return the description.
46 */ 50 */
47 public String getDescription() { 51 public String getDescription() {
48 return this.description; 52 return this.description;
49 } 53 }
50 54
51 /** 55 /**
52 * @see de.intevation.gnv.state.OutputMode#getMimeType() 56 * @return the mime type.
53 */ 57 */
54 public String getMimeType() { 58 public String getMimeType() {
55 return this.mimeType; 59 return this.mimeType;
56 } 60 }
57 61
58 /** 62 /**
59 * @see de.intevation.gnv.state.OutputMode#getName() 63 * @return the name.
60 */ 64 */
61 public String getName() { 65 public String getName() {
62 return this.name; 66 return this.name;
63 } 67 }
64 68
65 /** 69 /**
66 * @see java.lang.Object#toString() 70 * @return this output mode as string.
67 */ 71 */
68 @Override 72 @Override
69 public String toString() { 73 public String toString() {
70 return "Name: " + this.name + " ; Description: " + this.description 74 return "Name: " + this.name + " ; Description: " + this.description
71 + " ; Mime-Type: " + this.mimeType; 75 + " ; Mime-Type: " + this.mimeType;
72 } 76 }
73 77
74 /** 78 /**
75 * @see de.intevation.gnv.state.OutputMode#getInputParameters() 79 * @return the input parameters.
76 */ 80 */
77 public Collection<InputValue> getInputParameters() { 81 public Collection<InputValue> getInputParameters() {
78 return this.inputParameters; 82 return this.inputParameters;
79 } 83 }
80 84
85 /**
86 *
87 * @return the export modes.
88 */
81 public List<ExportMode> getExportModes() { 89 public List<ExportMode> getExportModes() {
82 return exportModes; 90 return exportModes;
83 } 91 }
84 92
85 } 93 }
86 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8: 94 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org