1 // =================== DO NOT EDIT THIS FILE ====================
2 // Generated by Modello 2.1.2,
3 // any modifications will be overwritten.
4 // ==============================================================
5
6 package org.apache.maven.plugins.assembly.model;
7
8 /**
9 *
10 * Specifies options for including/excluding/filtering items
11 * extracted from an archive. (Since 2.2)
12 * .
13 *
14 * @version $Revision$ $Date$
15 */
16 @SuppressWarnings( "all" )
17 public class UnpackOptions
18 implements java.io.Serializable
19 {
20
21 //--------------------------/
22 //- Class/Member Variables -/
23 //--------------------------/
24
25 /**
26 * Field includes.
27 */
28 private java.util.List<String> includes;
29
30 /**
31 * Field excludes.
32 */
33 private java.util.List<String> excludes;
34
35 /**
36 *
37 * Whether to filter symbols in the files as they are
38 * unpacked from the archive, using
39 * properties from the build configuration. (Since
40 * 2.2)
41 * .
42 */
43 private boolean filtered = false;
44
45 /**
46 * Field nonFilteredFileExtensions.
47 */
48 private java.util.List<String> nonFilteredFileExtensions;
49
50 /**
51 *
52 *
53 * Sets the line-endings of the files. (Since 2.2)
54 * Valid values:
55 * <ul>
56 * <li><b>"keep"</b> - Preserve all line
57 * endings</li>
58 * <li><b>"unix"</b> - Use Unix-style line
59 * endings</li>
60 * <li><b>"lf"</b> - Use a single line-feed line
61 * endings</li>
62 * <li><b>"dos"</b> - Use DOS-style line
63 * endings</li>
64 * <li><b>"crlf"</b> - Use Carraige-return,
65 * line-feed line endings</li>
66 * </ul>
67 *
68 *
69 */
70 private String lineEnding;
71
72 /**
73 *
74 * Whether standard exclusion patterns, such as
75 * those matching CVS and Subversion
76 * metadata files, should be used when calculating
77 * the files affected by this set.
78 * For backward compatibility, the default value is
79 * true. (Since 2.2)
80 * .
81 */
82 private boolean useDefaultExcludes = true;
83
84 /**
85 *
86 *
87 * Allows to specify the encoding to use when
88 * unpacking archives, for unarchivers
89 * that support specifying encoding. If
90 * unspecified, archiver default will be used.
91 * Archiver defaults generally represent sane
92 * (modern) values.
93 *
94 *
95 */
96 private String encoding;
97
98
99 //-----------/
100 //- Methods -/
101 //-----------/
102
103 /**
104 * Method addExclude.
105 *
106 * @param string a string object.
107 */
108 public void addExclude( String string )
109 {
110 getExcludes().add( string );
111 } //-- void addExclude( String )
112
113 /**
114 * Method addInclude.
115 *
116 * @param string a string object.
117 */
118 public void addInclude( String string )
119 {
120 getIncludes().add( string );
121 } //-- void addInclude( String )
122
123 /**
124 * Method addNonFilteredFileExtension.
125 *
126 * @param string a string object.
127 */
128 public void addNonFilteredFileExtension( String string )
129 {
130 getNonFilteredFileExtensions().add( string );
131 } //-- void addNonFilteredFileExtension( String )
132
133 /**
134 * Get allows to specify the encoding to use when unpacking
135 * archives, for unarchivers
136 * that support specifying encoding. If
137 * unspecified, archiver default will be used.
138 * Archiver defaults generally represent sane
139 * (modern) values.
140 *
141 * @return String
142 */
143 public String getEncoding()
144 {
145 return this.encoding;
146 } //-- String getEncoding()
147
148 /**
149 * Method getExcludes.
150 *
151 * @return List
152 */
153 public java.util.List<String> getExcludes()
154 {
155 if ( this.excludes == null )
156 {
157 this.excludes = new java.util.ArrayList<String>();
158 }
159
160 return this.excludes;
161 } //-- java.util.List<String> getExcludes()
162
163 /**
164 * Method getIncludes.
165 *
166 * @return List
167 */
168 public java.util.List<String> getIncludes()
169 {
170 if ( this.includes == null )
171 {
172 this.includes = new java.util.ArrayList<String>();
173 }
174
175 return this.includes;
176 } //-- java.util.List<String> getIncludes()
177
178 /**
179 * Get sets the line-endings of the files. (Since 2.2)
180 * Valid values:
181 * <ul>
182 * <li><b>"keep"</b> - Preserve all line
183 * endings</li>
184 * <li><b>"unix"</b> - Use Unix-style line
185 * endings</li>
186 * <li><b>"lf"</b> - Use a single line-feed line
187 * endings</li>
188 * <li><b>"dos"</b> - Use DOS-style line
189 * endings</li>
190 * <li><b>"crlf"</b> - Use Carraige-return,
191 * line-feed line endings</li>
192 * </ul>
193 *
194 * @return String
195 */
196 public String getLineEnding()
197 {
198 return this.lineEnding;
199 } //-- String getLineEnding()
200
201 /**
202 * Method getNonFilteredFileExtensions.
203 *
204 * @return List
205 */
206 public java.util.List<String> getNonFilteredFileExtensions()
207 {
208 if ( this.nonFilteredFileExtensions == null )
209 {
210 this.nonFilteredFileExtensions = new java.util.ArrayList<String>();
211 }
212
213 return this.nonFilteredFileExtensions;
214 } //-- java.util.List<String> getNonFilteredFileExtensions()
215
216 /**
217 * Get whether to filter symbols in the files as they are
218 * unpacked from the archive, using
219 * properties from the build configuration. (Since
220 * 2.2).
221 *
222 * @return boolean
223 */
224 public boolean isFiltered()
225 {
226 return this.filtered;
227 } //-- boolean isFiltered()
228
229 /**
230 * Get whether standard exclusion patterns, such as those
231 * matching CVS and Subversion
232 * metadata files, should be used when calculating
233 * the files affected by this set.
234 * For backward compatibility, the default value is
235 * true. (Since 2.2).
236 *
237 * @return boolean
238 */
239 public boolean isUseDefaultExcludes()
240 {
241 return this.useDefaultExcludes;
242 } //-- boolean isUseDefaultExcludes()
243
244 /**
245 * Method removeExclude.
246 *
247 * @param string a string object.
248 */
249 public void removeExclude( String string )
250 {
251 getExcludes().remove( string );
252 } //-- void removeExclude( String )
253
254 /**
255 * Method removeInclude.
256 *
257 * @param string a string object.
258 */
259 public void removeInclude( String string )
260 {
261 getIncludes().remove( string );
262 } //-- void removeInclude( String )
263
264 /**
265 * Method removeNonFilteredFileExtension.
266 *
267 * @param string a string object.
268 */
269 public void removeNonFilteredFileExtension( String string )
270 {
271 getNonFilteredFileExtensions().remove( string );
272 } //-- void removeNonFilteredFileExtension( String )
273
274 /**
275 * Set allows to specify the encoding to use when unpacking
276 * archives, for unarchivers
277 * that support specifying encoding. If
278 * unspecified, archiver default will be used.
279 * Archiver defaults generally represent sane
280 * (modern) values.
281 *
282 * @param encoding a encoding object.
283 */
284 public void setEncoding( String encoding )
285 {
286 this.encoding = encoding;
287 } //-- void setEncoding( String )
288
289 /**
290 * Set set of file and/or directory patterns for matching items
291 * to be excluded from an archive as it is unpacked.
292 * Each item is specified as
293 * <exclude>some/path</exclude> (Since 2.2).
294 *
295 * @param excludes a excludes object.
296 */
297 public void setExcludes( java.util.List<String> excludes )
298 {
299 this.excludes = excludes;
300 } //-- void setExcludes( java.util.List )
301
302 /**
303 * Set whether to filter symbols in the files as they are
304 * unpacked from the archive, using
305 * properties from the build configuration. (Since
306 * 2.2).
307 *
308 * @param filtered a filtered object.
309 */
310 public void setFiltered( boolean filtered )
311 {
312 this.filtered = filtered;
313 } //-- void setFiltered( boolean )
314
315 /**
316 * Set set of file and/or directory patterns for matching items
317 * to be included from an archive as it is unpacked.
318 * Each item is specified as
319 * <include>some/path</include> (Since 2.2).
320 *
321 * @param includes a includes object.
322 */
323 public void setIncludes( java.util.List<String> includes )
324 {
325 this.includes = includes;
326 } //-- void setIncludes( java.util.List )
327
328 /**
329 * Set sets the line-endings of the files. (Since 2.2)
330 * Valid values:
331 * <ul>
332 * <li><b>"keep"</b> - Preserve all line
333 * endings</li>
334 * <li><b>"unix"</b> - Use Unix-style line
335 * endings</li>
336 * <li><b>"lf"</b> - Use a single line-feed line
337 * endings</li>
338 * <li><b>"dos"</b> - Use DOS-style line
339 * endings</li>
340 * <li><b>"crlf"</b> - Use Carraige-return,
341 * line-feed line endings</li>
342 * </ul>
343 *
344 * @param lineEnding a lineEnding object.
345 */
346 public void setLineEnding( String lineEnding )
347 {
348 this.lineEnding = lineEnding;
349 } //-- void setLineEnding( String )
350
351 /**
352 * Set additional file extensions to not apply filtering (Since
353 * 3.2.0).
354 *
355 * @param nonFilteredFileExtensions a nonFilteredFileExtensions
356 * object.
357 */
358 public void setNonFilteredFileExtensions( java.util.List<String> nonFilteredFileExtensions )
359 {
360 this.nonFilteredFileExtensions = nonFilteredFileExtensions;
361 } //-- void setNonFilteredFileExtensions( java.util.List )
362
363 /**
364 * Set whether standard exclusion patterns, such as those
365 * matching CVS and Subversion
366 * metadata files, should be used when calculating
367 * the files affected by this set.
368 * For backward compatibility, the default value is
369 * true. (Since 2.2).
370 *
371 * @param useDefaultExcludes a useDefaultExcludes object.
372 */
373 public void setUseDefaultExcludes( boolean useDefaultExcludes )
374 {
375 this.useDefaultExcludes = useDefaultExcludes;
376 } //-- void setUseDefaultExcludes( boolean )
377
378 }