View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.0.1 on 2009-03-28 16:23:33,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.usability.plugin;
9   
10  /**
11   * The root of a parameter plugin expression document.
12   * 
13   * @version $Revision$ $Date$
14   */
15  public class ExpressionDocumentation
16      implements java.io.Serializable
17  {
18  
19        //--------------------------/
20       //- Class/Member Variables -/
21      //--------------------------/
22  
23      /**
24       * Field expressions.
25       */
26      private java.util.List/*<Expression>*/ expressions;
27  
28      /**
29       * Field modelEncoding.
30       */
31      private String modelEncoding = "UTF-8";
32  
33  
34        //-----------/
35       //- Methods -/
36      //-----------/
37  
38      /**
39       * Method addExpression.
40       * 
41       * @param expression
42       */
43      public void addExpression( Expression expression )
44      {
45          if ( !(expression instanceof Expression) )
46          {
47              throw new ClassCastException( "ExpressionDocumentation.addExpressions(expression) parameter must be instanceof " + Expression.class.getName() );
48          }
49          getExpressions().add( expression );
50      } //-- void addExpression( Expression )
51  
52      /**
53       * Method getExpressions.
54       * 
55       * @return List
56       */
57      public java.util.List/*<Expression>*/ getExpressions()
58      {
59          if ( this.expressions == null )
60          {
61              this.expressions = new java.util.ArrayList/*<Expression>*/();
62          }
63  
64          return this.expressions;
65      } //-- java.util.List/*<Expression>*/ getExpressions()
66  
67      /**
68       * Method getModelEncoding.
69       * 
70       * @return the current encoding used when reading/writing this
71       * model
72       */
73      public String getModelEncoding()
74      {
75          return modelEncoding;
76      } //-- String getModelEncoding()
77  
78      /**
79       * Method removeExpression.
80       * 
81       * @param expression
82       */
83      public void removeExpression( Expression expression )
84      {
85          if ( !(expression instanceof Expression) )
86          {
87              throw new ClassCastException( "ExpressionDocumentation.removeExpressions(expression) parameter must be instanceof " + Expression.class.getName() );
88          }
89          getExpressions().remove( expression );
90      } //-- void removeExpression( Expression )
91  
92      /**
93       * Set the list of plugin parameter expressions described by
94       * this
95       *             document.
96       * 
97       * @param expressions
98       */
99      public void setExpressions( java.util.List/*<Expression>*/ expressions )
100     {
101         this.expressions = expressions;
102     } //-- void setExpressions( java.util.List )
103 
104     /**
105      * Set an encoding used for reading/writing the model.
106      * 
107      * @param modelEncoding
108      */
109     public void setModelEncoding( String modelEncoding )
110     {
111         this.modelEncoding = modelEncoding;
112     } //-- void setModelEncoding( String )
113 
114     private java.util.Map expressionsBySyntax;
115 
116     public java.util.Map getExpressionsBySyntax()
117     {
118         if ( expressionsBySyntax == null )
119         {
120             expressionsBySyntax = new java.util.HashMap();
121 
122             java.util.List expressions = getExpressions();
123 
124             if ( expressions != null && !expressions.isEmpty() )
125             {
126                 for ( java.util.Iterator it = expressions.iterator(); it.hasNext(); )
127                 {
128                     Expression expr = (Expression) it.next();
129 
130                     expressionsBySyntax.put( expr.getSyntax(), expr );
131                 }
132             }
133         }
134 
135         return expressionsBySyntax;
136     }
137 
138     public void flushExpressionsBySyntax()
139     {
140         expressionsBySyntax = null;
141     }
142 
143 }