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