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