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