1 /*
2 =================== DO NOT EDIT THIS FILE ====================
3
4 Generated by Modello 2.4.0,
5
6 any modifications will be overwritten.
7
8 ==============================================================
9 */
10
11 package org.apache.maven.tools.plugin.extractor.model;
12
13 /**
14 *
15 * A parameter used by a mojo, and configurable from the
16 * command line or POM configuration sections.
17 *
18 *
19 * @version $Revision$ $Date$
20 */
21 @SuppressWarnings( "all" )
22 public class Parameter
23 implements java.io.Serializable
24 {
25
26 //--------------------------/
27 //- Class/Member Variables -/
28 //--------------------------/
29
30 /**
31 * The parameter name.
32 */
33 private String name;
34
35 /**
36 * An alternate name for the parameter.
37 */
38 private String alias;
39
40 /**
41 * The JavaBeans property name to use to configure the mojo
42 * with this parameter.
43 */
44 private String property;
45
46 /**
47 * Whether this parameter is required.
48 */
49 private boolean required = false;
50
51 /**
52 *
53 * Whether this parameter can be directly edited.
54 * If false, this param is either derived from another POM
55 * element, or refers to a runtime instance of the build
56 * system.
57 *
58 */
59 private boolean readonly = false;
60
61 /**
62 *
63 * The command-line reference to this parameter.
64 *
65 */
66 private String expression;
67
68 /**
69 *
70 * An expression in the form ${instance.property}
71 * for extracting a value for this parameter, especially from
72 * a runtime instance within the build system. (eg.
73 * ${project.build.directory} references
74 * project.getBuild().getDirectory())
75 * .
76 */
77 private String defaultValue;
78
79 /**
80 *
81 * The java type for this parameter.
82 *
83 */
84 private String type;
85
86 /**
87 * The description for this parameter.
88 */
89 private String description;
90
91 /**
92 * A deprecation message for this mojo parameter.
93 */
94 private String deprecation;
95
96 /**
97 * Version when the parameter was added.
98 */
99 private String since;
100
101
102 //-----------/
103 //- Methods -/
104 //-----------/
105
106 /**
107 * Get an alternate name for the parameter.
108 *
109 * @return String
110 */
111 public String getAlias()
112 {
113 return this.alias;
114 } //-- String getAlias()
115
116 /**
117 * Get an expression in the form ${instance.property} for
118 * extracting a value for this parameter, especially from
119 * a runtime instance within the build system. (eg.
120 * ${project.build.directory} references
121 * project.getBuild().getDirectory()).
122 *
123 * @return String
124 */
125 public String getDefaultValue()
126 {
127 return this.defaultValue;
128 } //-- String getDefaultValue()
129
130 /**
131 * Get a deprecation message for this mojo parameter.
132 *
133 * @return String
134 */
135 public String getDeprecation()
136 {
137 return this.deprecation;
138 } //-- String getDeprecation()
139
140 /**
141 * Get the description for this parameter.
142 *
143 * @return String
144 */
145 public String getDescription()
146 {
147 return this.description;
148 } //-- String getDescription()
149
150 /**
151 * Get the command-line reference to this parameter.
152 *
153 * @return String
154 */
155 public String getExpression()
156 {
157 return this.expression;
158 } //-- String getExpression()
159
160 /**
161 * Get the parameter name.
162 *
163 * @return String
164 */
165 public String getName()
166 {
167 return this.name;
168 } //-- String getName()
169
170 /**
171 * Get the JavaBeans property name to use to configure the mojo
172 * with this parameter.
173 *
174 * @return String
175 */
176 public String getProperty()
177 {
178 return this.property;
179 } //-- String getProperty()
180
181 /**
182 * Get version when the parameter was added.
183 *
184 * @return String
185 */
186 public String getSince()
187 {
188 return this.since;
189 } //-- String getSince()
190
191 /**
192 * Get the java type for this parameter.
193 *
194 * @return String
195 */
196 public String getType()
197 {
198 return this.type;
199 } //-- String getType()
200
201 /**
202 * Get whether this parameter can be directly edited. If false,
203 * this param is either derived from another POM element, or
204 * refers to a runtime instance of the build system.
205 *
206 * @return boolean
207 */
208 public boolean isReadonly()
209 {
210 return this.readonly;
211 } //-- boolean isReadonly()
212
213 /**
214 * Get whether this parameter is required.
215 *
216 * @return boolean
217 */
218 public boolean isRequired()
219 {
220 return this.required;
221 } //-- boolean isRequired()
222
223 /**
224 * Set an alternate name for the parameter.
225 *
226 * @param alias a alias object.
227 */
228 public void setAlias( String alias )
229 {
230 this.alias = alias;
231 } //-- void setAlias( String )
232
233 /**
234 * Set an expression in the form ${instance.property} for
235 * extracting a value for this parameter, especially from
236 * a runtime instance within the build system. (eg.
237 * ${project.build.directory} references
238 * project.getBuild().getDirectory()).
239 *
240 * @param defaultValue a defaultValue object.
241 */
242 public void setDefaultValue( String defaultValue )
243 {
244 this.defaultValue = defaultValue;
245 } //-- void setDefaultValue( String )
246
247 /**
248 * Set a deprecation message for this mojo parameter.
249 *
250 * @param deprecation a deprecation object.
251 */
252 public void setDeprecation( String deprecation )
253 {
254 this.deprecation = deprecation;
255 } //-- void setDeprecation( String )
256
257 /**
258 * Set the description for this parameter.
259 *
260 * @param description a description object.
261 */
262 public void setDescription( String description )
263 {
264 this.description = description;
265 } //-- void setDescription( String )
266
267 /**
268 * Set the command-line reference to this parameter.
269 *
270 * @param expression a expression object.
271 */
272 public void setExpression( String expression )
273 {
274 this.expression = expression;
275 } //-- void setExpression( String )
276
277 /**
278 * Set the parameter name.
279 *
280 * @param name a name object.
281 */
282 public void setName( String name )
283 {
284 this.name = name;
285 } //-- void setName( String )
286
287 /**
288 * Set the JavaBeans property name to use to configure the mojo
289 * with this parameter.
290 *
291 * @param property a property object.
292 */
293 public void setProperty( String property )
294 {
295 this.property = property;
296 } //-- void setProperty( String )
297
298 /**
299 * Set whether this parameter can be directly edited. If false,
300 * this param is either derived from another POM element, or
301 * refers to a runtime instance of the build system.
302 *
303 * @param readonly a readonly object.
304 */
305 public void setReadonly( boolean readonly )
306 {
307 this.readonly = readonly;
308 } //-- void setReadonly( boolean )
309
310 /**
311 * Set whether this parameter is required.
312 *
313 * @param required a required object.
314 */
315 public void setRequired( boolean required )
316 {
317 this.required = required;
318 } //-- void setRequired( boolean )
319
320 /**
321 * Set version when the parameter was added.
322 *
323 * @param since a since object.
324 */
325 public void setSince( String since )
326 {
327 this.since = since;
328 } //-- void setSince( String )
329
330 /**
331 * Set the java type for this parameter.
332 *
333 * @param type a type object.
334 */
335 public void setType( String type )
336 {
337 this.type = type;
338 } //-- void setType( String )
339
340 }