View Javadoc

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