Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
FileItem |
|
| 1.0;1 |
1 | /* | |
2 | =================== DO NOT EDIT THIS FILE ==================== | |
3 | Generated by Modello 1.4.1 on 2012-11-15 00:07:43, | |
4 | any modifications will be overwritten. | |
5 | ============================================================== | |
6 | */ | |
7 | ||
8 | package org.apache.maven.plugin.assembly.model; | |
9 | ||
10 | /** | |
11 | * | |
12 | * A file allows individual file inclusion with the option | |
13 | * to change | |
14 | * the destination filename not supported by fileSets. | |
15 | * | |
16 | * | |
17 | * @version $Revision$ $Date$ | |
18 | */ | |
19 | @SuppressWarnings( "all" ) | |
20 | 14 | public class FileItem |
21 | implements java.io.Serializable | |
22 | { | |
23 | ||
24 | //--------------------------/ | |
25 | //- Class/Member Variables -/ | |
26 | //--------------------------/ | |
27 | ||
28 | /** | |
29 | * | |
30 | * Sets the absolute or relative path from the | |
31 | * module's directory | |
32 | * of the file to be included in the assembly. | |
33 | * | |
34 | */ | |
35 | private String source; | |
36 | ||
37 | /** | |
38 | * | |
39 | * Sets the output directory relative to the root | |
40 | * of the root directory of the assembly. For | |
41 | * example, | |
42 | * "log" will put the specified files in the log | |
43 | * directory. | |
44 | * | |
45 | */ | |
46 | private String outputDirectory; | |
47 | ||
48 | /** | |
49 | * | |
50 | * Sets the destination filename in the | |
51 | * outputDirectory. | |
52 | * Default is the same name as the source's file. | |
53 | * | |
54 | */ | |
55 | private String destName; | |
56 | ||
57 | /** | |
58 | * | |
59 | * | |
60 | * Similar to a UNIX permission, sets the file mode | |
61 | * of the files included. | |
62 | * THIS IS AN OCTAL VALUE. | |
63 | * Format: (User)(Group)(Other) where each | |
64 | * component is a sum of Read = 4, | |
65 | * Write = 2, and Execute = 1. For example, the | |
66 | * value 0644 | |
67 | * translates to User read-write, Group and Other | |
68 | * read-only. | |
69 | * <a | |
70 | * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more | |
71 | * on unix-style permissions)</a> | |
72 | * | |
73 | * | |
74 | */ | |
75 | private String fileMode; | |
76 | ||
77 | /** | |
78 | * | |
79 | * | |
80 | * Sets the line-endings of the files in this file. | |
81 | * Valid values are: | |
82 | * <ul> | |
83 | * <li><b>"keep"</b> - Preserve all line | |
84 | * endings</li> | |
85 | * <li><b>"unix"</b> - Use Unix-style line | |
86 | * endings</li> | |
87 | * <li><b>"lf"</b> - Use a single line-feed line | |
88 | * endings</li> | |
89 | * <li><b>"dos"</b> - Use DOS-style line | |
90 | * endings</li> | |
91 | * <li><b>"crlf"</b> - Use Carraige-return, | |
92 | * line-feed line endings</li> | |
93 | * </ul> | |
94 | * | |
95 | * | |
96 | */ | |
97 | private String lineEnding; | |
98 | ||
99 | /** | |
100 | * | |
101 | * Sets whether to determine if the file is | |
102 | * filtered. | |
103 | * | |
104 | */ | |
105 | 14 | private boolean filtered = false; |
106 | ||
107 | ||
108 | //-----------/ | |
109 | //- Methods -/ | |
110 | //-----------/ | |
111 | ||
112 | /** | |
113 | * Get sets the destination filename in the outputDirectory. | |
114 | * Default is the same name as the source's file. | |
115 | * | |
116 | * @return String | |
117 | */ | |
118 | public String getDestName() | |
119 | { | |
120 | 11 | return this.destName; |
121 | } //-- String getDestName() | |
122 | ||
123 | /** | |
124 | * Get similar to a UNIX permission, sets the file mode of the | |
125 | * files included. | |
126 | * THIS IS AN OCTAL VALUE. | |
127 | * Format: (User)(Group)(Other) where each | |
128 | * component is a sum of Read = 4, | |
129 | * Write = 2, and Execute = 1. For example, the | |
130 | * value 0644 | |
131 | * translates to User read-write, Group and Other | |
132 | * read-only. | |
133 | * <a | |
134 | * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more | |
135 | * on unix-style permissions)</a> | |
136 | * | |
137 | * @return String | |
138 | */ | |
139 | public String getFileMode() | |
140 | { | |
141 | 11 | return this.fileMode; |
142 | } //-- String getFileMode() | |
143 | ||
144 | /** | |
145 | * Get sets the line-endings of the files in this file. | |
146 | * Valid values are: | |
147 | * <ul> | |
148 | * <li><b>"keep"</b> - Preserve all line | |
149 | * endings</li> | |
150 | * <li><b>"unix"</b> - Use Unix-style line | |
151 | * endings</li> | |
152 | * <li><b>"lf"</b> - Use a single line-feed line | |
153 | * endings</li> | |
154 | * <li><b>"dos"</b> - Use DOS-style line | |
155 | * endings</li> | |
156 | * <li><b>"crlf"</b> - Use Carraige-return, | |
157 | * line-feed line endings</li> | |
158 | * </ul> | |
159 | * | |
160 | * @return String | |
161 | */ | |
162 | public String getLineEnding() | |
163 | { | |
164 | 11 | return this.lineEnding; |
165 | } //-- String getLineEnding() | |
166 | ||
167 | /** | |
168 | * Get sets the output directory relative to the root | |
169 | * of the root directory of the assembly. For | |
170 | * example, | |
171 | * "log" will put the specified files in the log | |
172 | * directory. | |
173 | * | |
174 | * @return String | |
175 | */ | |
176 | public String getOutputDirectory() | |
177 | { | |
178 | 11 | return this.outputDirectory; |
179 | } //-- String getOutputDirectory() | |
180 | ||
181 | /** | |
182 | * Get sets the absolute or relative path from the module's | |
183 | * directory | |
184 | * of the file to be included in the assembly. | |
185 | * | |
186 | * @return String | |
187 | */ | |
188 | public String getSource() | |
189 | { | |
190 | 14 | return this.source; |
191 | } //-- String getSource() | |
192 | ||
193 | /** | |
194 | * Get sets whether to determine if the file is filtered. | |
195 | * | |
196 | * @return boolean | |
197 | */ | |
198 | public boolean isFiltered() | |
199 | { | |
200 | 11 | return this.filtered; |
201 | } //-- boolean isFiltered() | |
202 | ||
203 | /** | |
204 | * Set sets the destination filename in the outputDirectory. | |
205 | * Default is the same name as the source's file. | |
206 | * | |
207 | * @param destName | |
208 | */ | |
209 | public void setDestName( String destName ) | |
210 | { | |
211 | 6 | this.destName = destName; |
212 | 6 | } //-- void setDestName( String ) |
213 | ||
214 | /** | |
215 | * Set similar to a UNIX permission, sets the file mode of the | |
216 | * files included. | |
217 | * THIS IS AN OCTAL VALUE. | |
218 | * Format: (User)(Group)(Other) where each | |
219 | * component is a sum of Read = 4, | |
220 | * Write = 2, and Execute = 1. For example, the | |
221 | * value 0644 | |
222 | * translates to User read-write, Group and Other | |
223 | * read-only. | |
224 | * <a | |
225 | * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more | |
226 | * on unix-style permissions)</a> | |
227 | * | |
228 | * @param fileMode | |
229 | */ | |
230 | public void setFileMode( String fileMode ) | |
231 | { | |
232 | 11 | this.fileMode = fileMode; |
233 | 11 | } //-- void setFileMode( String ) |
234 | ||
235 | /** | |
236 | * Set sets whether to determine if the file is filtered. | |
237 | * | |
238 | * @param filtered | |
239 | */ | |
240 | public void setFiltered( boolean filtered ) | |
241 | { | |
242 | 11 | this.filtered = filtered; |
243 | 11 | } //-- void setFiltered( boolean ) |
244 | ||
245 | /** | |
246 | * Set sets the line-endings of the files in this file. | |
247 | * Valid values are: | |
248 | * <ul> | |
249 | * <li><b>"keep"</b> - Preserve all line | |
250 | * endings</li> | |
251 | * <li><b>"unix"</b> - Use Unix-style line | |
252 | * endings</li> | |
253 | * <li><b>"lf"</b> - Use a single line-feed line | |
254 | * endings</li> | |
255 | * <li><b>"dos"</b> - Use DOS-style line | |
256 | * endings</li> | |
257 | * <li><b>"crlf"</b> - Use Carraige-return, | |
258 | * line-feed line endings</li> | |
259 | * </ul> | |
260 | * | |
261 | * @param lineEnding | |
262 | */ | |
263 | public void setLineEnding( String lineEnding ) | |
264 | { | |
265 | 11 | this.lineEnding = lineEnding; |
266 | 11 | } //-- void setLineEnding( String ) |
267 | ||
268 | /** | |
269 | * Set sets the output directory relative to the root | |
270 | * of the root directory of the assembly. For | |
271 | * example, | |
272 | * "log" will put the specified files in the log | |
273 | * directory. | |
274 | * | |
275 | * @param outputDirectory | |
276 | */ | |
277 | public void setOutputDirectory( String outputDirectory ) | |
278 | { | |
279 | 7 | this.outputDirectory = outputDirectory; |
280 | 7 | } //-- void setOutputDirectory( String ) |
281 | ||
282 | /** | |
283 | * Set sets the absolute or relative path from the module's | |
284 | * directory | |
285 | * of the file to be included in the assembly. | |
286 | * | |
287 | * @param source | |
288 | */ | |
289 | public void setSource( String source ) | |
290 | { | |
291 | 14 | this.source = source; |
292 | 14 | } //-- void setSource( String ) |
293 | ||
294 | } |