/*
 =================== DO NOT EDIT THIS FILE ====================
 
 Generated by Modello 2.4.0,
 
 any modifications will be overwritten.
 
 ==============================================================
 */

package org.apache.maven.tools.plugin.extractor.model;

/**
 * 
 *         A parameter used by a mojo, and configurable from the
 * command line or POM configuration sections.
 *       
 * 
 * @version $Revision$ $Date$
 */
@SuppressWarnings( "all" )
public class Parameter
    implements java.io.Serializable
{

      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * The parameter name.
     */
    private String name;

    /**
     * An alternate name for the parameter.
     */
    private String alias;

    /**
     * The JavaBeans property name to use to configure the mojo
     * with this parameter.
     */
    private String property;

    /**
     * Whether this parameter is required.
     */
    private boolean required = false;

    /**
     * 
     *             Whether this parameter can be directly edited.
     * If false, this param is either derived from another POM
     * element, or refers to a runtime instance of the build
     * system.
     *           
     */
    private boolean readonly = false;

    /**
     * 
     *             The command-line reference to this parameter.
     *           
     */
    private String expression;

    /**
     * 
     *             An expression in the form ${instance.property}
     * for extracting a value for this parameter, especially from
     *             a runtime instance within the build system. (eg.
     * ${project.build.directory} references
     *             project.getBuild().getDirectory())
     *           .
     */
    private String defaultValue;

    /**
     * 
     *             The java type for this parameter.
     *           
     */
    private String type;

    /**
     * The description for this parameter.
     */
    private String description;

    /**
     * A deprecation message for this mojo parameter.
     */
    private String deprecation;

    /**
     * Version when the parameter was added.
     */
    private String since;


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Get an alternate name for the parameter.
     * 
     * @return String
     */
    public String getAlias()
    {
        return this.alias;
    } //-- String getAlias()

    /**
     * Get an expression in the form ${instance.property} for
     * extracting a value for this parameter, especially from
     *             a runtime instance within the build system. (eg.
     * ${project.build.directory} references
     *             project.getBuild().getDirectory()).
     * 
     * @return String
     */
    public String getDefaultValue()
    {
        return this.defaultValue;
    } //-- String getDefaultValue()

    /**
     * Get a deprecation message for this mojo parameter.
     * 
     * @return String
     */
    public String getDeprecation()
    {
        return this.deprecation;
    } //-- String getDeprecation()

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

    /**
     * Get the command-line reference to this parameter.
     * 
     * @return String
     */
    public String getExpression()
    {
        return this.expression;
    } //-- String getExpression()

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

    /**
     * Get the JavaBeans property name to use to configure the mojo
     * with this parameter.
     * 
     * @return String
     */
    public String getProperty()
    {
        return this.property;
    } //-- String getProperty()

    /**
     * Get version when the parameter was added.
     * 
     * @return String
     */
    public String getSince()
    {
        return this.since;
    } //-- String getSince()

    /**
     * Get the java type for this parameter.
     * 
     * @return String
     */
    public String getType()
    {
        return this.type;
    } //-- String getType()

    /**
     * Get whether this parameter can be directly edited. If false,
     * this param is either derived from another POM element, or
     * refers to a runtime instance of the build system.
     * 
     * @return boolean
     */
    public boolean isReadonly()
    {
        return this.readonly;
    } //-- boolean isReadonly()

    /**
     * Get whether this parameter is required.
     * 
     * @return boolean
     */
    public boolean isRequired()
    {
        return this.required;
    } //-- boolean isRequired()

    /**
     * Set an alternate name for the parameter.
     * 
     * @param alias a alias object.
     */
    public void setAlias( String alias )
    {
        this.alias = alias;
    } //-- void setAlias( String )

    /**
     * Set an expression in the form ${instance.property} for
     * extracting a value for this parameter, especially from
     *             a runtime instance within the build system. (eg.
     * ${project.build.directory} references
     *             project.getBuild().getDirectory()).
     * 
     * @param defaultValue a defaultValue object.
     */
    public void setDefaultValue( String defaultValue )
    {
        this.defaultValue = defaultValue;
    } //-- void setDefaultValue( String )

    /**
     * Set a deprecation message for this mojo parameter.
     * 
     * @param deprecation a deprecation object.
     */
    public void setDeprecation( String deprecation )
    {
        this.deprecation = deprecation;
    } //-- void setDeprecation( String )

    /**
     * Set the description for this parameter.
     * 
     * @param description a description object.
     */
    public void setDescription( String description )
    {
        this.description = description;
    } //-- void setDescription( String )

    /**
     * Set the command-line reference to this parameter.
     * 
     * @param expression a expression object.
     */
    public void setExpression( String expression )
    {
        this.expression = expression;
    } //-- void setExpression( String )

    /**
     * Set the parameter name.
     * 
     * @param name a name object.
     */
    public void setName( String name )
    {
        this.name = name;
    } //-- void setName( String )

    /**
     * Set the JavaBeans property name to use to configure the mojo
     * with this parameter.
     * 
     * @param property a property object.
     */
    public void setProperty( String property )
    {
        this.property = property;
    } //-- void setProperty( String )

    /**
     * Set whether this parameter can be directly edited. If false,
     * this param is either derived from another POM element, or
     * refers to a runtime instance of the build system.
     * 
     * @param readonly a readonly object.
     */
    public void setReadonly( boolean readonly )
    {
        this.readonly = readonly;
    } //-- void setReadonly( boolean )

    /**
     * Set whether this parameter is required.
     * 
     * @param required a required object.
     */
    public void setRequired( boolean required )
    {
        this.required = required;
    } //-- void setRequired( boolean )

    /**
     * Set version when the parameter was added.
     * 
     * @param since a since object.
     */
    public void setSince( String since )
    {
        this.since = since;
    } //-- void setSince( String )

    /**
     * Set the java type for this parameter.
     * 
     * @param type a type object.
     */
    public void setType( String type )
    {
        this.type = type;
    } //-- void setType( String )

}