001 /*
002 =================== DO NOT EDIT THIS FILE ====================
003 Generated by Modello 1.4.1 on 2012-06-30 12:32:39,
004 any modifications will be overwritten.
005 ==============================================================
006 */
007
008 package org.apache.maven.plugin.tools.model;
009
010 /**
011 * Mojo descriptor definition.
012 *
013 * @version $Revision$ $Date$
014 */
015 @SuppressWarnings( "all" )
016 public class Mojo
017 implements java.io.Serializable
018 {
019
020 //--------------------------/
021 //- Class/Member Variables -/
022 //--------------------------/
023
024 /**
025 * The name of the goal used to invoke this mojo.
026 */
027 private String goal;
028
029 /**
030 * The phase to which this mojo should be bound by default.
031 */
032 private String phase;
033
034 /**
035 * Whether this mojo operates as an aggregator when the reactor
036 * is run. That is, only runs once.
037 *
038 */
039 private boolean aggregator = false;
040
041 /**
042 * The scope of dependencies that this mojo requires to have
043 * resolved.
044 */
045 private String requiresDependencyResolution;
046
047 /**
048 * Whether this mojo requires a project instance in order to
049 * execute.
050 */
051 private boolean requiresProject = false;
052
053 /**
054 * Whether this mojo requires a reports section in the POM.
055 */
056 private boolean requiresReports = false;
057
058 /**
059 * Whether this mojo requires online mode to operate normally.
060 */
061 private boolean requiresOnline = false;
062
063 /**
064 * Whether this mojo's configuration should propagate down the
065 * POM inheritance chain by default.
066 *
067 */
068 private boolean inheritByDefault = false;
069
070 /**
071 * If true, this mojo can only be directly invoked (eg.
072 * specified directly on the command line).
073 *
074 */
075 private boolean requiresDirectInvocation = false;
076
077 /**
078 * Information about a sub-execution of the Maven lifecycle
079 * which should be processed.
080 */
081 private LifecycleExecution execution;
082
083 /**
084 * Field components.
085 */
086 private java.util.List<Component> components;
087
088 /**
089 * Field parameters.
090 */
091 private java.util.List<Parameter> parameters;
092
093 /**
094 * The description for this parameter.
095 */
096 private String description;
097
098 /**
099 * 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 getComponents().add( component );
127 } //-- void addComponent( Component )
128
129 /**
130 * Method addParameter.
131 *
132 * @param parameter
133 */
134 public void addParameter( Parameter parameter )
135 {
136 getParameters().add( parameter );
137 } //-- 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 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 if ( this.components == null )
158 {
159 this.components = new java.util.ArrayList<Component>();
160 }
161
162 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 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 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 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 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 if ( this.parameters == null )
214 {
215 this.parameters = new java.util.ArrayList<Parameter>();
216 }
217
218 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 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 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 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 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 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 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 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 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 return this.requiresReports;
315 } //-- boolean isRequiresReports()
316
317 /**
318 * Method removeComponent.
319 *
320 * @param component
321 */
322 public void removeComponent( Component component )
323 {
324 getComponents().remove( component );
325 } //-- void removeComponent( Component )
326
327 /**
328 * Method removeParameter.
329 *
330 * @param parameter
331 */
332 public void removeParameter( Parameter parameter )
333 {
334 getParameters().remove( parameter );
335 } //-- 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 this.aggregator = aggregator;
346 } //-- 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 this.call = call;
357 } //-- 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 this.components = components;
367 } //-- 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 this.deprecation = deprecation;
377 } //-- 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 this.description = description;
387 } //-- 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 this.execution = execution;
398 } //-- 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 this.goal = goal;
408 } //-- 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 this.inheritByDefault = inheritByDefault;
419 } //-- 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 this.parameters = parameters;
429 } //-- 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 this.phase = phase;
439 } //-- 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 this.requiresDependencyResolution = requiresDependencyResolution;
450 } //-- 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 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
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
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
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
499 */
500 public void setSince( String since )
501 {
502 this.since = since;
503 } //-- void setSince( String )
504
505 }