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