1/*2 =================== DO NOT EDIT THIS FILE ====================3 Generated by Modello 1.4.1 on 2012-01-20 18:05:12,4 any modifications will be overwritten.5 ==============================================================6 */78package org.apache.maven.plugin.descriptor.model;
910/**11 * A phase mapping definition.12 * 13 * @version $Revision$ $Date$14 */15 @SuppressWarnings( "all" )
16publicclassParameter17implements java.io.Serializable
18 {
1920//--------------------------/21//- Class/Member Variables -/22//--------------------------/2324/**25 * 26 * The name of the parameter, to be used in27 * configuring this parameter from the Mojo's declared defaults28 * or from the POM.29 * 30 */31private String name;
3233/**34 * 35 * Specifies an alias which can be used to36 * configure this parameter from the POM.37 * This is primarily useful to improve38 * user-friendliness, where Mojo field names are not intuitive39 * to the40 * user or are otherwise not conducive to41 * configuration via the POM.42 * 43 */44private String alias;
4546/**47 * 48 * The Java type for this parameter. This is used49 * to validate the result of any expressions used to calculate50 * the value which should be injected into the Mojo51 * for this parameter.52 * 53 */54private String type;
5556/**57 * 58 * Whether this parameter is required for the Mojo59 * to function. This is used to validate the configuration60 * for a Mojo before it is injected, and before the61 * Mojo is executed from some half-state.62 * 63 */64privateboolean required = false;
6566/**67 * 68 * Specifies that this parameter cannot be69 * configured directly by the user (as in the case of70 * POM-specified71 * configuration). This is useful when you want to72 * force the user to use common POM elements rather than73 * plugin configurations, as in the case where you74 * want to use the artifact's final name as a parameter. In75 * this case, you want the user to modify76 * <code>&lt;build&gt;&lt;finalName/&gt;&lt;/build&gt;</code>77 * rather78 * than specifying a value for finalName directly79 * in the plugin configuration section. It is also useful to80 * ensure that - for example - a List-typed81 * parameter which expects items of type Artifact doesn't get a82 * List83 * full of Strings.84 * 85 */86privateboolean editable = true;
8788/**89 * Field implementation.90 */91private String implementation;
9293/**94 * The description of this parameter's use inside the Mojo.95 */96private String description;
9798/**99 * Specify the version when the parameter was added to the API.100 * Similar to Javadoc since.101 */102private String since;
103104/**105 * 106 * Specify the version when the parameter was107 * deprecated to the API. Similar to Javadoc deprecated.108 * This will trigger a warning when a user tries to109 * configure a parameter marked as deprecated.110 * 111 */112private String deprecated;
113114115//-----------/116//- Methods -/117//-----------/118119/**120 * Get specifies an alias which can be used to configure this121 * parameter from the POM.122 * This is primarily useful to improve123 * user-friendliness, where Mojo field names are not intuitive124 * to the125 * user or are otherwise not conducive to126 * configuration via the POM.127 * 128 * @return String129 */130public String getAlias()
131 {
132returnthis.alias;
133 } //-- String getAlias()134135/**136 * Get specify the version when the parameter was deprecated to137 * the API. Similar to Javadoc deprecated.138 * This will trigger a warning when a user tries to139 * configure a parameter marked as deprecated.140 * 141 * @return String142 */143public String getDeprecated()
144 {
145returnthis.deprecated;
146 } //-- String getDeprecated()147148/**149 * Get the description of this parameter's use inside the Mojo.150 * 151 * @return String152 */153public String getDescription()
154 {
155returnthis.description;
156 } //-- String getDescription()157158/**159 * Get the implementation field.160 * 161 * @return String162 */163public String getImplementation()
164 {
165returnthis.implementation;
166 } //-- String getImplementation()167168/**169 * Get the name of the parameter, to be used in configuring170 * this parameter from the Mojo's declared defaults171 * or from the POM.172 * 173 * @return String174 */175public String getName()
176 {
177returnthis.name;
178 } //-- String getName()179180/**181 * Get specify the version when the parameter was added to the182 * API. Similar to Javadoc since.183 * 184 * @return String185 */186public String getSince()
187 {
188returnthis.since;
189 } //-- String getSince()190191/**192 * Get the Java type for this parameter. This is used to193 * validate the result of any expressions used to calculate194 * the value which should be injected into the Mojo195 * for this parameter.196 * 197 * @return String198 */199public String getType()
200 {
201returnthis.type;
202 } //-- String getType()203204/**205 * Get specifies that this parameter cannot be configured206 * directly by the user (as in the case of POM-specified207 * configuration). This is useful when you want to208 * force the user to use common POM elements rather than209 * plugin configurations, as in the case where you210 * want to use the artifact's final name as a parameter. In211 * this case, you want the user to modify212 * <code>&lt;build&gt;&lt;finalName/&gt;&lt;/build&gt;</code>213 * rather214 * than specifying a value for finalName directly215 * in the plugin configuration section. It is also useful to216 * ensure that - for example - a List-typed217 * parameter which expects items of type Artifact doesn't get a218 * List219 * full of Strings.220 * 221 * @return boolean222 */223publicboolean isEditable()
224 {
225returnthis.editable;
226 } //-- boolean isEditable()227228/**229 * Get whether this parameter is required for the Mojo to230 * function. This is used to validate the configuration231 * for a Mojo before it is injected, and before the232 * Mojo is executed from some half-state.233 * 234 * @return boolean235 */236publicboolean isRequired()
237 {
238returnthis.required;
239 } //-- boolean isRequired()240241/**242 * Set specifies an alias which can be used to configure this243 * parameter from the POM.244 * This is primarily useful to improve245 * user-friendliness, where Mojo field names are not intuitive246 * to the247 * user or are otherwise not conducive to248 * configuration via the POM.249 * 250 * @param alias251 */252publicvoid setAlias( String alias )
253 {
254this.alias = alias;
255 } //-- void setAlias( String )256257/**258 * Set specify the version when the parameter was deprecated to259 * the API. Similar to Javadoc deprecated.260 * This will trigger a warning when a user tries to261 * configure a parameter marked as deprecated.262 * 263 * @param deprecated264 */265publicvoid setDeprecated( String deprecated )
266 {
267this.deprecated = deprecated;
268 } //-- void setDeprecated( String )269270/**271 * Set the description of this parameter's use inside the Mojo.272 * 273 * @param description274 */275publicvoid setDescription( String description )
276 {
277this.description = description;
278 } //-- void setDescription( String )279280/**281 * Set specifies that this parameter cannot be configured282 * directly by the user (as in the case of POM-specified283 * configuration). This is useful when you want to284 * force the user to use common POM elements rather than285 * plugin configurations, as in the case where you286 * want to use the artifact's final name as a parameter. In287 * this case, you want the user to modify288 * <code>&lt;build&gt;&lt;finalName/&gt;&lt;/build&gt;</code>289 * rather290 * than specifying a value for finalName directly291 * in the plugin configuration section. It is also useful to292 * ensure that - for example - a List-typed293 * parameter which expects items of type Artifact doesn't get a294 * List295 * full of Strings.296 * 297 * @param editable298 */299publicvoid setEditable( boolean editable )
300 {
301this.editable = editable;
302 } //-- void setEditable( boolean )303304/**305 * Set the implementation field.306 * 307 * @param implementation308 */309publicvoid setImplementation( String implementation )
310 {
311this.implementation = implementation;
312 } //-- void setImplementation( String )313314/**315 * Set the name of the parameter, to be used in configuring316 * this parameter from the Mojo's declared defaults317 * or from the POM.318 * 319 * @param name320 */321publicvoid setName( String name )
322 {
323this.name = name;
324 } //-- void setName( String )325326/**327 * Set whether this parameter is required for the Mojo to328 * function. This is used to validate the configuration329 * for a Mojo before it is injected, and before the330 * Mojo is executed from some half-state.331 * 332 * @param required333 */334publicvoid setRequired( boolean required )
335 {
336this.required = required;
337 } //-- void setRequired( boolean )338339/**340 * Set specify the version when the parameter was added to the341 * API. Similar to Javadoc since.342 * 343 * @param since344 */345publicvoid setSince( String since )
346 {
347this.since = since;
348 } //-- void setSince( String )349350/**351 * Set the Java type for this parameter. This is used to352 * validate the result of any expressions used to calculate353 * the value which should be injected into the Mojo354 * for this parameter.355 * 356 * @param type357 */358publicvoid setType( String type )
359 {
360this.type = type;
361 } //-- void setType( String )362363 }