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