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