1 // =================== DO NOT EDIT THIS FILE ====================
2 // Generated by Modello 2.1.2,
3 // any modifications will be overwritten.
4 // ==============================================================
5
6 package org.apache.maven.tools.plugin.extractor.model;
7
8 /**
9 * Mojo descriptor definition.
10 *
11 * @version $Revision$ $Date$
12 */
13 @SuppressWarnings( "all" )
14 public class Mojo
15 implements java.io.Serializable
16 {
17
18 //--------------------------/
19 //- Class/Member Variables -/
20 //--------------------------/
21
22 /**
23 * The name of the goal used to invoke this mojo.
24 */
25 private String goal;
26
27 /**
28 * The phase to which this mojo should be bound by default.
29 */
30 private String phase;
31
32 /**
33 * Whether this mojo operates as an aggregator when the reactor
34 * is run. That is, only runs once.
35 *
36 */
37 private boolean aggregator = false;
38
39 /**
40 * The scope of dependencies that this mojo requires to have
41 * resolved.
42 */
43 private String requiresDependencyResolution;
44
45 /**
46 * Whether this mojo requires a project instance in order to
47 * execute.
48 */
49 private boolean requiresProject = false;
50
51 /**
52 * Whether this mojo requires a reports section in the POM.
53 */
54 private boolean requiresReports = false;
55
56 /**
57 * Whether this mojo requires online mode to operate normally.
58 */
59 private boolean requiresOnline = false;
60
61 /**
62 * Whether this mojo's configuration should propagate down the
63 * POM inheritance chain by default.
64 *
65 */
66 private boolean inheritByDefault = false;
67
68 /**
69 * If true, this mojo can only be directly invoked (eg.
70 * specified directly on the command line).
71 *
72 */
73 private boolean requiresDirectInvocation = false;
74
75 /**
76 * Information about a sub-execution of the Maven lifecycle
77 * which should be processed.
78 */
79 private LifecycleExecution execution;
80
81 /**
82 * Field components.
83 */
84 private java.util.List<Component> components;
85
86 /**
87 * Field parameters.
88 */
89 private java.util.List<Parameter> parameters;
90
91 /**
92 * The description for this parameter.
93 */
94 private String description;
95
96 /**
97 * A deprecation message for this mojo parameter.
98 */
99 private String deprecation;
100
101 /**
102 * Version when the mojo was added to the API.
103 */
104 private String since;
105
106 /**
107 * The target/method within the script to call when this mojo
108 * executes.
109 */
110 private String call;
111
112
113 //-----------/
114 //- Methods -/
115 //-----------/
116
117 /**
118 * Method addComponent.
119 *
120 * @param component a component object.
121 */
122 public void addComponent( Component component )
123 {
124 getComponents().add( component );
125 } //-- void addComponent( Component )
126
127 /**
128 * Method addParameter.
129 *
130 * @param parameter a parameter object.
131 */
132 public void addParameter( Parameter parameter )
133 {
134 getParameters().add( parameter );
135 } //-- void addParameter( Parameter )
136
137 /**
138 * Get the target/method within the script to call when this
139 * mojo executes.
140 *
141 * @return String
142 */
143 public String getCall()
144 {
145 return this.call;
146 } //-- String getCall()
147
148 /**
149 * Method getComponents.
150 *
151 * @return List
152 */
153 public java.util.List<Component> getComponents()
154 {
155 if ( this.components == null )
156 {
157 this.components = new java.util.ArrayList<Component>();
158 }
159
160 return this.components;
161 } //-- java.util.List<Component> getComponents()
162
163 /**
164 * Get a deprecation message for this mojo parameter.
165 *
166 * @return String
167 */
168 public String getDeprecation()
169 {
170 return this.deprecation;
171 } //-- String getDeprecation()
172
173 /**
174 * Get the description for this parameter.
175 *
176 * @return String
177 */
178 public String getDescription()
179 {
180 return this.description;
181 } //-- String getDescription()
182
183 /**
184 * Get information about a sub-execution of the Maven lifecycle
185 * which should be processed.
186 *
187 * @return LifecycleExecution
188 */
189 public LifecycleExecution getExecution()
190 {
191 return this.execution;
192 } //-- LifecycleExecution getExecution()
193
194 /**
195 * Get the name of the goal used to invoke this mojo.
196 *
197 * @return String
198 */
199 public String getGoal()
200 {
201 return this.goal;
202 } //-- String getGoal()
203
204 /**
205 * Method getParameters.
206 *
207 * @return List
208 */
209 public java.util.List<Parameter> getParameters()
210 {
211 if ( this.parameters == null )
212 {
213 this.parameters = new java.util.ArrayList<Parameter>();
214 }
215
216 return this.parameters;
217 } //-- java.util.List<Parameter> getParameters()
218
219 /**
220 * Get the phase to which this mojo should be bound by default.
221 *
222 * @return String
223 */
224 public String getPhase()
225 {
226 return this.phase;
227 } //-- String getPhase()
228
229 /**
230 * Get the scope of dependencies that this mojo requires to
231 * have resolved.
232 *
233 * @return String
234 */
235 public String getRequiresDependencyResolution()
236 {
237 return this.requiresDependencyResolution;
238 } //-- String getRequiresDependencyResolution()
239
240 /**
241 * Get version when the mojo was added to the API.
242 *
243 * @return String
244 */
245 public String getSince()
246 {
247 return this.since;
248 } //-- String getSince()
249
250 /**
251 * Get whether this mojo operates as an aggregator when the
252 * reactor is run. That is, only runs once.
253 *
254 * @return boolean
255 */
256 public boolean isAggregator()
257 {
258 return this.aggregator;
259 } //-- boolean isAggregator()
260
261 /**
262 * Get whether this mojo's configuration should propagate down
263 * the POM inheritance chain by default.
264 *
265 * @return boolean
266 */
267 public boolean isInheritByDefault()
268 {
269 return this.inheritByDefault;
270 } //-- boolean isInheritByDefault()
271
272 /**
273 * Get if true, this mojo can only be directly invoked (eg.
274 * specified directly on the command line).
275 *
276 * @return boolean
277 */
278 public boolean isRequiresDirectInvocation()
279 {
280 return this.requiresDirectInvocation;
281 } //-- boolean isRequiresDirectInvocation()
282
283 /**
284 * Get whether this mojo requires online mode to operate
285 * normally.
286 *
287 * @return boolean
288 */
289 public boolean isRequiresOnline()
290 {
291 return this.requiresOnline;
292 } //-- boolean isRequiresOnline()
293
294 /**
295 * Get whether this mojo requires a project instance in order
296 * to execute.
297 *
298 * @return boolean
299 */
300 public boolean isRequiresProject()
301 {
302 return this.requiresProject;
303 } //-- boolean isRequiresProject()
304
305 /**
306 * Get whether this mojo requires a reports section in the POM.
307 *
308 * @return boolean
309 */
310 public boolean isRequiresReports()
311 {
312 return this.requiresReports;
313 } //-- boolean isRequiresReports()
314
315 /**
316 * Method removeComponent.
317 *
318 * @param component a component object.
319 */
320 public void removeComponent( Component component )
321 {
322 getComponents().remove( component );
323 } //-- void removeComponent( Component )
324
325 /**
326 * Method removeParameter.
327 *
328 * @param parameter a parameter object.
329 */
330 public void removeParameter( Parameter parameter )
331 {
332 getParameters().remove( parameter );
333 } //-- void removeParameter( Parameter )
334
335 /**
336 * Set whether this mojo operates as an aggregator when the
337 * reactor is run. That is, only runs once.
338 *
339 * @param aggregator a aggregator object.
340 */
341 public void setAggregator( boolean aggregator )
342 {
343 this.aggregator = aggregator;
344 } //-- void setAggregator( boolean )
345
346 /**
347 * Set the target/method within the script to call when this
348 * mojo executes.
349 *
350 * @param call a call object.
351 */
352 public void setCall( String call )
353 {
354 this.call = call;
355 } //-- void setCall( String )
356
357 /**
358 * Set list of plexus components required by this mojo.
359 *
360 * @param components a components object.
361 */
362 public void setComponents( java.util.List<Component> components )
363 {
364 this.components = components;
365 } //-- void setComponents( java.util.List )
366
367 /**
368 * Set a deprecation message for this mojo parameter.
369 *
370 * @param deprecation a deprecation object.
371 */
372 public void setDeprecation( String deprecation )
373 {
374 this.deprecation = deprecation;
375 } //-- void setDeprecation( String )
376
377 /**
378 * Set the description for this parameter.
379 *
380 * @param description a description object.
381 */
382 public void setDescription( String description )
383 {
384 this.description = description;
385 } //-- void setDescription( String )
386
387 /**
388 * Set information about a sub-execution of the Maven lifecycle
389 * which should be processed.
390 *
391 * @param execution a execution object.
392 */
393 public void setExecution( LifecycleExecution execution )
394 {
395 this.execution = execution;
396 } //-- void setExecution( LifecycleExecution )
397
398 /**
399 * Set the name of the goal used to invoke this mojo.
400 *
401 * @param goal a goal object.
402 */
403 public void setGoal( String goal )
404 {
405 this.goal = goal;
406 } //-- void setGoal( String )
407
408 /**
409 * Set whether this mojo's configuration should propagate down
410 * the POM inheritance chain by default.
411 *
412 * @param inheritByDefault a inheritByDefault object.
413 */
414 public void setInheritByDefault( boolean inheritByDefault )
415 {
416 this.inheritByDefault = inheritByDefault;
417 } //-- void setInheritByDefault( boolean )
418
419 /**
420 * Set list of parameters used by this mojo.
421 *
422 * @param parameters a parameters object.
423 */
424 public void setParameters( java.util.List<Parameter> parameters )
425 {
426 this.parameters = parameters;
427 } //-- void setParameters( java.util.List )
428
429 /**
430 * Set the phase to which this mojo should be bound by default.
431 *
432 * @param phase a phase object.
433 */
434 public void setPhase( String phase )
435 {
436 this.phase = phase;
437 } //-- void setPhase( String )
438
439 /**
440 * Set the scope of dependencies that this mojo requires to
441 * have resolved.
442 *
443 * @param requiresDependencyResolution a
444 * requiresDependencyResolution object.
445 */
446 public void setRequiresDependencyResolution( String requiresDependencyResolution )
447 {
448 this.requiresDependencyResolution = requiresDependencyResolution;
449 } //-- void setRequiresDependencyResolution( String )
450
451 /**
452 * Set if true, this mojo can only be directly invoked (eg.
453 * specified directly on the command line).
454 *
455 * @param requiresDirectInvocation a requiresDirectInvocation
456 * object.
457 */
458 public void setRequiresDirectInvocation( boolean requiresDirectInvocation )
459 {
460 this.requiresDirectInvocation = requiresDirectInvocation;
461 } //-- void setRequiresDirectInvocation( boolean )
462
463 /**
464 * Set whether this mojo requires online mode to operate
465 * normally.
466 *
467 * @param requiresOnline a requiresOnline object.
468 */
469 public void setRequiresOnline( boolean requiresOnline )
470 {
471 this.requiresOnline = requiresOnline;
472 } //-- void setRequiresOnline( boolean )
473
474 /**
475 * Set whether this mojo requires a project instance in order
476 * to execute.
477 *
478 * @param requiresProject a requiresProject object.
479 */
480 public void setRequiresProject( boolean requiresProject )
481 {
482 this.requiresProject = requiresProject;
483 } //-- void setRequiresProject( boolean )
484
485 /**
486 * Set whether this mojo requires a reports section in the POM.
487 *
488 * @param requiresReports a requiresReports object.
489 */
490 public void setRequiresReports( boolean requiresReports )
491 {
492 this.requiresReports = requiresReports;
493 } //-- void setRequiresReports( boolean )
494
495 /**
496 * Set version when the mojo was added to the API.
497 *
498 * @param since a since object.
499 */
500 public void setSince( String since )
501 {
502 this.since = since;
503 } //-- void setSince( String )
504
505 }