001// =================== DO NOT EDIT THIS FILE ====================
002// Generated by Modello 1.8.1,
003// any modifications will be overwritten.
004// ==============================================================
005
006package org.apache.maven.plugin.tools.model;
007
008/**
009 * 
010 *         A parameter used by a mojo, and configurable from the
011 * command line or POM configuration sections.
012 *       
013 * 
014 * @version $Revision: 907040 $ $Date: 2014-04-27 11:50:12 +0200 (Sun, 27 Apr 2014) $
015 */
016@SuppressWarnings( "all" )
017public class Parameter
018    implements java.io.Serializable
019{
020
021      //--------------------------/
022     //- Class/Member Variables -/
023    //--------------------------/
024
025    /**
026     * The parameter name.
027     */
028    private String name;
029
030    /**
031     * An alternate name for the parameter.
032     */
033    private String alias;
034
035    /**
036     * The JavaBeans property name to use to configure the mojo
037     * with this parameter.
038     */
039    private String property;
040
041    /**
042     * Whether this parameter is required.
043     */
044    private boolean required = false;
045
046    /**
047     * 
048     *             Whether this parameter can be directly edited.
049     * If false, this param is either derived from another POM
050     * element, or refers to a runtime instance of the build
051     * system.
052     *           
053     */
054    private boolean readonly = false;
055
056    /**
057     * 
058     *             The command-line reference to this parameter.
059     *           
060     */
061    private String expression;
062
063    /**
064     * 
065     *             An expression in the form ${instance.property}
066     * for extracting a value for this parameter, especially from
067     *             a runtime instance within the build system. (eg.
068     * ${project.build.directory} references
069     *             project.getBuild().getDirectory())
070     *           .
071     */
072    private String defaultValue;
073
074    /**
075     * 
076     *             The java type for this parameter.
077     *           
078     */
079    private String type;
080
081    /**
082     * The description for this parameter.
083     */
084    private String description;
085
086    /**
087     * A deprecation message for this mojo parameter.
088     */
089    private String deprecation;
090
091    /**
092     * Version when the parameter was added.
093     */
094    private String since;
095
096
097      //-----------/
098     //- Methods -/
099    //-----------/
100
101    /**
102     * Get an alternate name for the parameter.
103     * 
104     * @return String
105     */
106    public String getAlias()
107    {
108        return this.alias;
109    } //-- String getAlias()
110
111    /**
112     * Get an expression in the form ${instance.property} for
113     * extracting a value for this parameter, especially from
114     *             a runtime instance within the build system. (eg.
115     * ${project.build.directory} references
116     *             project.getBuild().getDirectory()).
117     * 
118     * @return String
119     */
120    public String getDefaultValue()
121    {
122        return this.defaultValue;
123    } //-- String getDefaultValue()
124
125    /**
126     * Get a deprecation message for this mojo parameter.
127     * 
128     * @return String
129     */
130    public String getDeprecation()
131    {
132        return this.deprecation;
133    } //-- String getDeprecation()
134
135    /**
136     * Get the description for this parameter.
137     * 
138     * @return String
139     */
140    public String getDescription()
141    {
142        return this.description;
143    } //-- String getDescription()
144
145    /**
146     * Get the command-line reference to this parameter.
147     * 
148     * @return String
149     */
150    public String getExpression()
151    {
152        return this.expression;
153    } //-- String getExpression()
154
155    /**
156     * Get the parameter name.
157     * 
158     * @return String
159     */
160    public String getName()
161    {
162        return this.name;
163    } //-- String getName()
164
165    /**
166     * Get the JavaBeans property name to use to configure the mojo
167     * with this parameter.
168     * 
169     * @return String
170     */
171    public String getProperty()
172    {
173        return this.property;
174    } //-- String getProperty()
175
176    /**
177     * Get version when the parameter was added.
178     * 
179     * @return String
180     */
181    public String getSince()
182    {
183        return this.since;
184    } //-- String getSince()
185
186    /**
187     * Get the java type for this parameter.
188     * 
189     * @return String
190     */
191    public String getType()
192    {
193        return this.type;
194    } //-- String getType()
195
196    /**
197     * Get whether this parameter can be directly edited. If false,
198     * this param is either derived from another POM element, or
199     * refers to a runtime instance of the build system.
200     * 
201     * @return boolean
202     */
203    public boolean isReadonly()
204    {
205        return this.readonly;
206    } //-- boolean isReadonly()
207
208    /**
209     * Get whether this parameter is required.
210     * 
211     * @return boolean
212     */
213    public boolean isRequired()
214    {
215        return this.required;
216    } //-- boolean isRequired()
217
218    /**
219     * Set an alternate name for the parameter.
220     * 
221     * @param alias
222     */
223    public void setAlias( String alias )
224    {
225        this.alias = alias;
226    } //-- void setAlias( String )
227
228    /**
229     * Set an expression in the form ${instance.property} for
230     * extracting a value for this parameter, especially from
231     *             a runtime instance within the build system. (eg.
232     * ${project.build.directory} references
233     *             project.getBuild().getDirectory()).
234     * 
235     * @param defaultValue
236     */
237    public void setDefaultValue( String defaultValue )
238    {
239        this.defaultValue = defaultValue;
240    } //-- void setDefaultValue( String )
241
242    /**
243     * Set a deprecation message for this mojo parameter.
244     * 
245     * @param deprecation
246     */
247    public void setDeprecation( String deprecation )
248    {
249        this.deprecation = deprecation;
250    } //-- void setDeprecation( String )
251
252    /**
253     * Set the description for this parameter.
254     * 
255     * @param description
256     */
257    public void setDescription( String description )
258    {
259        this.description = description;
260    } //-- void setDescription( String )
261
262    /**
263     * Set the command-line reference to this parameter.
264     * 
265     * @param expression
266     */
267    public void setExpression( String expression )
268    {
269        this.expression = expression;
270    } //-- void setExpression( String )
271
272    /**
273     * Set the parameter name.
274     * 
275     * @param name
276     */
277    public void setName( String name )
278    {
279        this.name = name;
280    } //-- void setName( String )
281
282    /**
283     * Set the JavaBeans property name to use to configure the mojo
284     * with this parameter.
285     * 
286     * @param property
287     */
288    public void setProperty( String property )
289    {
290        this.property = property;
291    } //-- void setProperty( String )
292
293    /**
294     * Set whether this parameter can be directly edited. If false,
295     * this param is either derived from another POM element, or
296     * refers to a runtime instance of the build system.
297     * 
298     * @param readonly
299     */
300    public void setReadonly( boolean readonly )
301    {
302        this.readonly = readonly;
303    } //-- void setReadonly( boolean )
304
305    /**
306     * Set whether this parameter is required.
307     * 
308     * @param required
309     */
310    public void setRequired( boolean required )
311    {
312        this.required = required;
313    } //-- void setRequired( boolean )
314
315    /**
316     * Set version when the parameter was added.
317     * 
318     * @param since
319     */
320    public void setSince( String since )
321    {
322        this.since = since;
323    } //-- void setSince( String )
324
325    /**
326     * Set the java type for this parameter.
327     * 
328     * @param type
329     */
330    public void setType( String type )
331    {
332        this.type = type;
333    } //-- void setType( String )
334
335}