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