1 /*
2 =================== DO NOT EDIT THIS FILE ====================
3 Generated by Modello 1.4.1 on 2011-11-29 12:00:52,
4 any modifications will be overwritten.
5 ==============================================================
6 */
7
8 package org.apache.maven.plugin.assembly.model;
9
10 /**
11 *
12 *
13 * A moduleSet represent one or more project <module>
14 * present inside
15 * a project's pom.xml. This allows you to include sources
16 * or binaries
17 * belonging to a project's <modules>.
18 *
19 * <br/><b>NOTE:</b> When using <moduleSets> from the
20 * command-line, it
21 * is required to pass first the package phase by doing:
22 * "mvn package
23 * assembly:assembly". This bug/issue is scheduled to be
24 * addressed by Maven 2.1.
25 *
26 *
27 *
28 * @version $Revision$ $Date$
29 */
30 @SuppressWarnings( "all" )
31 public class ModuleSet
32 implements java.io.Serializable
33 {
34
35 //--------------------------/
36 //- Class/Member Variables -/
37 //--------------------------/
38
39 /**
40 *
41 * If set to true, the plugin will include all
42 * projects in the current reactor for processing
43 * in this ModuleSet. These will be subject to
44 * include/exclude rules.
45 * Default value is true. (Since 2.2)
46 * .
47 */
48 private boolean useAllReactorProjects = false;
49
50 /**
51 *
52 * If set to false, the plugin will exclude
53 * sub-modules from processing in this ModuleSet.
54 * Otherwise, it will process all sub-modules, each
55 * subject to include/exclude rules.
56 * Default value is true. (Since 2.2)
57 * .
58 */
59 private boolean includeSubModules = true;
60
61 /**
62 * Field includes.
63 */
64 private java.util.List<String> includes;
65
66 /**
67 * Field excludes.
68 */
69 private java.util.List<String> excludes;
70
71 /**
72 *
73 * When this is present, the plugin will include
74 * the source files of
75 * the included modules from this set in the
76 * resulting assembly.
77 *
78 */
79 private ModuleSources sources;
80
81 /**
82 *
83 * When this is present, the plugin will include
84 * the binaries of the
85 * included modules from this set in the resulting
86 * assembly.
87 *
88 */
89 private ModuleBinaries binaries;
90
91
92 //-----------/
93 //- Methods -/
94 //-----------/
95
96 /**
97 * Method addExclude.
98 *
99 * @param string
100 */
101 public void addExclude( String string )
102 {
103 getExcludes().add( string );
104 } //-- void addExclude( String )
105
106 /**
107 * Method addInclude.
108 *
109 * @param string
110 */
111 public void addInclude( String string )
112 {
113 getIncludes().add( string );
114 } //-- void addInclude( String )
115
116 /**
117 * Get when this is present, the plugin will include the
118 * binaries of the
119 * included modules from this set in the resulting
120 * assembly.
121 *
122 * @return ModuleBinaries
123 */
124 public ModuleBinaries getBinaries()
125 {
126 return this.binaries;
127 } //-- ModuleBinaries getBinaries()
128
129 /**
130 * Method getExcludes.
131 *
132 * @return List
133 */
134 public java.util.List<String> getExcludes()
135 {
136 if ( this.excludes == null )
137 {
138 this.excludes = new java.util.ArrayList<String>();
139 }
140
141 return this.excludes;
142 } //-- java.util.List<String> getExcludes()
143
144 /**
145 * Method getIncludes.
146 *
147 * @return List
148 */
149 public java.util.List<String> getIncludes()
150 {
151 if ( this.includes == null )
152 {
153 this.includes = new java.util.ArrayList<String>();
154 }
155
156 return this.includes;
157 } //-- java.util.List<String> getIncludes()
158
159 /**
160 * Get when this is present, the plugin will include the source
161 * files of
162 * the included modules from this set in the
163 * resulting assembly.
164 *
165 * @return ModuleSources
166 */
167 public ModuleSources getSources()
168 {
169 return this.sources;
170 } //-- ModuleSources getSources()
171
172 /**
173 * Get if set to false, the plugin will exclude sub-modules
174 * from processing in this ModuleSet.
175 * Otherwise, it will process all sub-modules, each
176 * subject to include/exclude rules.
177 * Default value is true. (Since 2.2).
178 *
179 * @return boolean
180 */
181 public boolean isIncludeSubModules()
182 {
183 return this.includeSubModules;
184 } //-- boolean isIncludeSubModules()
185
186 /**
187 * Get if set to true, the plugin will include all projects in
188 * the current reactor for processing
189 * in this ModuleSet. These will be subject to
190 * include/exclude rules.
191 * Default value is true. (Since 2.2).
192 *
193 * @return boolean
194 */
195 public boolean isUseAllReactorProjects()
196 {
197 return this.useAllReactorProjects;
198 } //-- boolean isUseAllReactorProjects()
199
200 /**
201 * Method removeExclude.
202 *
203 * @param string
204 */
205 public void removeExclude( String string )
206 {
207 getExcludes().remove( string );
208 } //-- void removeExclude( String )
209
210 /**
211 * Method removeInclude.
212 *
213 * @param string
214 */
215 public void removeInclude( String string )
216 {
217 getIncludes().remove( string );
218 } //-- void removeInclude( String )
219
220 /**
221 * Set when this is present, the plugin will include the
222 * binaries of the
223 * included modules from this set in the resulting
224 * assembly.
225 *
226 * @param binaries
227 */
228 public void setBinaries( ModuleBinaries binaries )
229 {
230 this.binaries = binaries;
231 } //-- void setBinaries( ModuleBinaries )
232
233 /**
234 * Set when <exclude> subelements are present, they
235 * define a set of
236 * project artifact coordinates to exclude. If none
237 * is present, then
238 * <excludes> represents no exclusions.
239 *
240 * Artifact coordinatess may be given in simple
241 * groupId:artifactId form,
242 * or they may be fully qualified in the form
243 * groupId:artifactId:type:version[:classifier].
244 * Additionally, wildcards can be used, as in
245 * *:maven-*.
246 *
247 * @param excludes
248 */
249 public void setExcludes( java.util.List<String> excludes )
250 {
251 this.excludes = excludes;
252 } //-- void setExcludes( java.util.List )
253
254 /**
255 * Set if set to false, the plugin will exclude sub-modules
256 * from processing in this ModuleSet.
257 * Otherwise, it will process all sub-modules, each
258 * subject to include/exclude rules.
259 * Default value is true. (Since 2.2).
260 *
261 * @param includeSubModules
262 */
263 public void setIncludeSubModules( boolean includeSubModules )
264 {
265 this.includeSubModules = includeSubModules;
266 } //-- void setIncludeSubModules( boolean )
267
268 /**
269 * Set when <include> subelements are present, they
270 * define a set of
271 * project coordinates to include. If none is
272 * present, then
273 * <includes> represents all valid values.
274 *
275 * Artifact coordinatess may be given in simple
276 * groupId:artifactId form,
277 * or they may be fully qualified in the form
278 * groupId:artifactId:type:version[:classifier].
279 * Additionally, wildcards can be used, as in
280 * *:maven-*.
281 *
282 * @param includes
283 */
284 public void setIncludes( java.util.List<String> includes )
285 {
286 this.includes = includes;
287 } //-- void setIncludes( java.util.List )
288
289 /**
290 * Set when this is present, the plugin will include the source
291 * files of
292 * the included modules from this set in the
293 * resulting assembly.
294 *
295 * @param sources
296 */
297 public void setSources( ModuleSources sources )
298 {
299 this.sources = sources;
300 } //-- void setSources( ModuleSources )
301
302 /**
303 * Set if set to true, the plugin will include all projects in
304 * the current reactor for processing
305 * in this ModuleSet. These will be subject to
306 * include/exclude rules.
307 * Default value is true. (Since 2.2).
308 *
309 * @param useAllReactorProjects
310 */
311 public void setUseAllReactorProjects( boolean useAllReactorProjects )
312 {
313 this.useAllReactorProjects = useAllReactorProjects;
314 } //-- void setUseAllReactorProjects( boolean )
315
316 }