View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.4.1 on 2011-11-29 12:00:52,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.plugin.assembly.model;
9   
10  /**
11   * 
12   *         
13   *         Defines a Maven repository to be included in the
14   * assembly. The artifacts
15   *         available to be included in a repository are your
16   * project's dependency
17   *         artifacts. The repository created contains the needed
18   * metadata entries
19   *         and also contains both sha1 and md5 checksums. This is
20   * useful for creating
21   *         archives which will be deployed to internal
22   * repositories.
23   * 
24   *         <br/><b>NOTE:</b> Currently, only artifacts from the
25   * central repository
26   *         are allowed.
27   *         
28   *       
29   * 
30   * @version $Revision$ $Date$
31   */
32  @SuppressWarnings( "all" )
33  public class Repository
34      implements java.io.Serializable
35  {
36  
37        //--------------------------/
38       //- Class/Member Variables -/
39      //--------------------------/
40  
41      /**
42       * 
43       *             Sets the output directory relative to the root
44       *             of the root directory of the assembly. For
45       * example,
46       *             "log" will put the specified files in the log
47       * directory,
48       *             directly beneath the root of the archive.
49       *           
50       */
51      private String outputDirectory;
52  
53      /**
54       * Field includes.
55       */
56      private java.util.List<String> includes;
57  
58      /**
59       * Field excludes.
60       */
61      private java.util.List<String> excludes;
62  
63      /**
64       * 
65       *             
66       *             Similar to a UNIX permission, sets the file mode
67       * of the files included.
68       *             THIS IS AN OCTAL VALUE.
69       *             Format: (User)(Group)(Other) where each
70       * component is a sum of Read = 4,
71       *             Write = 2, and Execute = 1.  For example, the
72       * value 0644
73       *             translates to User read-write, Group and Other
74       * read-only.
75       *             <a
76       * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
77       * on unix-style permissions)</a>
78       *           	
79       *           
80       */
81      private String fileMode;
82  
83      /**
84       * 
85       *             
86       *             Similar to a UNIX permission, sets the directory
87       * mode of the directories
88       *             included. 
89       *             THIS IS AN OCTAL VALUE.
90       *             Format: (User)(Group)(Other) where each
91       * component is a sum of
92       *             Read = 4, Write = 2, and Execute = 1.  For
93       * example, the value
94       *             0755 translates to User read-write, Group and
95       * Other read-only.
96       *             <a
97       * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
98       * on unix-style permissions)</a>
99       *           	
100      *           
101      */
102     private String directoryMode;
103 
104     /**
105      * 
106      *             If set to true, this property will trigger the
107      * creation of repository
108      *             metadata which will allow the repository to be
109      * used as a functional remote
110      *             repository. Default value is false.
111      *           
112      */
113     private boolean includeMetadata = false;
114 
115     /**
116      * Field groupVersionAlignments.
117      */
118     private java.util.List<GroupVersionAlignment> groupVersionAlignments;
119 
120     /**
121      * 
122      *             Specifies the scope for artifacts included in
123      * this repository.
124      *             Default scope value is "runtime". (Since 2.2)
125      *           .
126      */
127     private String scope = "runtime";
128 
129 
130       //-----------/
131      //- Methods -/
132     //-----------/
133 
134     /**
135      * Method addExclude.
136      * 
137      * @param string
138      */
139     public void addExclude( String string )
140     {
141         getExcludes().add( string );
142     } //-- void addExclude( String )
143 
144     /**
145      * Method addGroupVersionAlignment.
146      * 
147      * @param groupVersionAlignment
148      */
149     public void addGroupVersionAlignment( GroupVersionAlignment groupVersionAlignment )
150     {
151         getGroupVersionAlignments().add( groupVersionAlignment );
152     } //-- void addGroupVersionAlignment( GroupVersionAlignment )
153 
154     /**
155      * Method addInclude.
156      * 
157      * @param string
158      */
159     public void addInclude( String string )
160     {
161         getIncludes().add( string );
162     } //-- void addInclude( String )
163 
164     /**
165      * Get similar to a UNIX permission, sets the directory mode of
166      * the directories
167      *             included. 
168      *             THIS IS AN OCTAL VALUE.
169      *             Format: (User)(Group)(Other) where each
170      * component is a sum of
171      *             Read = 4, Write = 2, and Execute = 1.  For
172      * example, the value
173      *             0755 translates to User read-write, Group and
174      * Other read-only.
175      *             <a
176      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
177      * on unix-style permissions)</a>
178      * 
179      * @return String
180      */
181     public String getDirectoryMode()
182     {
183         return this.directoryMode;
184     } //-- String getDirectoryMode()
185 
186     /**
187      * Method getExcludes.
188      * 
189      * @return List
190      */
191     public java.util.List<String> getExcludes()
192     {
193         if ( this.excludes == null )
194         {
195             this.excludes = new java.util.ArrayList<String>();
196         }
197 
198         return this.excludes;
199     } //-- java.util.List<String> getExcludes()
200 
201     /**
202      * Get similar to a UNIX permission, sets the file mode of the
203      * files included.
204      *             THIS IS AN OCTAL VALUE.
205      *             Format: (User)(Group)(Other) where each
206      * component is a sum of Read = 4,
207      *             Write = 2, and Execute = 1.  For example, the
208      * value 0644
209      *             translates to User read-write, Group and Other
210      * read-only.
211      *             <a
212      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
213      * on unix-style permissions)</a>
214      * 
215      * @return String
216      */
217     public String getFileMode()
218     {
219         return this.fileMode;
220     } //-- String getFileMode()
221 
222     /**
223      * Method getGroupVersionAlignments.
224      * 
225      * @return List
226      */
227     public java.util.List<GroupVersionAlignment> getGroupVersionAlignments()
228     {
229         if ( this.groupVersionAlignments == null )
230         {
231             this.groupVersionAlignments = new java.util.ArrayList<GroupVersionAlignment>();
232         }
233 
234         return this.groupVersionAlignments;
235     } //-- java.util.List<GroupVersionAlignment> getGroupVersionAlignments()
236 
237     /**
238      * Method getIncludes.
239      * 
240      * @return List
241      */
242     public java.util.List<String> getIncludes()
243     {
244         if ( this.includes == null )
245         {
246             this.includes = new java.util.ArrayList<String>();
247         }
248 
249         return this.includes;
250     } //-- java.util.List<String> getIncludes()
251 
252     /**
253      * Get sets the output directory relative to the root
254      *             of the root directory of the assembly. For
255      * example,
256      *             "log" will put the specified files in the log
257      * directory,
258      *             directly beneath the root of the archive.
259      * 
260      * @return String
261      */
262     public String getOutputDirectory()
263     {
264         return this.outputDirectory;
265     } //-- String getOutputDirectory()
266 
267     /**
268      * Get specifies the scope for artifacts included in this
269      * repository.
270      *             Default scope value is "runtime". (Since 2.2).
271      * 
272      * @return String
273      */
274     public String getScope()
275     {
276         return this.scope;
277     } //-- String getScope()
278 
279     /**
280      * Get if set to true, this property will trigger the creation
281      * of repository
282      *             metadata which will allow the repository to be
283      * used as a functional remote
284      *             repository. Default value is false.
285      * 
286      * @return boolean
287      */
288     public boolean isIncludeMetadata()
289     {
290         return this.includeMetadata;
291     } //-- boolean isIncludeMetadata()
292 
293     /**
294      * Method removeExclude.
295      * 
296      * @param string
297      */
298     public void removeExclude( String string )
299     {
300         getExcludes().remove( string );
301     } //-- void removeExclude( String )
302 
303     /**
304      * Method removeGroupVersionAlignment.
305      * 
306      * @param groupVersionAlignment
307      */
308     public void removeGroupVersionAlignment( GroupVersionAlignment groupVersionAlignment )
309     {
310         getGroupVersionAlignments().remove( groupVersionAlignment );
311     } //-- void removeGroupVersionAlignment( GroupVersionAlignment )
312 
313     /**
314      * Method removeInclude.
315      * 
316      * @param string
317      */
318     public void removeInclude( String string )
319     {
320         getIncludes().remove( string );
321     } //-- void removeInclude( String )
322 
323     /**
324      * Set similar to a UNIX permission, sets the directory mode of
325      * the directories
326      *             included. 
327      *             THIS IS AN OCTAL VALUE.
328      *             Format: (User)(Group)(Other) where each
329      * component is a sum of
330      *             Read = 4, Write = 2, and Execute = 1.  For
331      * example, the value
332      *             0755 translates to User read-write, Group and
333      * Other read-only.
334      *             <a
335      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
336      * on unix-style permissions)</a>
337      * 
338      * @param directoryMode
339      */
340     public void setDirectoryMode( String directoryMode )
341     {
342         this.directoryMode = directoryMode;
343     } //-- void setDirectoryMode( String )
344 
345     /**
346      * Set when &lt;exclude&gt; subelements are present, they
347      * define a set of
348      *             dependency artifact coordinates to exclude. If
349      * none is present, then
350      *             &lt;excludes&gt; represents no exclusions.
351      * 
352      *             Artifact coordinatess may be given in simple
353      * groupId:artifactId form,
354      *             or they may be fully qualified in the form
355      * groupId:artifactId:type:version[:classifier].
356      *             Additionally, wildcards can be used, as in
357      * *:maven-*.
358      * 
359      * @param excludes
360      */
361     public void setExcludes( java.util.List<String> excludes )
362     {
363         this.excludes = excludes;
364     } //-- void setExcludes( java.util.List )
365 
366     /**
367      * Set similar to a UNIX permission, sets the file mode of the
368      * files included.
369      *             THIS IS AN OCTAL VALUE.
370      *             Format: (User)(Group)(Other) where each
371      * component is a sum of Read = 4,
372      *             Write = 2, and Execute = 1.  For example, the
373      * value 0644
374      *             translates to User read-write, Group and Other
375      * read-only.
376      *             <a
377      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
378      * on unix-style permissions)</a>
379      * 
380      * @param fileMode
381      */
382     public void setFileMode( String fileMode )
383     {
384         this.fileMode = fileMode;
385     } //-- void setFileMode( String )
386 
387     /**
388      * Set specifies that you want to align a group of artifacts to
389      * a specified
390      *             version. A groupVersionAlignment is specified by
391      * providing one or
392      *             more of &lt;groupVersionAlignment&gt;
393      * subelements.
394      * 
395      * @param groupVersionAlignments
396      */
397     public void setGroupVersionAlignments( java.util.List<GroupVersionAlignment> groupVersionAlignments )
398     {
399         this.groupVersionAlignments = groupVersionAlignments;
400     } //-- void setGroupVersionAlignments( java.util.List )
401 
402     /**
403      * Set if set to true, this property will trigger the creation
404      * of repository
405      *             metadata which will allow the repository to be
406      * used as a functional remote
407      *             repository. Default value is false.
408      * 
409      * @param includeMetadata
410      */
411     public void setIncludeMetadata( boolean includeMetadata )
412     {
413         this.includeMetadata = includeMetadata;
414     } //-- void setIncludeMetadata( boolean )
415 
416     /**
417      * Set when &lt;include&gt; subelements are present, they
418      * define a set of
419      *             artifact coordinates to include. If none is
420      * present, then
421      *             &lt;includes&gt; represents all valid values.
422      * 
423      *             Artifact coordinatess may be given in simple
424      * groupId:artifactId form,
425      *             or they may be fully qualified in the form
426      * groupId:artifactId:type:version[:classifier].
427      *             Additionally, wildcards can be used, as in
428      * *:maven-*.
429      * 
430      * @param includes
431      */
432     public void setIncludes( java.util.List<String> includes )
433     {
434         this.includes = includes;
435     } //-- void setIncludes( java.util.List )
436 
437     /**
438      * Set sets the output directory relative to the root
439      *             of the root directory of the assembly. For
440      * example,
441      *             "log" will put the specified files in the log
442      * directory,
443      *             directly beneath the root of the archive.
444      * 
445      * @param outputDirectory
446      */
447     public void setOutputDirectory( String outputDirectory )
448     {
449         this.outputDirectory = outputDirectory;
450     } //-- void setOutputDirectory( String )
451 
452     /**
453      * Set specifies the scope for artifacts included in this
454      * repository.
455      *             Default scope value is "runtime". (Since 2.2).
456      * 
457      * @param scope
458      */
459     public void setScope( String scope )
460     {
461         this.scope = scope;
462     } //-- void setScope( String )
463 
464 }