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   *         Contains configuration options for including the source
11   * files of a
12   *         project module in an assembly.
13   *       
14   * 
15   * @version $Revision$ $Date$
16   */
17  @SuppressWarnings( "all" )
18  public class ModuleSources
19      implements java.io.Serializable
20  {
21  
22        //--------------------------/
23       //- Class/Member Variables -/
24      //--------------------------/
25  
26      /**
27       * 
28       *             Whether standard exclusion patterns, such as
29       * those matching CVS and Subversion
30       *             metadata files, should be used when calculating
31       * the files affected by this set.
32       *             For backward compatibility, the default value is
33       * true. (Since 2.2)
34       *           .
35       */
36      private boolean useDefaultExcludes = true;
37  
38      /**
39       * 
40       *             Sets the output directory relative to the root
41       *             of the root directory of the assembly. For
42       * example,
43       *             "log" will put the specified files in the log
44       * directory.
45       *           
46       */
47      private String outputDirectory;
48  
49      /**
50       * Field includes.
51       */
52      private java.util.List<String> includes;
53  
54      /**
55       * Field excludes.
56       */
57      private java.util.List<String> excludes;
58  
59      /**
60       * 
61       *             
62       *             Similar to a UNIX permission, sets the file mode
63       * of the files included.
64       *             THIS IS AN OCTAL VALUE.
65       *             Format: (User)(Group)(Other) where each
66       * component is a sum of Read = 4,
67       *             Write = 2, and Execute = 1.  For example, the
68       * value 0644
69       *             translates to User read-write, Group and Other
70       * read-only. The default value is 0644.
71       *             <a
72       * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
73       * on unix-style permissions)</a>
74       *             
75       *           
76       */
77      private String fileMode;
78  
79      /**
80       * 
81       *             
82       *             Similar to a UNIX permission, sets the directory
83       * mode of the directories
84       *             included.
85       *             THIS IS AN OCTAL VALUE.
86       *             Format: (User)(Group)(Other) where each
87       * component is a sum of
88       *             Read = 4, Write = 2, and Execute = 1.  For
89       * example, the value
90       *             0755 translates to User read-write, Group and
91       * Other read-only. The default value is 0755.
92       *             <a
93       * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
94       * on unix-style permissions)</a>
95       *             
96       *           
97       */
98      private String directoryMode;
99  
100     /**
101      * Field fileSets.
102      */
103     private java.util.List<FileSet> fileSets;
104 
105     /**
106      * 
107      *             
108      *             Specifies whether the module's finalName should
109      * be prepended to the outputDirectory
110      *             values of any fileSets applied to it. Default
111      * value is true. (Since 2.2)
112      *             
113      *           .
114      */
115     private boolean includeModuleDirectory = true;
116 
117     /**
118      * 
119      *             
120      *             Specifies whether sub-module directories below
121      * the current module should be excluded
122      *             from fileSets applied to that module. This might
123      * be useful if you only mean to copy
124      *             the sources for the exact module list matched by
125      * this ModuleSet, ignoring (or processing
126      *             separately) the modules which exist in
127      * directories below the current one.
128      *             Default value is true. (Since 2.2)
129      *             
130      *           .
131      */
132     private boolean excludeSubModuleDirectories = true;
133 
134     /**
135      * 
136      *             Sets the mapping pattern for all module
137      * base-directories included in this assembly.
138      *             NOTE: This field is only used if
139      * includeModuleDirectory == true.
140      *             Default is the module's ${artifactId} in
141      * 2.2-beta-1, and ${module.artifactId} in subsequent versions.
142      * (Since 2.2)
143      *           .
144      */
145     private String outputDirectoryMapping = "${module.artifactId}";
146 
147 
148       //-----------/
149      //- Methods -/
150     //-----------/
151 
152     /**
153      * Method addExclude.
154      * 
155      * @param string
156      */
157     public void addExclude( String string )
158     {
159         getExcludes().add( string );
160     } //-- void addExclude( String )
161 
162     /**
163      * Method addFileSet.
164      * 
165      * @param fileSet
166      */
167     public void addFileSet( FileSet fileSet )
168     {
169         getFileSets().add( fileSet );
170     } //-- void addFileSet( FileSet )
171 
172     /**
173      * Method addInclude.
174      * 
175      * @param string
176      */
177     public void addInclude( String string )
178     {
179         getIncludes().add( string );
180     } //-- void addInclude( String )
181 
182     /**
183      * Get similar to a UNIX permission, sets the directory mode of
184      * the directories
185      *             included.
186      *             THIS IS AN OCTAL VALUE.
187      *             Format: (User)(Group)(Other) where each
188      * component is a sum of
189      *             Read = 4, Write = 2, and Execute = 1.  For
190      * example, the value
191      *             0755 translates to User read-write, Group and
192      * Other read-only. The default value is 0755.
193      *             <a
194      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
195      * on unix-style permissions)</a>
196      * 
197      * @return String
198      */
199     public String getDirectoryMode()
200     {
201         return this.directoryMode;
202     } //-- String getDirectoryMode()
203 
204     /**
205      * Method getExcludes.
206      * 
207      * @return List
208      */
209     public java.util.List<String> getExcludes()
210     {
211         if ( this.excludes == null )
212         {
213             this.excludes = new java.util.ArrayList<String>();
214         }
215 
216         return this.excludes;
217     } //-- java.util.List<String> getExcludes()
218 
219     /**
220      * Get similar to a UNIX permission, sets the file mode of the
221      * files included.
222      *             THIS IS AN OCTAL VALUE.
223      *             Format: (User)(Group)(Other) where each
224      * component is a sum of Read = 4,
225      *             Write = 2, and Execute = 1.  For example, the
226      * value 0644
227      *             translates to User read-write, Group and Other
228      * read-only. The default value is 0644.
229      *             <a
230      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
231      * on unix-style permissions)</a>
232      * 
233      * @return String
234      */
235     public String getFileMode()
236     {
237         return this.fileMode;
238     } //-- String getFileMode()
239 
240     /**
241      * Method getFileSets.
242      * 
243      * @return List
244      */
245     public java.util.List<FileSet> getFileSets()
246     {
247         if ( this.fileSets == null )
248         {
249             this.fileSets = new java.util.ArrayList<FileSet>();
250         }
251 
252         return this.fileSets;
253     } //-- java.util.List<FileSet> getFileSets()
254 
255     /**
256      * Method getIncludes.
257      * 
258      * @return List
259      */
260     public java.util.List<String> getIncludes()
261     {
262         if ( this.includes == null )
263         {
264             this.includes = new java.util.ArrayList<String>();
265         }
266 
267         return this.includes;
268     } //-- java.util.List<String> getIncludes()
269 
270     /**
271      * Get sets the output directory relative to the root
272      *             of the root directory of the assembly. For
273      * example,
274      *             "log" will put the specified files in the log
275      * directory.
276      * 
277      * @return String
278      */
279     public String getOutputDirectory()
280     {
281         return this.outputDirectory;
282     } //-- String getOutputDirectory()
283 
284     /**
285      * Get sets the mapping pattern for all module base-directories
286      * included in this assembly.
287      *             NOTE: This field is only used if
288      * includeModuleDirectory == true.
289      *             Default is the module's ${artifactId} in
290      * 2.2-beta-1, and ${module.artifactId} in subsequent versions.
291      * (Since 2.2).
292      * 
293      * @return String
294      */
295     public String getOutputDirectoryMapping()
296     {
297         return this.outputDirectoryMapping;
298     } //-- String getOutputDirectoryMapping()
299 
300     /**
301      * Get specifies whether sub-module directories below the
302      * current module should be excluded
303      *             from fileSets applied to that module. This might
304      * be useful if you only mean to copy
305      *             the sources for the exact module list matched by
306      * this ModuleSet, ignoring (or processing
307      *             separately) the modules which exist in
308      * directories below the current one.
309      *             Default value is true. (Since 2.2).
310      * 
311      * @return boolean
312      */
313     public boolean isExcludeSubModuleDirectories()
314     {
315         return this.excludeSubModuleDirectories;
316     } //-- boolean isExcludeSubModuleDirectories()
317 
318     /**
319      * Get specifies whether the module's finalName should be
320      * prepended to the outputDirectory
321      *             values of any fileSets applied to it. Default
322      * value is true. (Since 2.2).
323      * 
324      * @return boolean
325      */
326     public boolean isIncludeModuleDirectory()
327     {
328         return this.includeModuleDirectory;
329     } //-- boolean isIncludeModuleDirectory()
330 
331     /**
332      * Get whether standard exclusion patterns, such as those
333      * matching CVS and Subversion
334      *             metadata files, should be used when calculating
335      * the files affected by this set.
336      *             For backward compatibility, the default value is
337      * true. (Since 2.2).
338      * 
339      * @return boolean
340      */
341     public boolean isUseDefaultExcludes()
342     {
343         return this.useDefaultExcludes;
344     } //-- boolean isUseDefaultExcludes()
345 
346     /**
347      * Method removeExclude.
348      * 
349      * @param string
350      */
351     public void removeExclude( String string )
352     {
353         getExcludes().remove( string );
354     } //-- void removeExclude( String )
355 
356     /**
357      * Method removeFileSet.
358      * 
359      * @param fileSet
360      */
361     public void removeFileSet( FileSet fileSet )
362     {
363         getFileSets().remove( fileSet );
364     } //-- void removeFileSet( FileSet )
365 
366     /**
367      * Method removeInclude.
368      * 
369      * @param string
370      */
371     public void removeInclude( String string )
372     {
373         getIncludes().remove( string );
374     } //-- void removeInclude( String )
375 
376     /**
377      * Set similar to a UNIX permission, sets the directory mode of
378      * the directories
379      *             included.
380      *             THIS IS AN OCTAL VALUE.
381      *             Format: (User)(Group)(Other) where each
382      * component is a sum of
383      *             Read = 4, Write = 2, and Execute = 1.  For
384      * example, the value
385      *             0755 translates to User read-write, Group and
386      * Other read-only. The default value is 0755.
387      *             <a
388      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
389      * on unix-style permissions)</a>
390      * 
391      * @param directoryMode
392      */
393     public void setDirectoryMode( String directoryMode )
394     {
395         this.directoryMode = directoryMode;
396     } //-- void setDirectoryMode( String )
397 
398     /**
399      * Set specifies whether sub-module directories below the
400      * current module should be excluded
401      *             from fileSets applied to that module. This might
402      * be useful if you only mean to copy
403      *             the sources for the exact module list matched by
404      * this ModuleSet, ignoring (or processing
405      *             separately) the modules which exist in
406      * directories below the current one.
407      *             Default value is true. (Since 2.2).
408      * 
409      * @param excludeSubModuleDirectories
410      */
411     public void setExcludeSubModuleDirectories( boolean excludeSubModuleDirectories )
412     {
413         this.excludeSubModuleDirectories = excludeSubModuleDirectories;
414     } //-- void setExcludeSubModuleDirectories( boolean )
415 
416     /**
417      * Set when &lt;exclude&gt; subelements are present, they
418      * define a set of
419      *             files and directory to exclude. If none is
420      * present, then
421      *             &lt;excludes&gt; represents no exclusions.
422      * 
423      * @param excludes
424      */
425     public void setExcludes( java.util.List<String> excludes )
426     {
427         this.excludes = excludes;
428     } //-- void setExcludes( java.util.List )
429 
430     /**
431      * Set similar to a UNIX permission, sets the file mode of the
432      * files included.
433      *             THIS IS AN OCTAL VALUE.
434      *             Format: (User)(Group)(Other) where each
435      * component is a sum of Read = 4,
436      *             Write = 2, and Execute = 1.  For example, the
437      * value 0644
438      *             translates to User read-write, Group and Other
439      * read-only. The default value is 0644.
440      *             <a
441      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
442      * on unix-style permissions)</a>
443      * 
444      * @param fileMode
445      */
446     public void setFileMode( String fileMode )
447     {
448         this.fileMode = fileMode;
449     } //-- void setFileMode( String )
450 
451     /**
452      * Set specifies which groups of files from each included
453      * module to include in the assembly. A
454      *             fileSet is specified by providing one or more of
455      * &lt;fileSet&gt; subelements. (Since 2.2).
456      * 
457      * @param fileSets
458      */
459     public void setFileSets( java.util.List<FileSet> fileSets )
460     {
461         this.fileSets = fileSets;
462     } //-- void setFileSets( java.util.List )
463 
464     /**
465      * Set specifies whether the module's finalName should be
466      * prepended to the outputDirectory
467      *             values of any fileSets applied to it. Default
468      * value is true. (Since 2.2).
469      * 
470      * @param includeModuleDirectory
471      */
472     public void setIncludeModuleDirectory( boolean includeModuleDirectory )
473     {
474         this.includeModuleDirectory = includeModuleDirectory;
475     } //-- void setIncludeModuleDirectory( boolean )
476 
477     /**
478      * Set when &lt;include&gt; subelements are present, they
479      * define a set of
480      *             files and directory to include. If none is
481      * present, then
482      *             &lt;includes&gt; represents all valid values.
483      * 
484      * @param includes
485      */
486     public void setIncludes( java.util.List<String> includes )
487     {
488         this.includes = includes;
489     } //-- void setIncludes( java.util.List )
490 
491     /**
492      * Set sets the output directory relative to the root
493      *             of the root directory of the assembly. For
494      * example,
495      *             "log" will put the specified files in the log
496      * directory.
497      * 
498      * @param outputDirectory
499      */
500     public void setOutputDirectory( String outputDirectory )
501     {
502         this.outputDirectory = outputDirectory;
503     } //-- void setOutputDirectory( String )
504 
505     /**
506      * Set sets the mapping pattern for all module base-directories
507      * included in this assembly.
508      *             NOTE: This field is only used if
509      * includeModuleDirectory == true.
510      *             Default is the module's ${artifactId} in
511      * 2.2-beta-1, and ${module.artifactId} in subsequent versions.
512      * (Since 2.2).
513      * 
514      * @param outputDirectoryMapping
515      */
516     public void setOutputDirectoryMapping( String outputDirectoryMapping )
517     {
518         this.outputDirectoryMapping = outputDirectoryMapping;
519     } //-- void setOutputDirectoryMapping( String )
520 
521     /**
522      * Set whether standard exclusion patterns, such as those
523      * matching CVS and Subversion
524      *             metadata files, should be used when calculating
525      * the files affected by this set.
526      *             For backward compatibility, the default value is
527      * true. (Since 2.2).
528      * 
529      * @param useDefaultExcludes
530      */
531     public void setUseDefaultExcludes( boolean useDefaultExcludes )
532     {
533         this.useDefaultExcludes = useDefaultExcludes;
534     } //-- void setUseDefaultExcludes( boolean )
535 
536 }