View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 1.9.1,
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       * Field sources.
37       */
38      private java.util.List<String> sources;
39  
40      /**
41       * 
42       *             Sets the output directory relative to the root
43       *             of the root directory of the assembly. For
44       * example,
45       *             "log" will put the specified files in the log
46       * directory.
47       *           
48       */
49      private String outputDirectory;
50  
51      /**
52       * 
53       *             Sets the destination filename in the
54       * outputDirectory.
55       *             Default is the same name as the source's file.
56       *           
57       */
58      private String destName;
59  
60      /**
61       * 
62       *             
63       *             Similar to a UNIX permission, sets the file mode
64       * of the files included.
65       *             THIS IS AN OCTAL VALUE.
66       *             Format: (User)(Group)(Other) where each
67       * component is a sum of Read = 4,
68       *             Write = 2, and Execute = 1.  For example, the
69       * value 0644
70       *             translates to User read-write, Group and Other
71       * read-only. The default value is 0644.
72       *             <a
73       * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
74       * on unix-style permissions)</a>
75       *             
76       *           
77       */
78      private String fileMode;
79  
80      /**
81       * 
82       *             
83       *             Sets the line-endings of the files in this file.
84       *             Valid values are:
85       *             <ul>
86       *               <li><b>"keep"</b> - Preserve all line
87       * endings</li>
88       *               <li><b>"unix"</b> - Use Unix-style line
89       * endings</li>
90       *               <li><b>"lf"</b> - Use a single line-feed line
91       * endings</li>
92       *               <li><b>"dos"</b> - Use DOS-style line
93       * endings</li>
94       *               <li><b>"crlf"</b> - Use Carraige-return,
95       * line-feed line endings</li>
96       *             </ul>
97       *             
98       *           
99       */
100     private String lineEnding;
101 
102     /**
103      * 
104      *             Sets whether to determine if the file is
105      * filtered.
106      *           
107      */
108     private boolean filtered = false;
109 
110 
111       //-----------/
112      //- Methods -/
113     //-----------/
114 
115     /**
116      * Method addSource.
117      * 
118      * @param string
119      */
120     public void addSource( String string )
121     {
122         getSources().add( string );
123     } //-- void addSource( String )
124 
125     /**
126      * Get sets the destination filename in the outputDirectory.
127      *             Default is the same name as the source's file.
128      * 
129      * @return String
130      */
131     public String getDestName()
132     {
133         return this.destName;
134     } //-- String getDestName()
135 
136     /**
137      * Get similar to a UNIX permission, sets the file mode of the
138      * files included.
139      *             THIS IS AN OCTAL VALUE.
140      *             Format: (User)(Group)(Other) where each
141      * component is a sum of Read = 4,
142      *             Write = 2, and Execute = 1.  For example, the
143      * value 0644
144      *             translates to User read-write, Group and Other
145      * read-only. The default value is 0644.
146      *             <a
147      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
148      * on unix-style permissions)</a>
149      * 
150      * @return String
151      */
152     public String getFileMode()
153     {
154         return this.fileMode;
155     } //-- String getFileMode()
156 
157     /**
158      * Get sets the line-endings of the files in this file.
159      *             Valid values are:
160      *             <ul>
161      *               <li><b>"keep"</b> - Preserve all line
162      * endings</li>
163      *               <li><b>"unix"</b> - Use Unix-style line
164      * endings</li>
165      *               <li><b>"lf"</b> - Use a single line-feed line
166      * endings</li>
167      *               <li><b>"dos"</b> - Use DOS-style line
168      * endings</li>
169      *               <li><b>"crlf"</b> - Use Carraige-return,
170      * line-feed line endings</li>
171      *             </ul>
172      * 
173      * @return String
174      */
175     public String getLineEnding()
176     {
177         return this.lineEnding;
178     } //-- String getLineEnding()
179 
180     /**
181      * Get sets the output directory relative to the root
182      *             of the root directory of the assembly. For
183      * example,
184      *             "log" will put the specified files in the log
185      * directory.
186      * 
187      * @return String
188      */
189     public String getOutputDirectory()
190     {
191         return this.outputDirectory;
192     } //-- String getOutputDirectory()
193 
194     /**
195      * Get sets the absolute or relative path from the module's
196      * directory
197      *             of the file to be included in the assembly.
198      * 
199      * @return String
200      */
201     public String getSource()
202     {
203         return this.source;
204     } //-- String getSource()
205 
206     /**
207      * Method getSources.
208      * 
209      * @return List
210      */
211     public java.util.List<String> getSources()
212     {
213         if ( this.sources == null )
214         {
215             this.sources = new java.util.ArrayList<String>();
216         }
217 
218         return this.sources;
219     } //-- java.util.List<String> getSources()
220 
221     /**
222      * Get sets whether to determine if the file is filtered.
223      * 
224      * @return boolean
225      */
226     public boolean isFiltered()
227     {
228         return this.filtered;
229     } //-- boolean isFiltered()
230 
231     /**
232      * Method removeSource.
233      * 
234      * @param string
235      */
236     public void removeSource( String string )
237     {
238         getSources().remove( string );
239     } //-- void removeSource( String )
240 
241     /**
242      * Set sets the destination filename in the outputDirectory.
243      *             Default is the same name as the source's file.
244      * 
245      * @param destName
246      */
247     public void setDestName( String destName )
248     {
249         this.destName = destName;
250     } //-- void setDestName( String )
251 
252     /**
253      * Set similar to a UNIX permission, sets the file mode of the
254      * files included.
255      *             THIS IS AN OCTAL VALUE.
256      *             Format: (User)(Group)(Other) where each
257      * component is a sum of Read = 4,
258      *             Write = 2, and Execute = 1.  For example, the
259      * value 0644
260      *             translates to User read-write, Group and Other
261      * read-only. The default value is 0644.
262      *             <a
263      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
264      * on unix-style permissions)</a>
265      * 
266      * @param fileMode
267      */
268     public void setFileMode( String fileMode )
269     {
270         this.fileMode = fileMode;
271     } //-- void setFileMode( String )
272 
273     /**
274      * Set sets whether to determine if the file is filtered.
275      * 
276      * @param filtered
277      */
278     public void setFiltered( boolean filtered )
279     {
280         this.filtered = filtered;
281     } //-- void setFiltered( boolean )
282 
283     /**
284      * Set sets the line-endings of the files in this file.
285      *             Valid values are:
286      *             <ul>
287      *               <li><b>"keep"</b> - Preserve all line
288      * endings</li>
289      *               <li><b>"unix"</b> - Use Unix-style line
290      * endings</li>
291      *               <li><b>"lf"</b> - Use a single line-feed line
292      * endings</li>
293      *               <li><b>"dos"</b> - Use DOS-style line
294      * endings</li>
295      *               <li><b>"crlf"</b> - Use Carraige-return,
296      * line-feed line endings</li>
297      *             </ul>
298      * 
299      * @param lineEnding
300      */
301     public void setLineEnding( String lineEnding )
302     {
303         this.lineEnding = lineEnding;
304     } //-- void setLineEnding( String )
305 
306     /**
307      * Set sets the output directory relative to the root
308      *             of the root directory of the assembly. For
309      * example,
310      *             "log" will put the specified files in the log
311      * directory.
312      * 
313      * @param outputDirectory
314      */
315     public void setOutputDirectory( String outputDirectory )
316     {
317         this.outputDirectory = outputDirectory;
318     } //-- void setOutputDirectory( String )
319 
320     /**
321      * Set sets the absolute or relative path from the module's
322      * directory
323      *             of the file to be included in the assembly.
324      * 
325      * @param source
326      */
327     public void setSource( String source )
328     {
329         this.source = source;
330     } //-- void setSource( String )
331 
332     /**
333      * Set set of absolute or relative paths from the module's
334      * directory
335      *             of the files be combined and included in the
336      * assembly.
337      * 
338      * @param sources
339      */
340     public void setSources( java.util.List<String> sources )
341     {
342         this.sources = sources;
343     } //-- void setSources( java.util.List )
344 
345 }