View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 2.0.0,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.shared.model.fileset;
7   
8   /**
9    * Class SetBase.
10   * 
11   * @version $Revision$ $Date$
12   */
13  @SuppressWarnings( "all" )
14  public class SetBase
15      implements java.io.Serializable
16  {
17  
18        //--------------------------/
19       //- Class/Member Variables -/
20      //--------------------------/
21  
22      /**
23       * 
24       *             Specifies whether symbolic links should be
25       * traversed, or handled as-is.
26       *           
27       */
28      private boolean followSymlinks = false;
29  
30      /**
31       * 
32       *             Specifies the output directory relative to the
33       * root
34       *             of the root directory of the assembly.  For
35       * example,
36       *             "log" will put the specified files in the log
37       * directory.
38       *           
39       */
40      private String outputDirectory;
41  
42      /**
43       * 
44       *             Whether to include exclusion patterns for common
45       * temporary and SCM control
46       *             files (true by default).
47       *           
48       */
49      private boolean useDefaultExcludes = true;
50  
51      /**
52       * Field includes.
53       */
54      private java.util.List<String> includes;
55  
56      /**
57       * Field excludes.
58       */
59      private java.util.List<String> excludes;
60  
61      /**
62       * 
63       *             
64       *             Similar to a UNIX permission.  Format:
65       * (User)(Group)(Other) where each
66       *             component is a sum of Read = 4, Write = 2, and
67       * Execute = 1.  For example,
68       *             the default value of 0644 translates to User
69       * read-write, Group and Other
70       *             read-only.
71       *             <a
72       * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
73       * on unix-style
74       *             permissions)</a>
75       *             
76       *           
77       */
78      private String fileMode = "0644";
79  
80      /**
81       * 
82       *             
83       *             Similar to a UNIX permission.  Format:
84       * (User)(Group)(Other) where each
85       *             component is a sum of Read = 4, Write = 2, and
86       * Execute = 1.  For example,
87       *             the default value of 0755 translates to User
88       * read-write, Group and Other
89       *             read-only.
90       *             <a
91       * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
92       * on unix-style
93       *             permissions)</a>
94       *             
95       *           
96       */
97      private String directoryMode = "0755";
98  
99      /**
100      * 
101      *             Specifies the mapper used.
102      *           
103      */
104     private Mapper mapper = new Mapper();
105 
106 
107       //-----------/
108      //- Methods -/
109     //-----------/
110 
111     /**
112      * Method addExclude.
113      * 
114      * @param string a string object.
115      */
116     public void addExclude( String string )
117     {
118         getExcludes().add( string );
119     } //-- void addExclude( String )
120 
121     /**
122      * Method addInclude.
123      * 
124      * @param string a string object.
125      */
126     public void addInclude( String string )
127     {
128         getIncludes().add( string );
129     } //-- void addInclude( String )
130 
131     /**
132      * Get similar to a UNIX permission.  Format:
133      * (User)(Group)(Other) where each
134      *             component is a sum of Read = 4, Write = 2, and
135      * Execute = 1.  For example,
136      *             the default value of 0755 translates to User
137      * read-write, Group and Other
138      *             read-only.
139      *             <a
140      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
141      * on unix-style
142      *             permissions)</a>
143      * 
144      * @return String
145      */
146     public String getDirectoryMode()
147     {
148         return this.directoryMode;
149     } //-- String getDirectoryMode()
150 
151     /**
152      * Method getExcludes.
153      * 
154      * @return List
155      */
156     public java.util.List<String> getExcludes()
157     {
158         if ( this.excludes == null )
159         {
160             this.excludes = new java.util.ArrayList<String>();
161         }
162 
163         return this.excludes;
164     } //-- java.util.List<String> getExcludes()
165 
166     /**
167      * Get similar to a UNIX permission.  Format:
168      * (User)(Group)(Other) where each
169      *             component is a sum of Read = 4, Write = 2, and
170      * Execute = 1.  For example,
171      *             the default value of 0644 translates to User
172      * read-write, Group and Other
173      *             read-only.
174      *             <a
175      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
176      * on unix-style
177      *             permissions)</a>
178      * 
179      * @return String
180      */
181     public String getFileMode()
182     {
183         return this.fileMode;
184     } //-- String getFileMode()
185 
186     /**
187      * Method getIncludes.
188      * 
189      * @return List
190      */
191     public java.util.List<String> getIncludes()
192     {
193         if ( this.includes == null )
194         {
195             this.includes = new java.util.ArrayList<String>();
196         }
197 
198         return this.includes;
199     } //-- java.util.List<String> getIncludes()
200 
201     /**
202      * Get specifies the mapper used.
203      * 
204      * @return Mapper
205      */
206     public Mapper getMapper()
207     {
208         return this.mapper;
209     } //-- Mapper getMapper()
210 
211     /**
212      * Get specifies the output directory relative to the root
213      *             of the root directory of the assembly.  For
214      * example,
215      *             "log" will put the specified files in the log
216      * directory.
217      * 
218      * @return String
219      */
220     public String getOutputDirectory()
221     {
222         return this.outputDirectory;
223     } //-- String getOutputDirectory()
224 
225     /**
226      * Get specifies whether symbolic links should be traversed, or
227      * handled as-is.
228      * 
229      * @return boolean
230      */
231     public boolean isFollowSymlinks()
232     {
233         return this.followSymlinks;
234     } //-- boolean isFollowSymlinks()
235 
236     /**
237      * Get whether to include exclusion patterns for common
238      * temporary and SCM control
239      *             files (true by default).
240      * 
241      * @return boolean
242      */
243     public boolean isUseDefaultExcludes()
244     {
245         return this.useDefaultExcludes;
246     } //-- boolean isUseDefaultExcludes()
247 
248     /**
249      * Method removeExclude.
250      * 
251      * @param string a string object.
252      */
253     public void removeExclude( String string )
254     {
255         getExcludes().remove( string );
256     } //-- void removeExclude( String )
257 
258     /**
259      * Method removeInclude.
260      * 
261      * @param string a string object.
262      */
263     public void removeInclude( String string )
264     {
265         getIncludes().remove( string );
266     } //-- void removeInclude( String )
267 
268     /**
269      * Set similar to a UNIX permission.  Format:
270      * (User)(Group)(Other) where each
271      *             component is a sum of Read = 4, Write = 2, and
272      * Execute = 1.  For example,
273      *             the default value of 0755 translates to User
274      * read-write, Group and Other
275      *             read-only.
276      *             <a
277      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
278      * on unix-style
279      *             permissions)</a>
280      * 
281      * @param directoryMode a directoryMode object.
282      */
283     public void setDirectoryMode( String directoryMode )
284     {
285         this.directoryMode = directoryMode;
286     } //-- void setDirectoryMode( String )
287 
288     /**
289      * Set when &lt;exclude&gt; subelements are present, they
290      * define
291      *             a set of files and directory to exclude.
292      * 
293      * @param excludes a excludes object.
294      */
295     public void setExcludes( java.util.List<String> excludes )
296     {
297         this.excludes = excludes;
298     } //-- void setExcludes( java.util.List )
299 
300     /**
301      * Set similar to a UNIX permission.  Format:
302      * (User)(Group)(Other) where each
303      *             component is a sum of Read = 4, Write = 2, and
304      * Execute = 1.  For example,
305      *             the default value of 0644 translates to User
306      * read-write, Group and Other
307      *             read-only.
308      *             <a
309      * href="http://www.onlamp.com/pub/a/bsd/2000/09/06/FreeBSD_Basics.html">(more
310      * on unix-style
311      *             permissions)</a>
312      * 
313      * @param fileMode a fileMode object.
314      */
315     public void setFileMode( String fileMode )
316     {
317         this.fileMode = fileMode;
318     } //-- void setFileMode( String )
319 
320     /**
321      * Set specifies whether symbolic links should be traversed, or
322      * handled as-is.
323      * 
324      * @param followSymlinks a followSymlinks object.
325      */
326     public void setFollowSymlinks( boolean followSymlinks )
327     {
328         this.followSymlinks = followSymlinks;
329     } //-- void setFollowSymlinks( boolean )
330 
331     /**
332      * Set when &lt;include&gt; subelements are present, they
333      * define
334      *             a set of files and directory to include.
335      * 
336      * @param includes a includes object.
337      */
338     public void setIncludes( java.util.List<String> includes )
339     {
340         this.includes = includes;
341     } //-- void setIncludes( java.util.List )
342 
343     /**
344      * Set specifies the mapper used.
345      * 
346      * @param mapper a mapper object.
347      */
348     public void setMapper( Mapper mapper )
349     {
350         this.mapper = mapper;
351     } //-- void setMapper( Mapper )
352 
353     /**
354      * Set specifies the output directory relative to the root
355      *             of the root directory of the assembly.  For
356      * example,
357      *             "log" will put the specified files in the log
358      * directory.
359      * 
360      * @param outputDirectory a outputDirectory object.
361      */
362     public void setOutputDirectory( String outputDirectory )
363     {
364         this.outputDirectory = outputDirectory;
365     } //-- void setOutputDirectory( String )
366 
367     /**
368      * Set whether to include exclusion patterns for common
369      * temporary and SCM control
370      *             files (true by default).
371      * 
372      * @param useDefaultExcludes a useDefaultExcludes object.
373      */
374     public void setUseDefaultExcludes( boolean useDefaultExcludes )
375     {
376         this.useDefaultExcludes = useDefaultExcludes;
377     } //-- void setUseDefaultExcludes( boolean )
378 
379     
380     /**
381      * @return the file-set inclusion rules in array form.
382      */
383     public String[] getIncludesArray()
384     {
385         String[] includesArry = null;
386         java.util.List<String> includes = getIncludes();
387         if ( includes != null && !includes.isEmpty() )
388         {
389             includesArry = (String[]) includes.toArray( new String[0] );
390         }
391         else if ( includes != null )
392         {
393             includesArry = new String[0];
394         }
395 
396         return includesArry;
397     }
398 
399     /**
400      * @return the file-set exclusion rules in array form.
401      */
402     public String[] getExcludesArray()
403     {
404         String[] excludesArry = null;
405         java.util.List<String> excludes = getExcludes();
406         if ( excludes != null && !excludes.isEmpty() )
407         {
408             excludesArry = (String[]) excludes.toArray( new String[0] );
409         }
410         else if ( excludes != null )
411         {
412             excludesArry = new String[0];
413         }
414 
415         return excludesArry;
416     }
417 
418           
419 }