Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Parameter |
|
| 1.0;1 |
1 | /* | |
2 | =================== DO NOT EDIT THIS FILE ==================== | |
3 | Generated by Modello 1.4.1 on 2012-06-30 12:40:36, | |
4 | any modifications will be overwritten. | |
5 | ============================================================== | |
6 | */ | |
7 | ||
8 | package org.apache.maven.plugin.tools.model; | |
9 | ||
10 | /** | |
11 | * | |
12 | * A parameter used by a mojo, and configurable from the | |
13 | * command line or POM configuration sections. | |
14 | * | |
15 | * | |
16 | * @version $Revision$ $Date$ | |
17 | */ | |
18 | @SuppressWarnings( "all" ) | |
19 | 2 | public class Parameter |
20 | implements java.io.Serializable | |
21 | { | |
22 | ||
23 | //--------------------------/ | |
24 | //- Class/Member Variables -/ | |
25 | //--------------------------/ | |
26 | ||
27 | /** | |
28 | * The parameter name. | |
29 | */ | |
30 | private String name; | |
31 | ||
32 | /** | |
33 | * An alternate name for the parameter. | |
34 | */ | |
35 | private String alias; | |
36 | ||
37 | /** | |
38 | * The JavaBeans property name to use to configure the mojo | |
39 | * with this parameter. | |
40 | */ | |
41 | private String property; | |
42 | ||
43 | /** | |
44 | * Whether this parameter is required. | |
45 | */ | |
46 | 2 | private boolean required = false; |
47 | ||
48 | /** | |
49 | * | |
50 | * Whether this parameter can be directly edited. | |
51 | * If false, this param is either derived from another POM | |
52 | * element, or refers to a runtime instance of the build | |
53 | * system. | |
54 | * | |
55 | */ | |
56 | 2 | private boolean readonly = false; |
57 | ||
58 | /** | |
59 | * | |
60 | * The command-line reference to this parameter. | |
61 | * | |
62 | */ | |
63 | private String expression; | |
64 | ||
65 | /** | |
66 | * | |
67 | * An expression in the form ${instance.property} | |
68 | * for extracting a value for this parameter, especially from | |
69 | * a runtime instance within the build system. (eg. | |
70 | * ${project.build.directory} references | |
71 | * project.getBuild().getDirectory()) | |
72 | * . | |
73 | */ | |
74 | private String defaultValue; | |
75 | ||
76 | /** | |
77 | * | |
78 | * The java type for this parameter. | |
79 | * | |
80 | */ | |
81 | private String type; | |
82 | ||
83 | /** | |
84 | * The description for this parameter. | |
85 | */ | |
86 | private String description; | |
87 | ||
88 | /** | |
89 | * A deprecation message for this mojo parameter. | |
90 | */ | |
91 | private String deprecation; | |
92 | ||
93 | /** | |
94 | * Version when the parameter was added. | |
95 | */ | |
96 | private String since; | |
97 | ||
98 | ||
99 | //-----------/ | |
100 | //- Methods -/ | |
101 | //-----------/ | |
102 | ||
103 | /** | |
104 | * Get an alternate name for the parameter. | |
105 | * | |
106 | * @return String | |
107 | */ | |
108 | public String getAlias() | |
109 | { | |
110 | 2 | return this.alias; |
111 | } //-- String getAlias() | |
112 | ||
113 | /** | |
114 | * Get an expression in the form ${instance.property} for | |
115 | * extracting a value for this parameter, especially from | |
116 | * a runtime instance within the build system. (eg. | |
117 | * ${project.build.directory} references | |
118 | * project.getBuild().getDirectory()). | |
119 | * | |
120 | * @return String | |
121 | */ | |
122 | public String getDefaultValue() | |
123 | { | |
124 | 2 | return this.defaultValue; |
125 | } //-- String getDefaultValue() | |
126 | ||
127 | /** | |
128 | * Get a deprecation message for this mojo parameter. | |
129 | * | |
130 | * @return String | |
131 | */ | |
132 | public String getDeprecation() | |
133 | { | |
134 | 2 | return this.deprecation; |
135 | } //-- String getDeprecation() | |
136 | ||
137 | /** | |
138 | * Get the description for this parameter. | |
139 | * | |
140 | * @return String | |
141 | */ | |
142 | public String getDescription() | |
143 | { | |
144 | 2 | return this.description; |
145 | } //-- String getDescription() | |
146 | ||
147 | /** | |
148 | * Get the command-line reference to this parameter. | |
149 | * | |
150 | * @return String | |
151 | */ | |
152 | public String getExpression() | |
153 | { | |
154 | 2 | return this.expression; |
155 | } //-- String getExpression() | |
156 | ||
157 | /** | |
158 | * Get the parameter name. | |
159 | * | |
160 | * @return String | |
161 | */ | |
162 | public String getName() | |
163 | { | |
164 | 0 | return this.name; |
165 | } //-- String getName() | |
166 | ||
167 | /** | |
168 | * Get the JavaBeans property name to use to configure the mojo | |
169 | * with this parameter. | |
170 | * | |
171 | * @return String | |
172 | */ | |
173 | public String getProperty() | |
174 | { | |
175 | 2 | return this.property; |
176 | } //-- String getProperty() | |
177 | ||
178 | /** | |
179 | * Get version when the parameter was added. | |
180 | * | |
181 | * @return String | |
182 | */ | |
183 | public String getSince() | |
184 | { | |
185 | 0 | return this.since; |
186 | } //-- String getSince() | |
187 | ||
188 | /** | |
189 | * Get the java type for this parameter. | |
190 | * | |
191 | * @return String | |
192 | */ | |
193 | public String getType() | |
194 | { | |
195 | 2 | return this.type; |
196 | } //-- String getType() | |
197 | ||
198 | /** | |
199 | * Get whether this parameter can be directly edited. If false, | |
200 | * this param is either derived from another POM element, or | |
201 | * refers to a runtime instance of the build system. | |
202 | * | |
203 | * @return boolean | |
204 | */ | |
205 | public boolean isReadonly() | |
206 | { | |
207 | 2 | return this.readonly; |
208 | } //-- boolean isReadonly() | |
209 | ||
210 | /** | |
211 | * Get whether this parameter is required. | |
212 | * | |
213 | * @return boolean | |
214 | */ | |
215 | public boolean isRequired() | |
216 | { | |
217 | 2 | return this.required; |
218 | } //-- boolean isRequired() | |
219 | ||
220 | /** | |
221 | * Set an alternate name for the parameter. | |
222 | * | |
223 | * @param alias | |
224 | */ | |
225 | public void setAlias( String alias ) | |
226 | { | |
227 | 0 | this.alias = alias; |
228 | 0 | } //-- void setAlias( String ) |
229 | ||
230 | /** | |
231 | * Set an expression in the form ${instance.property} for | |
232 | * extracting a value for this parameter, especially from | |
233 | * a runtime instance within the build system. (eg. | |
234 | * ${project.build.directory} references | |
235 | * project.getBuild().getDirectory()). | |
236 | * | |
237 | * @param defaultValue | |
238 | */ | |
239 | public void setDefaultValue( String defaultValue ) | |
240 | { | |
241 | 0 | this.defaultValue = defaultValue; |
242 | 0 | } //-- void setDefaultValue( String ) |
243 | ||
244 | /** | |
245 | * Set a deprecation message for this mojo parameter. | |
246 | * | |
247 | * @param deprecation | |
248 | */ | |
249 | public void setDeprecation( String deprecation ) | |
250 | { | |
251 | 0 | this.deprecation = deprecation; |
252 | 0 | } //-- void setDeprecation( String ) |
253 | ||
254 | /** | |
255 | * Set the description for this parameter. | |
256 | * | |
257 | * @param description | |
258 | */ | |
259 | public void setDescription( String description ) | |
260 | { | |
261 | 2 | this.description = description; |
262 | 2 | } //-- void setDescription( String ) |
263 | ||
264 | /** | |
265 | * Set the command-line reference to this parameter. | |
266 | * | |
267 | * @param expression | |
268 | */ | |
269 | public void setExpression( String expression ) | |
270 | { | |
271 | 0 | this.expression = expression; |
272 | 0 | } //-- void setExpression( String ) |
273 | ||
274 | /** | |
275 | * Set the parameter name. | |
276 | * | |
277 | * @param name | |
278 | */ | |
279 | public void setName( String name ) | |
280 | { | |
281 | 2 | this.name = name; |
282 | 2 | } //-- void setName( String ) |
283 | ||
284 | /** | |
285 | * Set the JavaBeans property name to use to configure the mojo | |
286 | * with this parameter. | |
287 | * | |
288 | * @param property | |
289 | */ | |
290 | public void setProperty( String property ) | |
291 | { | |
292 | 2 | this.property = property; |
293 | 2 | } //-- void setProperty( String ) |
294 | ||
295 | /** | |
296 | * Set whether this parameter can be directly edited. If false, | |
297 | * this param is either derived from another POM element, or | |
298 | * refers to a runtime instance of the build system. | |
299 | * | |
300 | * @param readonly | |
301 | */ | |
302 | public void setReadonly( boolean readonly ) | |
303 | { | |
304 | 0 | this.readonly = readonly; |
305 | 0 | } //-- void setReadonly( boolean ) |
306 | ||
307 | /** | |
308 | * Set whether this parameter is required. | |
309 | * | |
310 | * @param required | |
311 | */ | |
312 | public void setRequired( boolean required ) | |
313 | { | |
314 | 2 | this.required = required; |
315 | 2 | } //-- void setRequired( boolean ) |
316 | ||
317 | /** | |
318 | * Set version when the parameter was added. | |
319 | * | |
320 | * @param since | |
321 | */ | |
322 | public void setSince( String since ) | |
323 | { | |
324 | 0 | this.since = since; |
325 | 0 | } //-- void setSince( String ) |
326 | ||
327 | /** | |
328 | * Set the java type for this parameter. | |
329 | * | |
330 | * @param type | |
331 | */ | |
332 | public void setType( String type ) | |
333 | { | |
334 | 2 | this.type = type; |
335 | 2 | } //-- void setType( String ) |
336 | ||
337 | } |