1 // =================== DO NOT EDIT THIS FILE ====================
2 // Generated by Modello 1.8.3,
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 //-----------/
146 //- Methods -/
147 //-----------/
148
149 /**
150 * Method addExclude.
151 *
152 * @param string
153 */
154 public void addExclude( String string )
155 {
156 getExcludes().add( string );
157 } //-- void addExclude( String )
158
159 /**
160 * Method addInclude.
161 *
162 * @param string
163 */
164 public void addInclude( String string )
165 {
166 getIncludes().add( string );
167 } //-- void addInclude( String )
168
169 /**
170 * Get sets the absolute or relative location from the module's
171 * directory. For example, "src/main/bin" would
172 * select this
173 * subdirectory of the project in which this
174 * dependency is defined.
175 *
176 * @return String
177 */
178 public String getDirectory()
179 {
180 return this.directory;
181 } //-- String getDirectory()
182
183 /**
184 * Get similar to a UNIX permission, sets the directory mode of
185 * the directories
186 * included.
187 * THIS IS AN OCTAL VALUE.
188 * Format: (User)(Group)(Other) where each
189 * component is a sum of
190 * Read = 4, Write = 2, and Execute = 1. For
191 * example, the value
192 * 0755 translates to User read-write, Group and
193 * Other read-only. The default value is 0755.
194 * <a
195 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
196 * on unix-style permissions)</a>
197 *
198 * @return String
199 */
200 public String getDirectoryMode()
201 {
202 return this.directoryMode;
203 } //-- String getDirectoryMode()
204
205 /**
206 * Method getExcludes.
207 *
208 * @return List
209 */
210 public java.util.List<String> getExcludes()
211 {
212 if ( this.excludes == null )
213 {
214 this.excludes = new java.util.ArrayList<String>();
215 }
216
217 return this.excludes;
218 } //-- java.util.List<String> getExcludes()
219
220 /**
221 * Get similar to a UNIX permission, sets the file mode of the
222 * files included.
223 * THIS IS AN OCTAL VALUE.
224 * Format: (User)(Group)(Other) where each
225 * component is a sum of Read = 4,
226 * Write = 2, and Execute = 1. For example, the
227 * value 0644
228 * translates to User read-write, Group and Other
229 * read-only. The default value is 0644.
230 * <a
231 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
232 * on unix-style permissions)</a>
233 *
234 * @return String
235 */
236 public String getFileMode()
237 {
238 return this.fileMode;
239 } //-- String getFileMode()
240
241 /**
242 * Method getIncludes.
243 *
244 * @return List
245 */
246 public java.util.List<String> getIncludes()
247 {
248 if ( this.includes == null )
249 {
250 this.includes = new java.util.ArrayList<String>();
251 }
252
253 return this.includes;
254 } //-- java.util.List<String> getIncludes()
255
256 /**
257 * Get sets the line-endings of the files in this fileSet.
258 * Valid values:
259 * <ul>
260 * <li><b>"keep"</b> - Preserve all line
261 * endings</li>
262 * <li><b>"unix"</b> - Use Unix-style line
263 * endings</li>
264 * <li><b>"lf"</b> - Use a single line-feed line
265 * endings</li>
266 * <li><b>"dos"</b> - Use DOS-style line
267 * endings</li>
268 * <li><b>"crlf"</b> - Use Carraige-return,
269 * line-feed line endings</li>
270 * </ul>
271 *
272 * @return String
273 */
274 public String getLineEnding()
275 {
276 return this.lineEnding;
277 } //-- String getLineEnding()
278
279 /**
280 * Get sets the output directory relative to the root
281 * of the root directory of the assembly. For
282 * example,
283 * "log" will put the specified files in the log
284 * directory.
285 *
286 * @return String
287 */
288 public String getOutputDirectory()
289 {
290 return this.outputDirectory;
291 } //-- String getOutputDirectory()
292
293 /**
294 * Get whether to filter symbols in the files as they are
295 * copied, using
296 * properties from the build configuration. (Since
297 * 2.2).
298 *
299 * @return boolean
300 */
301 public boolean isFiltered()
302 {
303 return this.filtered;
304 } //-- boolean isFiltered()
305
306 /**
307 * Get whether standard exclusion patterns, such as those
308 * matching CVS and Subversion
309 * metadata files, should be used when calculating
310 * the files affected by this set.
311 * For backward compatibility, the default value is
312 * true. (Since 2.2).
313 *
314 * @return boolean
315 */
316 public boolean isUseDefaultExcludes()
317 {
318 return this.useDefaultExcludes;
319 } //-- boolean isUseDefaultExcludes()
320
321 /**
322 * Method removeExclude.
323 *
324 * @param string
325 */
326 public void removeExclude( String string )
327 {
328 getExcludes().remove( string );
329 } //-- void removeExclude( String )
330
331 /**
332 * Method removeInclude.
333 *
334 * @param string
335 */
336 public void removeInclude( String string )
337 {
338 getIncludes().remove( string );
339 } //-- void removeInclude( String )
340
341 /**
342 * Set sets the absolute or relative location from the module's
343 * directory. For example, "src/main/bin" would
344 * select this
345 * subdirectory of the project in which this
346 * dependency is defined.
347 *
348 * @param directory
349 */
350 public void setDirectory( String directory )
351 {
352 this.directory = directory;
353 } //-- void setDirectory( String )
354
355 /**
356 * Set similar to a UNIX permission, sets the directory mode of
357 * the directories
358 * included.
359 * THIS IS AN OCTAL VALUE.
360 * Format: (User)(Group)(Other) where each
361 * component is a sum of
362 * Read = 4, Write = 2, and Execute = 1. For
363 * example, the value
364 * 0755 translates to User read-write, Group and
365 * Other read-only. The default value is 0755.
366 * <a
367 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
368 * on unix-style permissions)</a>
369 *
370 * @param directoryMode
371 */
372 public void setDirectoryMode( String directoryMode )
373 {
374 this.directoryMode = directoryMode;
375 } //-- void setDirectoryMode( String )
376
377 /**
378 * Set when <exclude> subelements are present, they
379 * define a set of
380 * files and directory to exclude. If none is
381 * present, then
382 * <excludes> represents no exclusions.
383 *
384 * @param excludes
385 */
386 public void setExcludes( java.util.List<String> excludes )
387 {
388 this.excludes = excludes;
389 } //-- void setExcludes( java.util.List )
390
391 /**
392 * Set similar to a UNIX permission, sets the file mode of the
393 * files included.
394 * THIS IS AN OCTAL VALUE.
395 * Format: (User)(Group)(Other) where each
396 * component is a sum of Read = 4,
397 * Write = 2, and Execute = 1. For example, the
398 * value 0644
399 * translates to User read-write, Group and Other
400 * read-only. The default value is 0644.
401 * <a
402 * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
403 * on unix-style permissions)</a>
404 *
405 * @param fileMode
406 */
407 public void setFileMode( String fileMode )
408 {
409 this.fileMode = fileMode;
410 } //-- void setFileMode( String )
411
412 /**
413 * Set whether to filter symbols in the files as they are
414 * copied, using
415 * properties from the build configuration. (Since
416 * 2.2).
417 *
418 * @param filtered
419 */
420 public void setFiltered( boolean filtered )
421 {
422 this.filtered = filtered;
423 } //-- void setFiltered( boolean )
424
425 /**
426 * Set when <include> subelements are present, they
427 * define a set of
428 * files and directory to include. If none is
429 * present, then
430 * <includes> represents all valid values.
431 *
432 * @param includes
433 */
434 public void setIncludes( java.util.List<String> includes )
435 {
436 this.includes = includes;
437 } //-- void setIncludes( java.util.List )
438
439 /**
440 * Set sets the line-endings of the files in this fileSet.
441 * Valid values:
442 * <ul>
443 * <li><b>"keep"</b> - Preserve all line
444 * endings</li>
445 * <li><b>"unix"</b> - Use Unix-style line
446 * endings</li>
447 * <li><b>"lf"</b> - Use a single line-feed line
448 * endings</li>
449 * <li><b>"dos"</b> - Use DOS-style line
450 * endings</li>
451 * <li><b>"crlf"</b> - Use Carraige-return,
452 * line-feed line endings</li>
453 * </ul>
454 *
455 * @param lineEnding
456 */
457 public void setLineEnding( String lineEnding )
458 {
459 this.lineEnding = lineEnding;
460 } //-- void setLineEnding( String )
461
462 /**
463 * Set sets the output directory relative to the root
464 * of the root directory of the assembly. For
465 * example,
466 * "log" will put the specified files in the log
467 * directory.
468 *
469 * @param outputDirectory
470 */
471 public void setOutputDirectory( String outputDirectory )
472 {
473 this.outputDirectory = outputDirectory;
474 } //-- void setOutputDirectory( String )
475
476 /**
477 * Set whether standard exclusion patterns, such as those
478 * matching CVS and Subversion
479 * metadata files, should be used when calculating
480 * the files affected by this set.
481 * For backward compatibility, the default value is
482 * true. (Since 2.2).
483 *
484 * @param useDefaultExcludes
485 */
486 public void setUseDefaultExcludes( boolean useDefaultExcludes )
487 {
488 this.useDefaultExcludes = useDefaultExcludes;
489 } //-- void setUseDefaultExcludes( boolean )
490
491 }