View Javadoc

1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 1.8.1,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.plugin.descriptor.model;
7   
8   /**
9    * Root element of the <code>plugin.xml</code> file.
10   * 
11   * @version $Revision: 877610 $ $Date: 2013-09-07 17:25:53 +0200 (Sat, 07 Sep 2013) $
12   */
13  @SuppressWarnings( "all" )
14  public class PluginDescriptor
15      implements java.io.Serializable
16  {
17  
18        //--------------------------/
19       //- Class/Member Variables -/
20      //--------------------------/
21  
22      /**
23       * Description of the plugin.
24       */
25      private String description;
26  
27      /**
28       * The group id of the plugin.
29       */
30      private String groupId;
31  
32      /**
33       * The artifact id of the plugin.
34       */
35      private String artifactId;
36  
37      /**
38       * The version of the plugin.
39       */
40      private String version;
41  
42      /**
43       * Field goalPrefix.
44       */
45      private String goalPrefix;
46  
47      /**
48       * Field isolatedRealm.
49       */
50      private boolean isolatedRealm = false;
51  
52      /**
53       * Field inheritedByDefault.
54       */
55      private boolean inheritedByDefault = true;
56  
57      /**
58       * Field mojos.
59       */
60      private java.util.List<MojoDescriptor> mojos;
61  
62      /**
63       * Field dependencies.
64       */
65      private java.util.List<Dependency> dependencies;
66  
67      /**
68       * Field modelEncoding.
69       */
70      private String modelEncoding = "UTF-8";
71  
72  
73        //-----------/
74       //- Methods -/
75      //-----------/
76  
77      /**
78       * Method addDependency.
79       * 
80       * @param dependency
81       */
82      public void addDependency( Dependency dependency )
83      {
84          getDependencies().add( dependency );
85      } //-- void addDependency( Dependency )
86  
87      /**
88       * Method addMojo.
89       * 
90       * @param mojoDescriptor
91       */
92      public void addMojo( MojoDescriptor mojoDescriptor )
93      {
94          getMojos().add( mojoDescriptor );
95      } //-- void addMojo( MojoDescriptor )
96  
97      /**
98       * Get the artifact id of the plugin.
99       * 
100      * @return String
101      */
102     public String getArtifactId()
103     {
104         return this.artifactId;
105     } //-- String getArtifactId()
106 
107     /**
108      * Method getDependencies.
109      * 
110      * @return List
111      */
112     public java.util.List<Dependency> getDependencies()
113     {
114         if ( this.dependencies == null )
115         {
116             this.dependencies = new java.util.ArrayList<Dependency>();
117         }
118 
119         return this.dependencies;
120     } //-- java.util.List<Dependency> getDependencies()
121 
122     /**
123      * Get description of the plugin.
124      * 
125      * @return String
126      */
127     public String getDescription()
128     {
129         return this.description;
130     } //-- String getDescription()
131 
132     /**
133      * Get the goalPrefix field.
134      * 
135      * @return String
136      */
137     public String getGoalPrefix()
138     {
139         return this.goalPrefix;
140     } //-- String getGoalPrefix()
141 
142     /**
143      * Get the group id of the plugin.
144      * 
145      * @return String
146      */
147     public String getGroupId()
148     {
149         return this.groupId;
150     } //-- String getGroupId()
151 
152     /**
153      * Get the modelEncoding field.
154      * 
155      * @return String
156      */
157     public String getModelEncoding()
158     {
159         return this.modelEncoding;
160     } //-- String getModelEncoding()
161 
162     /**
163      * Method getMojos.
164      * 
165      * @return List
166      */
167     public java.util.List<MojoDescriptor> getMojos()
168     {
169         if ( this.mojos == null )
170         {
171             this.mojos = new java.util.ArrayList<MojoDescriptor>();
172         }
173 
174         return this.mojos;
175     } //-- java.util.List<MojoDescriptor> getMojos()
176 
177     /**
178      * Get the version of the plugin.
179      * 
180      * @return String
181      */
182     public String getVersion()
183     {
184         return this.version;
185     } //-- String getVersion()
186 
187     /**
188      * Get the inheritedByDefault field.
189      * 
190      * @return boolean
191      */
192     public boolean isInheritedByDefault()
193     {
194         return this.inheritedByDefault;
195     } //-- boolean isInheritedByDefault()
196 
197     /**
198      * Get the isolatedRealm field.
199      * 
200      * @return boolean
201      */
202     public boolean isIsolatedRealm()
203     {
204         return this.isolatedRealm;
205     } //-- boolean isIsolatedRealm()
206 
207     /**
208      * Method removeDependency.
209      * 
210      * @param dependency
211      */
212     public void removeDependency( Dependency dependency )
213     {
214         getDependencies().remove( dependency );
215     } //-- void removeDependency( Dependency )
216 
217     /**
218      * Method removeMojo.
219      * 
220      * @param mojoDescriptor
221      */
222     public void removeMojo( MojoDescriptor mojoDescriptor )
223     {
224         getMojos().remove( mojoDescriptor );
225     } //-- void removeMojo( MojoDescriptor )
226 
227     /**
228      * Set the artifact id of the plugin.
229      * 
230      * @param artifactId
231      */
232     public void setArtifactId( String artifactId )
233     {
234         this.artifactId = artifactId;
235     } //-- void setArtifactId( String )
236 
237     /**
238      * Set a set of dependencies which the plugin requires in order
239      * to function. This enables the plugin to function
240      *             independently of its POM (or at least to declare
241      * the libraries it needs to run).
242      * 
243      * @param dependencies
244      */
245     public void setDependencies( java.util.List<Dependency> dependencies )
246     {
247         this.dependencies = dependencies;
248     } //-- void setDependencies( java.util.List )
249 
250     /**
251      * Set description of the plugin.
252      * 
253      * @param description
254      */
255     public void setDescription( String description )
256     {
257         this.description = description;
258     } //-- void setDescription( String )
259 
260     /**
261      * Set the goalPrefix field.
262      * 
263      * @param goalPrefix
264      */
265     public void setGoalPrefix( String goalPrefix )
266     {
267         this.goalPrefix = goalPrefix;
268     } //-- void setGoalPrefix( String )
269 
270     /**
271      * Set the group id of the plugin.
272      * 
273      * @param groupId
274      */
275     public void setGroupId( String groupId )
276     {
277         this.groupId = groupId;
278     } //-- void setGroupId( String )
279 
280     /**
281      * Set the inheritedByDefault field.
282      * 
283      * @param inheritedByDefault
284      */
285     public void setInheritedByDefault( boolean inheritedByDefault )
286     {
287         this.inheritedByDefault = inheritedByDefault;
288     } //-- void setInheritedByDefault( boolean )
289 
290     /**
291      * Set the isolatedRealm field.
292      * 
293      * @param isolatedRealm
294      */
295     public void setIsolatedRealm( boolean isolatedRealm )
296     {
297         this.isolatedRealm = isolatedRealm;
298     } //-- void setIsolatedRealm( boolean )
299 
300     /**
301      * Set the modelEncoding field.
302      * 
303      * @param modelEncoding
304      */
305     public void setModelEncoding( String modelEncoding )
306     {
307         this.modelEncoding = modelEncoding;
308     } //-- void setModelEncoding( String )
309 
310     /**
311      * Set description of each Mojo provided by the plugin.
312      * 
313      * @param mojos
314      */
315     public void setMojos( java.util.List<MojoDescriptor> mojos )
316     {
317         this.mojos = mojos;
318     } //-- void setMojos( java.util.List )
319 
320     /**
321      * Set the version of the plugin.
322      * 
323      * @param version
324      */
325     public void setVersion( String version )
326     {
327         this.version = version;
328     } //-- void setVersion( String )
329 
330 }