1 /*
2 Licensed to the Apache Software Foundation (ASF) under one
3 or more contributor license agreements. See the NOTICE file
4 distributed with this work for additional information
5 regarding copyright ownership. The ASF licenses this file
6 to you under the Apache License, Version 2.0 (the
7 "License"); you may not use this file except in compliance
8 with the License. You may obtain a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12 Unless required by applicable law or agreed to in writing,
13 software distributed under the License is distributed on an
14 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 KIND, either express or implied. See the License for the
16 specific language governing permissions and limitations
17 under the License.
18 =================== DO NOT EDIT THIS FILE ====================
19 Generated by Modello 2.4.0,
20 any modifications will be overwritten.
21 ==============================================================
22 */
23
24 package org.apache.maven.usability.plugin;
25
26 /**
27 * A plugin parameter expression supported by Maven.
28 *
29 * @version $Revision$ $Date$
30 */
31 @SuppressWarnings( "all" )
32 public class Expression
33 implements java.io.Serializable
34 {
35
36 //--------------------------/
37 //- Class/Member Variables -/
38 //--------------------------/
39
40 /**
41 * The syntax of the expression.
42 */
43 private String syntax;
44
45 /**
46 * The description of what this expression references, and what
47 * it's generally used for.
48 */
49 private String description;
50
51 /**
52 * The place and syntax used to change the value of this
53 * expression.
54 */
55 private String configuration;
56
57 /**
58 * Field cliOptions.
59 */
60 private java.util.Properties cliOptions;
61
62 /**
63 * Field apiMethods.
64 */
65 private java.util.Properties apiMethods;
66
67 /**
68 * A preferred alternative to this expression, in the case
69 * where it's deprecated.
70 */
71 private String deprecation;
72
73 /**
74 * A preferred alternative to this expression, in the case
75 * where it's banned from use.
76 */
77 private String ban;
78
79 /**
80 * Whether the value of this expression can be changed.
81 */
82 private boolean editable = true;
83
84
85 //-----------/
86 //- Methods -/
87 //-----------/
88
89 /**
90 * Method addApiMethod.
91 *
92 * @param key a key object.
93 * @param value a value object.
94 */
95 public void addApiMethod( String key, String value )
96 {
97 getApiMethods().put( key, value );
98 } //-- void addApiMethod( String, String )
99
100 /**
101 * Method addCliOption.
102 *
103 * @param key a key object.
104 * @param value a value object.
105 */
106 public void addCliOption( String key, String value )
107 {
108 getCliOptions().put( key, value );
109 } //-- void addCliOption( String, String )
110
111 /**
112 * Method getApiMethods.
113 *
114 * @return Properties
115 */
116 public java.util.Properties getApiMethods()
117 {
118 if ( this.apiMethods == null )
119 {
120 this.apiMethods = new java.util.Properties();
121 }
122
123 return this.apiMethods;
124 } //-- java.util.Properties getApiMethods()
125
126 /**
127 * Get a preferred alternative to this expression, in the case
128 * where it's banned from use.
129 *
130 * @return String
131 */
132 public String getBan()
133 {
134 return this.ban;
135 } //-- String getBan()
136
137 /**
138 * Method getCliOptions.
139 *
140 * @return Properties
141 */
142 public java.util.Properties getCliOptions()
143 {
144 if ( this.cliOptions == null )
145 {
146 this.cliOptions = new java.util.Properties();
147 }
148
149 return this.cliOptions;
150 } //-- java.util.Properties getCliOptions()
151
152 /**
153 * Get the place and syntax used to change the value of this
154 * expression.
155 *
156 * @return String
157 */
158 public String getConfiguration()
159 {
160 return this.configuration;
161 } //-- String getConfiguration()
162
163 /**
164 * Get a preferred alternative to this expression, in the case
165 * where it's deprecated.
166 *
167 * @return String
168 */
169 public String getDeprecation()
170 {
171 return this.deprecation;
172 } //-- String getDeprecation()
173
174 /**
175 * Get the description of what this expression references, and
176 * what it's generally used for.
177 *
178 * @return String
179 */
180 public String getDescription()
181 {
182 return this.description;
183 } //-- String getDescription()
184
185 /**
186 * Get the syntax of the expression.
187 *
188 * @return String
189 */
190 public String getSyntax()
191 {
192 return this.syntax;
193 } //-- String getSyntax()
194
195 /**
196 * Get whether the value of this expression can be changed.
197 *
198 * @return boolean
199 */
200 public boolean isEditable()
201 {
202 return this.editable;
203 } //-- boolean isEditable()
204
205 /**
206 * Set the programmatic methods used to change the value of
207 * this expression.
208 *
209 * @param apiMethods a apiMethods object.
210 */
211 public void setApiMethods( java.util.Properties apiMethods )
212 {
213 this.apiMethods = apiMethods;
214 } //-- void setApiMethods( java.util.Properties )
215
216 /**
217 * Set a preferred alternative to this expression, in the case
218 * where it's banned from use.
219 *
220 * @param ban a ban object.
221 */
222 public void setBan( String ban )
223 {
224 this.ban = ban;
225 } //-- void setBan( String )
226
227 /**
228 * Set the command-line switches used to change the value of
229 * this expression.
230 *
231 * @param cliOptions a cliOptions object.
232 */
233 public void setCliOptions( java.util.Properties cliOptions )
234 {
235 this.cliOptions = cliOptions;
236 } //-- void setCliOptions( java.util.Properties )
237
238 /**
239 * Set the place and syntax used to change the value of this
240 * expression.
241 *
242 * @param configuration a configuration object.
243 */
244 public void setConfiguration( String configuration )
245 {
246 this.configuration = configuration;
247 } //-- void setConfiguration( String )
248
249 /**
250 * Set a preferred alternative to this expression, in the case
251 * where it's deprecated.
252 *
253 * @param deprecation a deprecation object.
254 */
255 public void setDeprecation( String deprecation )
256 {
257 this.deprecation = deprecation;
258 } //-- void setDeprecation( String )
259
260 /**
261 * Set the description of what this expression references, and
262 * what it's generally used for.
263 *
264 * @param description a description object.
265 */
266 public void setDescription( String description )
267 {
268 this.description = description;
269 } //-- void setDescription( String )
270
271 /**
272 * Set whether the value of this expression can be changed.
273 *
274 * @param editable a editable object.
275 */
276 public void setEditable( boolean editable )
277 {
278 this.editable = editable;
279 } //-- void setEditable( boolean )
280
281 /**
282 * Set the syntax of the expression.
283 *
284 * @param syntax a syntax object.
285 */
286 public void setSyntax( String syntax )
287 {
288 this.syntax = syntax;
289 } //-- void setSyntax( String )
290
291 }