org.codehaus.mojo.webstart.JnlpFile Maven / Gradle / Ivy

Go to download
package org.codehaus.mojo.webstart;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.List;
import java.util.Map;

/**
 * This class represents a <jnlpFile> configuration element from the
 * pom.xml file. It contains the configuration elements that are specific
 * to a single JNLP that will be generated by the webstart plugin.
 *
 * @author Kevin Stembridge
 * @version $Revision$
 * @since 1.0-alpha-2
 */
public class JnlpFile
{

    private String inputTemplateResourcePath;

    private String templateFilename;

    private String inputTemplate;

    private String outputFilename;

    private List jarResources;

    private List arguments;

    private String mainClass;

    private Map properties;

    /**
     * Creates a new uninitialized {@code JnlpFile}.
     */
    public JnlpFile()
    {
        // do nothing
    }

    public String getTemplateFilename()
    {
        return templateFilename;
    }

    public void setInputTemplateResourcePath( String inputTemplateResourcePath )
    {
        this.inputTemplateResourcePath = inputTemplateResourcePath;
    }

    public String getInputTemplateResourcePath()
    {
        return inputTemplateResourcePath;
    }

    public void setInputTemplate( String inputTemplate )
    {
        this.inputTemplate = inputTemplate;
    }

    /**
     * Returns the name of the Velocity template file used to generate the
     * JNLP file.
     *
     * @return the name of the JNLP template file.
     */
    public String getInputTemplate()
    {
        return inputTemplate;
    }

    /**
     * Returns the name to be used for the generated JNLP file.
     *
     * @return the value of the outputFilename field.
     */
    protected String getOutputFilename()
    {
        return this.outputFilename;
    }

    /**
     * Returns the collection of JarResource elements for this JNLP file.
     *
     * @return the value of the jarResources field.
     */
    protected List getJarResources()
    {
        return this.jarResources;
    }

    /**
     * Returns the fully qualified classname of the class to be specified as
     * the main-class in the generated JNLP file.
     *
     * @return the value of the mainClass field.
     */
    protected String getMainClass()
    {
        return this.mainClass;
    }

    /**
     * Returns the extrat properties we can inject in the generated JNLP file.
     *
     * @return the value of the properties field.
     */
    protected Map getProperties()
    {
        return this.properties;
    }

    /**
     * Sets the collection of JarResource elements for this JNLP file.
     *
     * @param jarResources the new value for field {@link #jarResources}
     */
    protected void setJarResources( List jarResources )
    {
        this.jarResources = jarResources;
    }

    /**
     * Sets the outputFileName.
     *
     * @param outputFilename the new value for field {@link #outputFilename}
     */
    protected void setOutputFilename( String outputFilename )
    {
        this.outputFilename = outputFilename;
    }

    /**
     * Sets the fully qualified classname of the class to be specified as
     * the main-class in the generated JNLP file.
     *
     * @param mainClass the new value for field {@link #mainClass}
     */
    protected void setMainClass( String mainClass )
    {
        this.mainClass = mainClass;
    }

    /**
     * Sets the extra properties we can inject in the generated JNLP file.
     *
     * @param properties the new value for field {@link #properties}
     */

    public void setProperties( Map properties )
    {
        this.properties = properties;
    }

    public List getArguments()
    {
        return arguments;
    }

    public void setArguments(List arguments)
    {
        this.arguments = arguments;
    }

}