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