/**
 * This file Copyright (c) 2011-2012 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.rendering.context;

import java.io.IOException;
import java.io.OutputStream;

import javax.jcr.Node;

import info.magnolia.rendering.engine.OutputProvider;
import info.magnolia.rendering.engine.RenderException;
import info.magnolia.rendering.template.RenderableDefinition;
import info.magnolia.rendering.util.AppendableWriter;


/**
 * Provides all information needed in the rendering process.
 */
public interface RenderingContext {

    Node getMainContent();

    Node getCurrentContent();

    RenderableDefinition getRenderableDefinition();

    OutputProvider getOutputProvider();

    /**
     * Pushes the content and renderableDefinition to be used for rendering. Output will be written using the
     * OutputProvider already set.
     */
    void push(Node content, RenderableDefinition renderableDefinition);

    /**
     * Pushes the content and renderableDefinition to be used for rendering.
     *
     * @param outputProvider the OutputProvider to be used for output or null to use the OutputProvider already set
     */
    void push(Node content, RenderableDefinition renderableDefinition, OutputProvider outputProvider);

    void pop();

    AppendableWriter getAppendable() throws IOException;

    OutputStream getOutputStream() throws IOException;

    void handleException(RenderException renderException);
}