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