View Javadoc
1   /**
2    * This file Copyright (c) 2011-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.rendering.renderer;
35  
36  import info.magnolia.rendering.context.RenderingContext;
37  import info.magnolia.rendering.engine.RenderException;
38  
39  import java.util.Map;
40  
41  /**
42   * Responsible for rendering a renderable.
43   *
44   * @see info.magnolia.rendering.renderer.registry.RendererRegistry
45   * @see info.magnolia.rendering.engine.RenderingEngine
46   */
47  public interface Renderer {
48  
49      /**
50       * Called by {@link info.magnolia.rendering.engine.RenderingEngine} after it has setup the {@link RenderingContext}.
51       *
52       * @param ctx rendering context prepared by the caller
53       * @param contextObjects objects to expose to the template script
54       */
55      void render(RenderingContext ctx, Map<String, Object> contextObjects) throws RenderException;
56  
57  }