view gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultOutputMode.java @ 949:11d8cc2deb92 1.0

merged doc/1.0
author Thomas Arendsen Hein <thomas@intevation.de>
date Fri, 28 Sep 2012 12:13:58 +0200
parents feae2f9d6c6f
children f953c9a559d8
line wrap: on
line source
package de.intevation.gnv.state;

import java.util.Collection;
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>
 */
public class DefaultOutputMode implements OutputMode {

    /**
     * The UID of this Class.
     */
    private static final long serialVersionUID = -6459085460904827056L;
    private String name = null;
    private String description = null;
    private String mimeType = null;
    private Collection<InputValue> inputParameters = null;
    private List<ExportMode> exportModes;

    /**
     * Constructor
     *
     * @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,
        String description,
        String mimeType,
        Collection<InputValue> inputParameters,
        List<ExportMode> exportModes)
    {
        super();
        this.name            = name;
        this.description     = description;
        this.mimeType        = mimeType;
        this.inputParameters = inputParameters;
        this.exportModes     = exportModes;
    }

    /**
     * @return the description.
     */
    public String getDescription() {
        return this.description;
    }

    /**
     * @return the mime type.
     */
    public String getMimeType() {
        return this.mimeType;
    }

    /**
     * @return the name.
     */
    public String getName() {
        return this.name;
    }

    /**
     * @return this output mode as string.
     */
    @Override
    public String toString() {
        return "Name: " + this.name + " ; Description: " + this.description
               + " ; Mime-Type: " + this.mimeType;
    }

    /**
     * @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 :

http://dive4elements.wald.intevation.org