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