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