src/main/java/net/pterodactylus/sone/text/TemplatePart.java

   1 /*
   2  * Sone - TemplatePart.java - Copyright © 2010 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.text;
  19
  20 import java.io.IOException;
  21 import java.io.Writer;
  22
  23 import net.pterodactylus.util.template.Template;
  24 import net.pterodactylus.util.template.TemplateContext;
  25 import net.pterodactylus.util.template.TemplateContextFactory;
  26 import net.pterodactylus.util.template.TemplateException;
  27
  28 /**
  29  * {@link Part} implementation that is rendered using a {@link Template}.
  30  *
  31  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  32  */
  33 public class TemplatePart implements Part, net.pterodactylus.util.template.Part {
  34
  35         /** The template context factory. */
  36         private final TemplateContextFactory templateContextFactory;
  37
  38         /** The template to render for this part. */
  39         private final Template template;
  40
  41         /**
  42          * Creates a new template part.
  43          *
  44          * @param templateContextFactory
  45          *            The template context factory
  46          * @param template
  47          *            The template to render
  48          */
  49         public TemplatePart(TemplateContextFactory templateContextFactory, Template template) {
  50                 this.templateContextFactory = templateContextFactory;
  51                 this.template = template;
  52         }
  53
  54         //
  55         // ACTIONS
  56         //
  57
  58         /**
  59          * Sets a variable in the template.
  60          *
  61          * @param key
  62          *            The key of the variable
  63          * @param value
  64          *            The value of the variable
  65          * @return This template part (for method chaining)
  66          */
  67         public TemplatePart set(String key, Object value) {
  68                 template.getInitialContext().set(key, value);
  69                 return this;
  70         }
  71
  72         //
  73         // PART METHODS
  74         //
  75
  76         /**
  77          * {@inheritDoc}
  78          */
  79         @Override
  80         public void render(Writer writer) throws IOException {
  81                 template.render(templateContextFactory.createTemplateContext().mergeContext(template.getInitialContext()), writer);
  82         }
  83
  84         /**
  85          * {@inheritDoc}
  86          */
  87         @Override
  88         public void render(TemplateContext templateContext, Writer writer) throws TemplateException {
  89                 template.render(templateContext.mergeContext(template.getInitialContext()), writer);
  90         }
  91
  92 }