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