View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 1.8.1,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.plugin.tools.model;
7   
8   /**
9    * 
10   *         A parameter used by a mojo, and configurable from the
11   * command line or POM configuration sections.
12   *       
13   * 
14   * @version $Revision: 907040 $ $Date: 2014-04-27 09:50:12 +0000 (Sun, 27 Apr 2014) $
15   */
16  @SuppressWarnings( "all" )
17  public class Parameter
18      implements java.io.Serializable
19  {
20  
21        //--------------------------/
22       //- Class/Member Variables -/
23      //--------------------------/
24  
25      /**
26       * The parameter name.
27       */
28      private String name;
29  
30      /**
31       * An alternate name for the parameter.
32       */
33      private String alias;
34  
35      /**
36       * The JavaBeans property name to use to configure the mojo
37       * with this parameter.
38       */
39      private String property;
40  
41      /**
42       * Whether this parameter is required.
43       */
44      private boolean required = false;
45  
46      /**
47       * 
48       *             Whether this parameter can be directly edited.
49       * If false, this param is either derived from another POM
50       * element, or refers to a runtime instance of the build
51       * system.
52       *           
53       */
54      private boolean readonly = false;
55  
56      /**
57       * 
58       *             The command-line reference to this parameter.
59       *           
60       */
61      private String expression;
62  
63      /**
64       * 
65       *             An expression in the form ${instance.property}
66       * for extracting a value for this parameter, especially from
67       *             a runtime instance within the build system. (eg.
68       * ${project.build.directory} references
69       *             project.getBuild().getDirectory())
70       *           .
71       */
72      private String defaultValue;
73  
74      /**
75       * 
76       *             The java type for this parameter.
77       *           
78       */
79      private String type;
80  
81      /**
82       * The description for this parameter.
83       */
84      private String description;
85  
86      /**
87       * A deprecation message for this mojo parameter.
88       */
89      private String deprecation;
90  
91      /**
92       * Version when the parameter was added.
93       */
94      private String since;
95  
96  
97        //-----------/
98       //- Methods -/
99      //-----------/
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 }