View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.4.1 on 2012-05-28 13:00:07,
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  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      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      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        //-----------/
95       //- Methods -/
96      //-----------/
97  
98      /**
99       * Get an alternate name for the parameter.
100      * 
101      * @return String
102      */
103     public String getAlias()
104     {
105         return this.alias;
106     } //-- String getAlias()
107 
108     /**
109      * Get an expression in the form ${instance.property} for
110      * extracting a value for this parameter, especially from
111      *             a runtime instance within the build system. (eg.
112      * ${project.build.directory} references
113      *             project.getBuild().getDirectory()).
114      * 
115      * @return String
116      */
117     public String getDefaultValue()
118     {
119         return this.defaultValue;
120     } //-- String getDefaultValue()
121 
122     /**
123      * Get a deprecation message for this mojo parameter.
124      * 
125      * @return String
126      */
127     public String getDeprecation()
128     {
129         return this.deprecation;
130     } //-- String getDeprecation()
131 
132     /**
133      * Get the description for this parameter.
134      * 
135      * @return String
136      */
137     public String getDescription()
138     {
139         return this.description;
140     } //-- String getDescription()
141 
142     /**
143      * Get the command-line reference to this parameter.
144      * 
145      * @return String
146      */
147     public String getExpression()
148     {
149         return this.expression;
150     } //-- String getExpression()
151 
152     /**
153      * Get the parameter name.
154      * 
155      * @return String
156      */
157     public String getName()
158     {
159         return this.name;
160     } //-- String getName()
161 
162     /**
163      * Get the JavaBeans property name to use to configure the mojo
164      * with this parameter.
165      * 
166      * @return String
167      */
168     public String getProperty()
169     {
170         return this.property;
171     } //-- String getProperty()
172 
173     /**
174      * Get the java type for this parameter.
175      * 
176      * @return String
177      */
178     public String getType()
179     {
180         return this.type;
181     } //-- String getType()
182 
183     /**
184      * Get whether this parameter can be directly edited. If false,
185      * this param is either derived from another POM element, or
186      * refers to a runtime instance of the build system.
187      * 
188      * @return boolean
189      */
190     public boolean isReadonly()
191     {
192         return this.readonly;
193     } //-- boolean isReadonly()
194 
195     /**
196      * Get whether this parameter is required.
197      * 
198      * @return boolean
199      */
200     public boolean isRequired()
201     {
202         return this.required;
203     } //-- boolean isRequired()
204 
205     /**
206      * Set an alternate name for the parameter.
207      * 
208      * @param alias
209      */
210     public void setAlias( String alias )
211     {
212         this.alias = alias;
213     } //-- void setAlias( String )
214 
215     /**
216      * Set an expression in the form ${instance.property} for
217      * extracting a value for this parameter, especially from
218      *             a runtime instance within the build system. (eg.
219      * ${project.build.directory} references
220      *             project.getBuild().getDirectory()).
221      * 
222      * @param defaultValue
223      */
224     public void setDefaultValue( String defaultValue )
225     {
226         this.defaultValue = defaultValue;
227     } //-- void setDefaultValue( String )
228 
229     /**
230      * Set a deprecation message for this mojo parameter.
231      * 
232      * @param deprecation
233      */
234     public void setDeprecation( String deprecation )
235     {
236         this.deprecation = deprecation;
237     } //-- void setDeprecation( String )
238 
239     /**
240      * Set the description for this parameter.
241      * 
242      * @param description
243      */
244     public void setDescription( String description )
245     {
246         this.description = description;
247     } //-- void setDescription( String )
248 
249     /**
250      * Set the command-line reference to this parameter.
251      * 
252      * @param expression
253      */
254     public void setExpression( String expression )
255     {
256         this.expression = expression;
257     } //-- void setExpression( String )
258 
259     /**
260      * Set the parameter name.
261      * 
262      * @param name
263      */
264     public void setName( String name )
265     {
266         this.name = name;
267     } //-- void setName( String )
268 
269     /**
270      * Set the JavaBeans property name to use to configure the mojo
271      * with this parameter.
272      * 
273      * @param property
274      */
275     public void setProperty( String property )
276     {
277         this.property = property;
278     } //-- void setProperty( String )
279 
280     /**
281      * Set whether this parameter can be directly edited. If false,
282      * this param is either derived from another POM element, or
283      * refers to a runtime instance of the build system.
284      * 
285      * @param readonly
286      */
287     public void setReadonly( boolean readonly )
288     {
289         this.readonly = readonly;
290     } //-- void setReadonly( boolean )
291 
292     /**
293      * Set whether this parameter is required.
294      * 
295      * @param required
296      */
297     public void setRequired( boolean required )
298     {
299         this.required = required;
300     } //-- void setRequired( boolean )
301 
302     /**
303      * Set the java type for this parameter.
304      * 
305      * @param type
306      */
307     public void setType( String type )
308     {
309         this.type = type;
310     } //-- void setType( String )
311 
312 }