1 /*
2 =================== DO NOT EDIT THIS FILE ====================
3 Generated by Modello 1.4.1 on 2011-11-29 12:00:52,
4 any modifications will be overwritten.
5 ==============================================================
6 */
7
8 package org.apache.maven.plugin.assembly.model;
9
10 /**
11 *
12 * Specifies options for including/excluding/filtering items
13 * extracted from an archive. (Since 2.2)
14 * .
15 *
16 * @version $Revision$ $Date$
17 */
18 @SuppressWarnings( "all" )
19 public class UnpackOptions
20 implements java.io.Serializable
21 {
22
23 //--------------------------/
24 //- Class/Member Variables -/
25 //--------------------------/
26
27 /**
28 * Field includes.
29 */
30 private java.util.List<String> includes;
31
32 /**
33 * Field excludes.
34 */
35 private java.util.List<String> excludes;
36
37 /**
38 *
39 * Whether to filter symbols in the files as they are
40 * unpacked from the archive, using
41 * properties from the build configuration. (Since
42 * 2.2)
43 * .
44 */
45 private boolean filtered = false;
46
47 /**
48 *
49 *
50 * Sets the line-endings of the files. (Since 2.2)
51 * Valid values:
52 * <ul>
53 * <li><b>"keep"</b> - Preserve all line
54 * endings</li>
55 * <li><b>"unix"</b> - Use Unix-style line
56 * endings</li>
57 * <li><b>"lf"</b> - Use a single line-feed line
58 * endings</li>
59 * <li><b>"dos"</b> - Use DOS-style line
60 * endings</li>
61 * <li><b>"crlf"</b> - Use Carraige-return,
62 * line-feed line endings</li>
63 * </ul>
64 *
65 *
66 */
67 private String lineEnding;
68
69 /**
70 *
71 * Whether standard exclusion patterns, such as
72 * those matching CVS and Subversion
73 * metadata files, should be used when calculating
74 * the files affected by this set.
75 * For backward compatibility, the default value is
76 * true. (Since 2.2)
77 * .
78 */
79 private boolean useDefaultExcludes = true;
80
81
82 //-----------/
83 //- Methods -/
84 //-----------/
85
86 /**
87 * Method addExclude.
88 *
89 * @param string
90 */
91 public void addExclude( String string )
92 {
93 getExcludes().add( string );
94 } //-- void addExclude( String )
95
96 /**
97 * Method addInclude.
98 *
99 * @param string
100 */
101 public void addInclude( String string )
102 {
103 getIncludes().add( string );
104 } //-- void addInclude( String )
105
106 /**
107 * Method getExcludes.
108 *
109 * @return List
110 */
111 public java.util.List<String> getExcludes()
112 {
113 if ( this.excludes == null )
114 {
115 this.excludes = new java.util.ArrayList<String>();
116 }
117
118 return this.excludes;
119 } //-- java.util.List<String> getExcludes()
120
121 /**
122 * Method getIncludes.
123 *
124 * @return List
125 */
126 public java.util.List<String> getIncludes()
127 {
128 if ( this.includes == null )
129 {
130 this.includes = new java.util.ArrayList<String>();
131 }
132
133 return this.includes;
134 } //-- java.util.List<String> getIncludes()
135
136 /**
137 * Get sets the line-endings of the files. (Since 2.2)
138 * Valid values:
139 * <ul>
140 * <li><b>"keep"</b> - Preserve all line
141 * endings</li>
142 * <li><b>"unix"</b> - Use Unix-style line
143 * endings</li>
144 * <li><b>"lf"</b> - Use a single line-feed line
145 * endings</li>
146 * <li><b>"dos"</b> - Use DOS-style line
147 * endings</li>
148 * <li><b>"crlf"</b> - Use Carraige-return,
149 * line-feed line endings</li>
150 * </ul>
151 *
152 * @return String
153 */
154 public String getLineEnding()
155 {
156 return this.lineEnding;
157 } //-- String getLineEnding()
158
159 /**
160 * Get whether to filter symbols in the files as they are
161 * unpacked from the archive, using
162 * properties from the build configuration. (Since
163 * 2.2).
164 *
165 * @return boolean
166 */
167 public boolean isFiltered()
168 {
169 return this.filtered;
170 } //-- boolean isFiltered()
171
172 /**
173 * Get whether standard exclusion patterns, such as those
174 * matching CVS and Subversion
175 * metadata files, should be used when calculating
176 * the files affected by this set.
177 * For backward compatibility, the default value is
178 * true. (Since 2.2).
179 *
180 * @return boolean
181 */
182 public boolean isUseDefaultExcludes()
183 {
184 return this.useDefaultExcludes;
185 } //-- boolean isUseDefaultExcludes()
186
187 /**
188 * Method removeExclude.
189 *
190 * @param string
191 */
192 public void removeExclude( String string )
193 {
194 getExcludes().remove( string );
195 } //-- void removeExclude( String )
196
197 /**
198 * Method removeInclude.
199 *
200 * @param string
201 */
202 public void removeInclude( String string )
203 {
204 getIncludes().remove( string );
205 } //-- void removeInclude( String )
206
207 /**
208 * Set set of file and/or directory patterns for matching items
209 * to be excluded from an archive as it is unpacked.
210 * Each item is specified as
211 * <exclude>some/path</exclude> (Since 2.2).
212 *
213 * @param excludes
214 */
215 public void setExcludes( java.util.List<String> excludes )
216 {
217 this.excludes = excludes;
218 } //-- void setExcludes( java.util.List )
219
220 /**
221 * Set whether to filter symbols in the files as they are
222 * unpacked from the archive, using
223 * properties from the build configuration. (Since
224 * 2.2).
225 *
226 * @param filtered
227 */
228 public void setFiltered( boolean filtered )
229 {
230 this.filtered = filtered;
231 } //-- void setFiltered( boolean )
232
233 /**
234 * Set set of file and/or directory patterns for matching items
235 * to be included from an archive as it is unpacked.
236 * Each item is specified as
237 * <include>some/path</include> (Since 2.2).
238 *
239 * @param includes
240 */
241 public void setIncludes( java.util.List<String> includes )
242 {
243 this.includes = includes;
244 } //-- void setIncludes( java.util.List )
245
246 /**
247 * Set sets the line-endings of the files. (Since 2.2)
248 * Valid values:
249 * <ul>
250 * <li><b>"keep"</b> - Preserve all line
251 * endings</li>
252 * <li><b>"unix"</b> - Use Unix-style line
253 * endings</li>
254 * <li><b>"lf"</b> - Use a single line-feed line
255 * endings</li>
256 * <li><b>"dos"</b> - Use DOS-style line
257 * endings</li>
258 * <li><b>"crlf"</b> - Use Carraige-return,
259 * line-feed line endings</li>
260 * </ul>
261 *
262 * @param lineEnding
263 */
264 public void setLineEnding( String lineEnding )
265 {
266 this.lineEnding = lineEnding;
267 } //-- void setLineEnding( String )
268
269 /**
270 * Set whether standard exclusion patterns, such as those
271 * matching CVS and Subversion
272 * metadata files, should be used when calculating
273 * the files affected by this set.
274 * For backward compatibility, the default value is
275 * true. (Since 2.2).
276 *
277 * @param useDefaultExcludes
278 */
279 public void setUseDefaultExcludes( boolean useDefaultExcludes )
280 {
281 this.useDefaultExcludes = useDefaultExcludes;
282 } //-- void setUseDefaultExcludes( boolean )
283
284 }