View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 2.1.2,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.buildcache.xml.config;
7   
8   /**
9    * Class DirScanConfig.
10   * 
11   * @version $Revision$ $Date$
12   */
13  @SuppressWarnings( "all" )
14  public class DirScanConfig
15      implements java.io.Serializable
16  {
17  
18        //--------------------------/
19       //- Class/Member Variables -/
20      //--------------------------/
21  
22      /**
23       * Field includes.
24       */
25      private java.util.List<TagScanConfig> includes;
26  
27      /**
28       * Field excludes.
29       */
30      private java.util.List<TagExclude> excludes;
31  
32      /**
33       * Field tagScanConfigs.
34       */
35      private java.util.List<TagScanConfig> tagScanConfigs;
36  
37      /**
38       * Ignore parent settings or inherit and merge.
39       */
40      private boolean ignoreParent = false;
41  
42      /**
43       * 
44       *                         Either 'auto' (scan directory
45       * accordingly to cache implementation) or 'skip' (skip
46       * directory).
47       *                     
48       */
49      private String mode;
50  
51  
52        //-----------/
53       //- Methods -/
54      //-----------/
55  
56      /**
57       * Method addExclude.
58       * 
59       * @param tagExclude a tagExclude object.
60       */
61      public void addExclude( TagExclude tagExclude )
62      {
63          getExcludes().add( tagExclude );
64      } //-- void addExclude( TagExclude )
65  
66      /**
67       * Method addInclude.
68       * 
69       * @param tagScanConfig a tagScanConfig object.
70       */
71      public void addInclude( TagScanConfig tagScanConfig )
72      {
73          getIncludes().add( tagScanConfig );
74      } //-- void addInclude( TagScanConfig )
75  
76      /**
77       * Method addTagScanConfig.
78       * 
79       * @param tagScanConfig a tagScanConfig object.
80       */
81      public void addTagScanConfig( TagScanConfig tagScanConfig )
82      {
83          getTagScanConfigs().add( tagScanConfig );
84      } //-- void addTagScanConfig( TagScanConfig )
85  
86      /**
87       * Method getExcludes.
88       * 
89       * @return List
90       */
91      public java.util.List<TagExclude> getExcludes()
92      {
93          if ( this.excludes == null )
94          {
95              this.excludes = new java.util.ArrayList<TagExclude>();
96          }
97  
98          return this.excludes;
99      } //-- java.util.List<TagExclude> getExcludes()
100 
101     /**
102      * Method getIncludes.
103      * 
104      * @return List
105      */
106     public java.util.List<TagScanConfig> getIncludes()
107     {
108         if ( this.includes == null )
109         {
110             this.includes = new java.util.ArrayList<TagScanConfig>();
111         }
112 
113         return this.includes;
114     } //-- java.util.List<TagScanConfig> getIncludes()
115 
116     /**
117      * Get either 'auto' (scan directory accordingly to cache
118      * implementation) or 'skip' (skip directory).
119      * 
120      * @return String
121      */
122     public String getMode()
123     {
124         return this.mode;
125     } //-- String getMode()
126 
127     /**
128      * Method getTagScanConfigs.
129      * 
130      * @return List
131      */
132     public java.util.List<TagScanConfig> getTagScanConfigs()
133     {
134         if ( this.tagScanConfigs == null )
135         {
136             this.tagScanConfigs = new java.util.ArrayList<TagScanConfig>();
137         }
138 
139         return this.tagScanConfigs;
140     } //-- java.util.List<TagScanConfig> getTagScanConfigs()
141 
142     /**
143      * Get ignore parent settings or inherit and merge.
144      * 
145      * @return boolean
146      */
147     public boolean isIgnoreParent()
148     {
149         return this.ignoreParent;
150     } //-- boolean isIgnoreParent()
151 
152     /**
153      * Method removeExclude.
154      * 
155      * @param tagExclude a tagExclude object.
156      */
157     public void removeExclude( TagExclude tagExclude )
158     {
159         getExcludes().remove( tagExclude );
160     } //-- void removeExclude( TagExclude )
161 
162     /**
163      * Method removeInclude.
164      * 
165      * @param tagScanConfig a tagScanConfig object.
166      */
167     public void removeInclude( TagScanConfig tagScanConfig )
168     {
169         getIncludes().remove( tagScanConfig );
170     } //-- void removeInclude( TagScanConfig )
171 
172     /**
173      * Method removeTagScanConfig.
174      * 
175      * @param tagScanConfig a tagScanConfig object.
176      */
177     public void removeTagScanConfig( TagScanConfig tagScanConfig )
178     {
179         getTagScanConfigs().remove( tagScanConfig );
180     } //-- void removeTagScanConfig( TagScanConfig )
181 
182     /**
183      * Set tag to exclude when scanning plugin configuration for
184      * input files (blacklist).
185      * 
186      * @param excludes a excludes object.
187      */
188     public void setExcludes( java.util.List<TagExclude> excludes )
189     {
190         this.excludes = excludes;
191     } //-- void setExcludes( java.util.List )
192 
193     /**
194      * Set ignore parent settings or inherit and merge.
195      * 
196      * @param ignoreParent a ignoreParent object.
197      */
198     public void setIgnoreParent( boolean ignoreParent )
199     {
200         this.ignoreParent = ignoreParent;
201     } //-- void setIgnoreParent( boolean )
202 
203     /**
204      * Set forces cache to treat property value as input and
205      * include in calculation. If set, only included
206      *                         properties will be takein in
207      * calculation (whitelist).
208      * 
209      * @param includes a includes object.
210      */
211     public void setIncludes( java.util.List<TagScanConfig> includes )
212     {
213         this.includes = includes;
214     } //-- void setIncludes( java.util.List )
215 
216     /**
217      * Set either 'auto' (scan directory accordingly to cache
218      * implementation) or 'skip' (skip directory).
219      * 
220      * @param mode a mode object.
221      */
222     public void setMode( String mode )
223     {
224         this.mode = mode;
225     } //-- void setMode( String )
226 
227     /**
228      * Set additional processing rules for non-blacklisted tags.
229      * 
230      * @param tagScanConfigs a tagScanConfigs object.
231      */
232     public void setTagScanConfigs( java.util.List<TagScanConfig> tagScanConfigs )
233     {
234         this.tagScanConfigs = tagScanConfigs;
235     } //-- void setTagScanConfigs( java.util.List )
236 
237 }