1 // =================== DO NOT EDIT THIS FILE ====================
2 // Generated by Modello 1.8.3,
3 // any modifications will be overwritten.
4 // ==============================================================
5
6 package org.apache.maven.plugin.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 *
47 *
48 * Sets the line-endings of the files. (Since 2.2)
49 * Valid values:
50 * <ul>
51 * <li><b>"keep"</b> - Preserve all line
52 * endings</li>
53 * <li><b>"unix"</b> - Use Unix-style line
54 * endings</li>
55 * <li><b>"lf"</b> - Use a single line-feed line
56 * endings</li>
57 * <li><b>"dos"</b> - Use DOS-style line
58 * endings</li>
59 * <li><b>"crlf"</b> - Use Carraige-return,
60 * line-feed line endings</li>
61 * </ul>
62 *
63 *
64 */
65 private String lineEnding;
66
67 /**
68 *
69 * Whether standard exclusion patterns, such as
70 * those matching CVS and Subversion
71 * metadata files, should be used when calculating
72 * the files affected by this set.
73 * For backward compatibility, the default value is
74 * true. (Since 2.2)
75 * .
76 */
77 private boolean useDefaultExcludes = true;
78
79 /**
80 *
81 *
82 * Allows to specify the encoding to use when
83 * unpacking archives, for unarchivers
84 * that support specifying encoding. If
85 * unspecified, archiver default will be used.
86 * Archiver defaults generally represent sane
87 * (modern) values.
88 *
89 *
90 */
91 private String encoding;
92
93
94 //-----------/
95 //- Methods -/
96 //-----------/
97
98 /**
99 * Method addExclude.
100 *
101 * @param string
102 */
103 public void addExclude( String string )
104 {
105 getExcludes().add( string );
106 } //-- void addExclude( String )
107
108 /**
109 * Method addInclude.
110 *
111 * @param string
112 */
113 public void addInclude( String string )
114 {
115 getIncludes().add( string );
116 } //-- void addInclude( String )
117
118 /**
119 * Get allows to specify the encoding to use when unpacking
120 * archives, for unarchivers
121 * that support specifying encoding. If
122 * unspecified, archiver default will be used.
123 * Archiver defaults generally represent sane
124 * (modern) values.
125 *
126 * @return String
127 */
128 public String getEncoding()
129 {
130 return this.encoding;
131 } //-- String getEncoding()
132
133 /**
134 * Method getExcludes.
135 *
136 * @return List
137 */
138 public java.util.List<String> getExcludes()
139 {
140 if ( this.excludes == null )
141 {
142 this.excludes = new java.util.ArrayList<String>();
143 }
144
145 return this.excludes;
146 } //-- java.util.List<String> getExcludes()
147
148 /**
149 * Method getIncludes.
150 *
151 * @return List
152 */
153 public java.util.List<String> getIncludes()
154 {
155 if ( this.includes == null )
156 {
157 this.includes = new java.util.ArrayList<String>();
158 }
159
160 return this.includes;
161 } //-- java.util.List<String> getIncludes()
162
163 /**
164 * Get sets the line-endings of the files. (Since 2.2)
165 * Valid values:
166 * <ul>
167 * <li><b>"keep"</b> - Preserve all line
168 * endings</li>
169 * <li><b>"unix"</b> - Use Unix-style line
170 * endings</li>
171 * <li><b>"lf"</b> - Use a single line-feed line
172 * endings</li>
173 * <li><b>"dos"</b> - Use DOS-style line
174 * endings</li>
175 * <li><b>"crlf"</b> - Use Carraige-return,
176 * line-feed line endings</li>
177 * </ul>
178 *
179 * @return String
180 */
181 public String getLineEnding()
182 {
183 return this.lineEnding;
184 } //-- String getLineEnding()
185
186 /**
187 * Get whether to filter symbols in the files as they are
188 * unpacked from the archive, using
189 * properties from the build configuration. (Since
190 * 2.2).
191 *
192 * @return boolean
193 */
194 public boolean isFiltered()
195 {
196 return this.filtered;
197 } //-- boolean isFiltered()
198
199 /**
200 * Get whether standard exclusion patterns, such as those
201 * matching CVS and Subversion
202 * metadata files, should be used when calculating
203 * the files affected by this set.
204 * For backward compatibility, the default value is
205 * true. (Since 2.2).
206 *
207 * @return boolean
208 */
209 public boolean isUseDefaultExcludes()
210 {
211 return this.useDefaultExcludes;
212 } //-- boolean isUseDefaultExcludes()
213
214 /**
215 * Method removeExclude.
216 *
217 * @param string
218 */
219 public void removeExclude( String string )
220 {
221 getExcludes().remove( string );
222 } //-- void removeExclude( String )
223
224 /**
225 * Method removeInclude.
226 *
227 * @param string
228 */
229 public void removeInclude( String string )
230 {
231 getIncludes().remove( string );
232 } //-- void removeInclude( String )
233
234 /**
235 * Set allows to specify the encoding to use when unpacking
236 * archives, for unarchivers
237 * that support specifying encoding. If
238 * unspecified, archiver default will be used.
239 * Archiver defaults generally represent sane
240 * (modern) values.
241 *
242 * @param encoding
243 */
244 public void setEncoding( String encoding )
245 {
246 this.encoding = encoding;
247 } //-- void setEncoding( String )
248
249 /**
250 * Set set of file and/or directory patterns for matching items
251 * to be excluded from an archive as it is unpacked.
252 * Each item is specified as
253 * <exclude>some/path</exclude> (Since 2.2).
254 *
255 * @param excludes
256 */
257 public void setExcludes( java.util.List<String> excludes )
258 {
259 this.excludes = excludes;
260 } //-- void setExcludes( java.util.List )
261
262 /**
263 * Set whether to filter symbols in the files as they are
264 * unpacked from the archive, using
265 * properties from the build configuration. (Since
266 * 2.2).
267 *
268 * @param filtered
269 */
270 public void setFiltered( boolean filtered )
271 {
272 this.filtered = filtered;
273 } //-- void setFiltered( boolean )
274
275 /**
276 * Set set of file and/or directory patterns for matching items
277 * to be included from an archive as it is unpacked.
278 * Each item is specified as
279 * <include>some/path</include> (Since 2.2).
280 *
281 * @param includes
282 */
283 public void setIncludes( java.util.List<String> includes )
284 {
285 this.includes = includes;
286 } //-- void setIncludes( java.util.List )
287
288 /**
289 * Set sets the line-endings of the files. (Since 2.2)
290 * Valid values:
291 * <ul>
292 * <li><b>"keep"</b> - Preserve all line
293 * endings</li>
294 * <li><b>"unix"</b> - Use Unix-style line
295 * endings</li>
296 * <li><b>"lf"</b> - Use a single line-feed line
297 * endings</li>
298 * <li><b>"dos"</b> - Use DOS-style line
299 * endings</li>
300 * <li><b>"crlf"</b> - Use Carraige-return,
301 * line-feed line endings</li>
302 * </ul>
303 *
304 * @param lineEnding
305 */
306 public void setLineEnding( String lineEnding )
307 {
308 this.lineEnding = lineEnding;
309 } //-- void setLineEnding( String )
310
311 /**
312 * Set whether standard exclusion patterns, such as those
313 * matching CVS and Subversion
314 * metadata files, should be used when calculating
315 * the files affected by this set.
316 * For backward compatibility, the default value is
317 * true. (Since 2.2).
318 *
319 * @param useDefaultExcludes
320 */
321 public void setUseDefaultExcludes( boolean useDefaultExcludes )
322 {
323 this.useDefaultExcludes = useDefaultExcludes;
324 } //-- void setUseDefaultExcludes( boolean )
325
326 }