/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2009 Jaspersoft Corporation. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.jasperreports.engine.component;
import java.io.IOException;
import net.sf.jasperreports.engine.xml.JRXmlWriter;
/**
* A component writer is responsible for producing a XML representation of
* component instances.
*
* <p>
* Its function is inverse to the one of {@link XmlDigesterConfigurer}, which
* transforms XML fragments into object instances.
*
* @author Lucian Chirita (lucianc@users.sourceforge.net)
* @version $Id: ComponentXmlWriter.java 3033 2009-08-27 11:46:22Z teodord $
*/
public interface ComponentXmlWriter
{
/**
* Outputs the XML representation of a component.
*
* @param componentKey the component type key
* @param component the component instance
* @param reportWriter the report writer to which output is to be written
* @throws IOException exceptions produced while writing to the
* output stream
* @see ComponentKey#getNamespacePrefix()
* @see JRXmlWriter#getXmlWriteHelper()
*/
void writeToXml(ComponentKey componentKey, Component component,
JRXmlWriter reportWriter) throws IOException;
}