Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
SetBase |
|
| 1.1;1.1 |
1 | /* | |
2 | * $Id$ | |
3 | */ | |
4 | ||
5 | package org.apache.maven.plugins.assembly.model; | |
6 | ||
7 | /** | |
8 | * null | |
9 | * | |
10 | * @version $Revision$ $Date$ | |
11 | */ | |
12 | 0 | public class SetBase implements java.io.Serializable { |
13 | ||
14 | ||
15 | //--------------------------/ | |
16 | //- Class/Member Variables -/ | |
17 | //--------------------------/ | |
18 | ||
19 | /** | |
20 | * Field useStrictFiltering | |
21 | */ | |
22 | 0 | private boolean useStrictFiltering = false; |
23 | ||
24 | /** | |
25 | * Field useDefaultExcludes | |
26 | */ | |
27 | 0 | private boolean useDefaultExcludes = true; |
28 | ||
29 | /** | |
30 | * Field outputDirectory | |
31 | */ | |
32 | private String outputDirectory; | |
33 | ||
34 | /** | |
35 | * Field includes | |
36 | */ | |
37 | private java.util.List includes; | |
38 | ||
39 | /** | |
40 | * Field excludes | |
41 | */ | |
42 | private java.util.List excludes; | |
43 | ||
44 | /** | |
45 | * Field fileMode | |
46 | */ | |
47 | 0 | private String fileMode = "0644"; |
48 | ||
49 | /** | |
50 | * Field directoryMode | |
51 | */ | |
52 | 0 | private String directoryMode = "0755"; |
53 | ||
54 | ||
55 | //-----------/ | |
56 | //- Methods -/ | |
57 | //-----------/ | |
58 | ||
59 | /** | |
60 | * Method addExclude | |
61 | * | |
62 | * @param string | |
63 | */ | |
64 | public void addExclude(String string) | |
65 | { | |
66 | 0 | getExcludes().add( string ); |
67 | 0 | } //-- void addExclude(String) |
68 | ||
69 | /** | |
70 | * Method addInclude | |
71 | * | |
72 | * @param string | |
73 | */ | |
74 | public void addInclude(String string) | |
75 | { | |
76 | 0 | getIncludes().add( string ); |
77 | 0 | } //-- void addInclude(String) |
78 | ||
79 | /** | |
80 | * Get | |
81 | * | |
82 | * Similar to a UNIX permission, sets the directory | |
83 | * mode of the directories | |
84 | * included. Format: (User)(Group)(Other) where | |
85 | * each component is a sum of | |
86 | * Read = 4, Write = 2, and Execute = 1. For | |
87 | * example, the default value of | |
88 | * 0644 translates to User read-write, Group and | |
89 | * Other read-only. | |
90 | * <a | |
91 | * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more | |
92 | * on unix-style permissions)</a> | |
93 | * | |
94 | * | |
95 | */ | |
96 | public String getDirectoryMode() | |
97 | { | |
98 | 0 | return this.directoryMode; |
99 | } //-- String getDirectoryMode() | |
100 | ||
101 | /** | |
102 | * Method getExcludes | |
103 | */ | |
104 | public java.util.List getExcludes() | |
105 | { | |
106 | 0 | if ( this.excludes == null ) |
107 | { | |
108 | 0 | this.excludes = new java.util.ArrayList(); |
109 | } | |
110 | ||
111 | 0 | return this.excludes; |
112 | } //-- java.util.List getExcludes() | |
113 | ||
114 | /** | |
115 | * Get | |
116 | * | |
117 | * Similar to a UNIX permission, sets the file mode | |
118 | * of the files included. | |
119 | * Format: (User)(Group)(Other) where each | |
120 | * component is a sum of Read = 4, | |
121 | * Write = 2, and Execute = 1. For example, the | |
122 | * default value of 0644 | |
123 | * translates to User read-write, Group and Other | |
124 | * read-only. | |
125 | * <a | |
126 | * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more | |
127 | * on unix-style permissions)</a> | |
128 | * | |
129 | * | |
130 | */ | |
131 | public String getFileMode() | |
132 | { | |
133 | 0 | return this.fileMode; |
134 | } //-- String getFileMode() | |
135 | ||
136 | /** | |
137 | * Method getIncludes | |
138 | */ | |
139 | public java.util.List getIncludes() | |
140 | { | |
141 | 0 | if ( this.includes == null ) |
142 | { | |
143 | 0 | this.includes = new java.util.ArrayList(); |
144 | } | |
145 | ||
146 | 0 | return this.includes; |
147 | } //-- java.util.List getIncludes() | |
148 | ||
149 | /** | |
150 | * Get | |
151 | * Sets the output directory relative to the root | |
152 | * of the root directory of the assembly. For | |
153 | * example, | |
154 | * "log" will put the specified files in the log | |
155 | * directory. | |
156 | * | |
157 | */ | |
158 | public String getOutputDirectory() | |
159 | { | |
160 | 0 | return this.outputDirectory; |
161 | } //-- String getOutputDirectory() | |
162 | ||
163 | /** | |
164 | * Get | |
165 | * Whether standard exclusion patterns, such as | |
166 | * those matching CVS and Subversion | |
167 | * metadata files, should be used when calculating | |
168 | * the files affected by this set. | |
169 | * For backward compatibility, the default value is | |
170 | * true. | |
171 | * | |
172 | */ | |
173 | public boolean isUseDefaultExcludes() | |
174 | { | |
175 | 0 | return this.useDefaultExcludes; |
176 | } //-- boolean isUseDefaultExcludes() | |
177 | ||
178 | /** | |
179 | * Get | |
180 | * When specified as true, any include/exclude | |
181 | * patterns which aren't used to filter an actual | |
182 | * artifact during assembly creation will cause the | |
183 | * build to fail with an error. This is meant | |
184 | * to highlight obsolete inclusions or exclusions, or | |
185 | * else signal that the assembly descriptor | |
186 | * is incorrectly configured. | |
187 | * | |
188 | */ | |
189 | public boolean isUseStrictFiltering() | |
190 | { | |
191 | 0 | return this.useStrictFiltering; |
192 | } //-- boolean isUseStrictFiltering() | |
193 | ||
194 | /** | |
195 | * Method removeExclude | |
196 | * | |
197 | * @param string | |
198 | */ | |
199 | public void removeExclude(String string) | |
200 | { | |
201 | 0 | getExcludes().remove( string ); |
202 | 0 | } //-- void removeExclude(String) |
203 | ||
204 | /** | |
205 | * Method removeInclude | |
206 | * | |
207 | * @param string | |
208 | */ | |
209 | public void removeInclude(String string) | |
210 | { | |
211 | 0 | getIncludes().remove( string ); |
212 | 0 | } //-- void removeInclude(String) |
213 | ||
214 | /** | |
215 | * Set | |
216 | * | |
217 | * Similar to a UNIX permission, sets the directory | |
218 | * mode of the directories | |
219 | * included. Format: (User)(Group)(Other) where | |
220 | * each component is a sum of | |
221 | * Read = 4, Write = 2, and Execute = 1. For | |
222 | * example, the default value of | |
223 | * 0644 translates to User read-write, Group and | |
224 | * Other read-only. | |
225 | * <a | |
226 | * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more | |
227 | * on unix-style permissions)</a> | |
228 | * | |
229 | * | |
230 | * | |
231 | * @param directoryMode | |
232 | */ | |
233 | public void setDirectoryMode(String directoryMode) | |
234 | { | |
235 | 0 | this.directoryMode = directoryMode; |
236 | 0 | } //-- void setDirectoryMode(String) |
237 | ||
238 | /** | |
239 | * Set | |
240 | * | |
241 | * When <exclude> subelements are present, | |
242 | * they define a set of | |
243 | * files and directory to exclude. If none is | |
244 | * present, then | |
245 | * <excludes> represents no exclusions. | |
246 | * | |
247 | * | |
248 | * | |
249 | * @param excludes | |
250 | */ | |
251 | public void setExcludes(java.util.List excludes) | |
252 | { | |
253 | 0 | this.excludes = excludes; |
254 | 0 | } //-- void setExcludes(java.util.List) |
255 | ||
256 | /** | |
257 | * Set | |
258 | * | |
259 | * Similar to a UNIX permission, sets the file mode | |
260 | * of the files included. | |
261 | * Format: (User)(Group)(Other) where each | |
262 | * component is a sum of Read = 4, | |
263 | * Write = 2, and Execute = 1. For example, the | |
264 | * default value of 0644 | |
265 | * translates to User read-write, Group and Other | |
266 | * read-only. | |
267 | * <a | |
268 | * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more | |
269 | * on unix-style permissions)</a> | |
270 | * | |
271 | * | |
272 | * | |
273 | * @param fileMode | |
274 | */ | |
275 | public void setFileMode(String fileMode) | |
276 | { | |
277 | 0 | this.fileMode = fileMode; |
278 | 0 | } //-- void setFileMode(String) |
279 | ||
280 | /** | |
281 | * Set | |
282 | * | |
283 | * When <include> subelements are present, | |
284 | * they define a set of | |
285 | * files and directory to include. If none is | |
286 | * present, then | |
287 | * <includes> represents all valid values. | |
288 | * | |
289 | * | |
290 | * | |
291 | * @param includes | |
292 | */ | |
293 | public void setIncludes(java.util.List includes) | |
294 | { | |
295 | 0 | this.includes = includes; |
296 | 0 | } //-- void setIncludes(java.util.List) |
297 | ||
298 | /** | |
299 | * Set | |
300 | * Sets the output directory relative to the root | |
301 | * of the root directory of the assembly. For | |
302 | * example, | |
303 | * "log" will put the specified files in the log | |
304 | * directory. | |
305 | * | |
306 | * | |
307 | * @param outputDirectory | |
308 | */ | |
309 | public void setOutputDirectory(String outputDirectory) | |
310 | { | |
311 | 0 | this.outputDirectory = outputDirectory; |
312 | 0 | } //-- void setOutputDirectory(String) |
313 | ||
314 | /** | |
315 | * Set | |
316 | * Whether standard exclusion patterns, such as | |
317 | * those matching CVS and Subversion | |
318 | * metadata files, should be used when calculating | |
319 | * the files affected by this set. | |
320 | * For backward compatibility, the default value is | |
321 | * true. | |
322 | * | |
323 | * | |
324 | * @param useDefaultExcludes | |
325 | */ | |
326 | public void setUseDefaultExcludes(boolean useDefaultExcludes) | |
327 | { | |
328 | 0 | this.useDefaultExcludes = useDefaultExcludes; |
329 | 0 | } //-- void setUseDefaultExcludes(boolean) |
330 | ||
331 | /** | |
332 | * Set | |
333 | * When specified as true, any include/exclude | |
334 | * patterns which aren't used to filter an actual | |
335 | * artifact during assembly creation will cause the | |
336 | * build to fail with an error. This is meant | |
337 | * to highlight obsolete inclusions or exclusions, or | |
338 | * else signal that the assembly descriptor | |
339 | * is incorrectly configured. | |
340 | * | |
341 | * | |
342 | * @param useStrictFiltering | |
343 | */ | |
344 | public void setUseStrictFiltering(boolean useStrictFiltering) | |
345 | { | |
346 | 0 | this.useStrictFiltering = useStrictFiltering; |
347 | 0 | } //-- void setUseStrictFiltering(boolean) |
348 | ||
349 | ||
350 | 0 | private String modelEncoding = "UTF-8"; |
351 | ||
352 | public void setModelEncoding( String modelEncoding ) | |
353 | { | |
354 | 0 | this.modelEncoding = modelEncoding; |
355 | 0 | } |
356 | ||
357 | public String getModelEncoding() | |
358 | { | |
359 | 0 | return modelEncoding; |
360 | }} |