001// =================== DO NOT EDIT THIS FILE ====================
002// Generated by Modello 1.8.1,
003// any modifications will be overwritten.
004// ==============================================================
005
006package org.apache.maven.usability.plugin;
007
008/**
009 * A plugin parameter expression supported by Maven.
010 * 
011 * @version $Revision$ $Date$
012 */
013@SuppressWarnings( "all" )
014public class Expression
015    implements java.io.Serializable
016{
017
018      //--------------------------/
019     //- Class/Member Variables -/
020    //--------------------------/
021
022    /**
023     * The syntax of the expression.
024     */
025    private String syntax;
026
027    /**
028     * The description of what this expression references, and what
029     * it's generally used for.
030     */
031    private String description;
032
033    /**
034     * The place and syntax used to change the value of this
035     * expression.
036     */
037    private String configuration;
038
039    /**
040     * Field cliOptions.
041     */
042    private java.util.Properties cliOptions;
043
044    /**
045     * Field apiMethods.
046     */
047    private java.util.Properties apiMethods;
048
049    /**
050     * A preferred alternative to this expression, in the case
051     * where it's deprecated.
052     */
053    private String deprecation;
054
055    /**
056     * A preferred alternative to this expression, in the case
057     * where it's banned from use.
058     */
059    private String ban;
060
061    /**
062     * Whether the value of this expression can be changed.
063     */
064    private boolean editable = true;
065
066
067      //-----------/
068     //- Methods -/
069    //-----------/
070
071    /**
072     * Method addApiMethod.
073     * 
074     * @param key
075     * @param value
076     */
077    public void addApiMethod( String key, String value )
078    {
079        getApiMethods().put( key, value );
080    } //-- void addApiMethod( String, String )
081
082    /**
083     * Method addCliOption.
084     * 
085     * @param key
086     * @param value
087     */
088    public void addCliOption( String key, String value )
089    {
090        getCliOptions().put( key, value );
091    } //-- void addCliOption( String, String )
092
093    /**
094     * Method getApiMethods.
095     * 
096     * @return Properties
097     */
098    public java.util.Properties getApiMethods()
099    {
100        if ( this.apiMethods == null )
101        {
102            this.apiMethods = new java.util.Properties();
103        }
104
105        return this.apiMethods;
106    } //-- java.util.Properties getApiMethods()
107
108    /**
109     * Get a preferred alternative to this expression, in the case
110     * where it's banned from use.
111     * 
112     * @return String
113     */
114    public String getBan()
115    {
116        return this.ban;
117    } //-- String getBan()
118
119    /**
120     * Method getCliOptions.
121     * 
122     * @return Properties
123     */
124    public java.util.Properties getCliOptions()
125    {
126        if ( this.cliOptions == null )
127        {
128            this.cliOptions = new java.util.Properties();
129        }
130
131        return this.cliOptions;
132    } //-- java.util.Properties getCliOptions()
133
134    /**
135     * Get the place and syntax used to change the value of this
136     * expression.
137     * 
138     * @return String
139     */
140    public String getConfiguration()
141    {
142        return this.configuration;
143    } //-- String getConfiguration()
144
145    /**
146     * Get a preferred alternative to this expression, in the case
147     * where it's deprecated.
148     * 
149     * @return String
150     */
151    public String getDeprecation()
152    {
153        return this.deprecation;
154    } //-- String getDeprecation()
155
156    /**
157     * Get the description of what this expression references, and
158     * what it's generally used for.
159     * 
160     * @return String
161     */
162    public String getDescription()
163    {
164        return this.description;
165    } //-- String getDescription()
166
167    /**
168     * Get the syntax of the expression.
169     * 
170     * @return String
171     */
172    public String getSyntax()
173    {
174        return this.syntax;
175    } //-- String getSyntax()
176
177    /**
178     * Get whether the value of this expression can be changed.
179     * 
180     * @return boolean
181     */
182    public boolean isEditable()
183    {
184        return this.editable;
185    } //-- boolean isEditable()
186
187    /**
188     * Set the programmatic methods used to change the value of
189     * this expression.
190     * 
191     * @param apiMethods
192     */
193    public void setApiMethods( java.util.Properties apiMethods )
194    {
195        this.apiMethods = apiMethods;
196    } //-- void setApiMethods( java.util.Properties )
197
198    /**
199     * Set a preferred alternative to this expression, in the case
200     * where it's banned from use.
201     * 
202     * @param ban
203     */
204    public void setBan( String ban )
205    {
206        this.ban = ban;
207    } //-- void setBan( String )
208
209    /**
210     * Set the command-line switches used to change the value of
211     * this expression.
212     * 
213     * @param cliOptions
214     */
215    public void setCliOptions( java.util.Properties cliOptions )
216    {
217        this.cliOptions = cliOptions;
218    } //-- void setCliOptions( java.util.Properties )
219
220    /**
221     * Set the place and syntax used to change the value of this
222     * expression.
223     * 
224     * @param configuration
225     */
226    public void setConfiguration( String configuration )
227    {
228        this.configuration = configuration;
229    } //-- void setConfiguration( String )
230
231    /**
232     * Set a preferred alternative to this expression, in the case
233     * where it's deprecated.
234     * 
235     * @param deprecation
236     */
237    public void setDeprecation( String deprecation )
238    {
239        this.deprecation = deprecation;
240    } //-- void setDeprecation( String )
241
242    /**
243     * Set the description of what this expression references, and
244     * what it's generally used for.
245     * 
246     * @param description
247     */
248    public void setDescription( String description )
249    {
250        this.description = description;
251    } //-- void setDescription( String )
252
253    /**
254     * Set whether the value of this expression can be changed.
255     * 
256     * @param editable
257     */
258    public void setEditable( boolean editable )
259    {
260        this.editable = editable;
261    } //-- void setEditable( boolean )
262
263    /**
264     * Set the syntax of the expression.
265     * 
266     * @param syntax
267     */
268    public void setSyntax( String syntax )
269    {
270        this.syntax = syntax;
271    } //-- void setSyntax( String )
272
273}