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