FreeMarkerTemplateUtils


1   /*
2    * Copyright 2002-2005 the original author or authors.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.ui.freemarker;
18  
19  import java.io.IOException  ;
20  import java.io.StringWriter  ;
21  
22  import freemarker.template.Template;
23  import freemarker.template.TemplateException;
24  
25  /**
26   * Utility class for working with FreeMarker.
27   * Provides convenience methods to process a FreeMarker template with a model.
28   *
29   * @author Juergen Hoeller
30   * @since 14.03.2004
31   */
32  public abstract class FreeMarkerTemplateUtils {
33  
34      /**
35       * Process the specified FreeMarker template with the given model and write
36       * the result to the given Writer.
37       * <p>When using this method to prepare a text for a mail to be sent with Spring's
38       * mail support, consider wrapping IO/TemplateException in MailPreparationException.
39       * @param model the model object, typically a Map that contains model names
40       * as keys and model objects as values
41       * @return the result as String
42       * @throws IOException if the template wasn't found or couldn't be read
43       * @throws freemarker.template.TemplateException if rendering failed
44       * @see org.springframework.mail.MailPreparationException
45       */
46      public static String   processTemplateIntoString(Template template, Object   model)
47              throws IOException  , TemplateException {
48          StringWriter   result = new StringWriter  ();
49          template.process(model, result);
50          return result.toString();
51      }
52  
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags