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
  25 /**
  26  * {@link Part} implementation that is rendered using a {@link Template}.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public class TemplatePart implements Part {
  31
  32         /** The template to render for this part. */
  33         private final Template template;
  34
  35         /**
  36          * Creates a new template part.
  37          *
  38          * @param template
  39          *            The template to render
  40          */
  41         public TemplatePart(Template template) {
  42                 this.template = template;
  43         }
  44
  45         //
  46         // ACTIONS
  47         //
  48
  49         /**
  50          * Sets a variable in the template.
  51          *
  52          * @param key
  53          *            The key of the variable
  54          * @param value
  55          *            The value of the variable
  56          * @return This template part (for method chaining)
  57          */
  58         public TemplatePart set(String key, Object value) {
  59                 template.set(key, value);
  60                 return this;
  61         }
  62
  63         //
  64         // PART METHODS
  65         //
  66
  67         /**
  68          * {@inheritDoc}
  69          */
  70         @Override
  71         public void render(Writer writer) throws IOException {
  72                 template.render(writer);
  73         }
  74
  75 }