1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.velocity;
24  
25  import com.liferay.portal.kernel.util.Validator;
26  
27  import java.io.StringWriter;
28  
29  import java.util.Iterator;
30  import java.util.Map;
31  
32  import org.apache.velocity.VelocityContext;
33  import org.apache.velocity.app.Velocity;
34  
35  /**
36   * <a href="VelocityUtil.java.html"><b><i>View Source</i></b></a>
37   *
38   * @author Brian Wing Shun Chan
39   *
40   */
41  public class VelocityUtil {
42  
43      public static String evaluate(String input) throws Exception {
44          return evaluate(input, null);
45      }
46  
47      public static String evaluate(String input, Map<String, Object> variables)
48          throws Exception {
49  
50          Velocity.init();
51  
52          VelocityContext vc = new VelocityContext();
53  
54          if (variables != null) {
55              Iterator<Map.Entry<String, Object>> itr =
56                  variables.entrySet().iterator();
57  
58              while (itr.hasNext()) {
59                  Map.Entry<String, Object> entry = itr.next();
60  
61                  String key = entry.getKey();
62                  Object value = entry.getValue();
63  
64                  if (Validator.isNotNull(key)) {
65                      vc.put(key, value);
66                  }
67              }
68          }
69  
70          StringWriter output = new StringWriter();
71  
72          Velocity.evaluate(vc, output, VelocityUtil.class.getName(), input);
73  
74          return output.toString();
75      }
76  
77  }