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